updateContractPayout

Overview

This method updates an existing contract payout.

It can only be called for contract payouts in pending state.

This method requires the ContractPayouts:Update permission to be associated with your role.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ContractPayouts:Update'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'PUT' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/fm/contract/payouts/889 
https://api.{{environment}}.catch-e.com/fm/contract/payouts/889 https://api.test.catch-e.com/fm/contract/payouts/889

Input Fields (Header)

Key	Format	Notes	Mandatory
Time-Zone	string	(Optional) Payouts will be processed in the specified timezone. Default `UTC`. Accepts a named time zone (e.g. 'Australia/Sydney') or an offset from UTC (e.g. '+10:00').	No

Path Parameters

Key	Format	Notes	Mandatory
contract_payout_id	string	The Contract Payout Id. A positive whole number, up to 20 digits, with no leading zeros.	Yes

Input Fields (JSON)

Key	Format	Notes	Mandatory
financier_value	number	Financier value.	No
valid_until	string	Valid until date, in yyyy-MM-dd format.	No
price_to_purchase_flag	string	Price to Purchase flag. Allowed values: `yes`, `no`.	No
early_termination_fee_flag	string	Early Termination Fee flag. Allowed values: `yes`, `no`.	No
total_loss_flag	string	Total Loss flag. Allowed values: `yes`, `no`.	No
price_to_purchase_net	number	Price to purchase, net.	No
early_termination_fee_net	number	Early termination fee, net.	No
total_loss_net	number	Total loss, net.	No
contract_payout_status_id	string	The status to transition the payout to on update.	No
override_warnings_flag	string	Override warning validation. Allowed values: `yes`, `no`. Default `no`.	No

Example

{ "financier_value": 18100.0, "valid_until": "2026-05-07" }

Response Details

Success

200 - OK

Returns the updated contract payout.

Field	Format	Notes
contract_payout_id	string	Contract Payout Id.
contract_id	string	Contract Id.
contract_payout_status_id	string	The payout's current status. See getContractPayoutStatuses.
created	string	When the payout was created.
payout_date	string	Payout date.
price_to_purchase_flag	string	Values: `yes`, `no`.
early_termination_fee_flag	string	Values: `yes`, `no`.
total_loss_flag	string	Values: `yes`, `no`.
remaining_billings	integer	Number of remaining billings.
calculated_value_net	number	Calculated payout value, net.
calculated_value_gst	number	Calculated payout value, GST.
financier_value	number	Financier value.
valid_until	string	Date the payout is valid until.
price_to_purchase_net	number	Price to purchase, net.
price_to_purchase_gst	number	Price to purchase, GST.
early_termination_fee_net	number	Early termination fee, net.
early_termination_fee_gst	number	Early termination fee, GST.
total_loss_net	number	Total loss, net.
total_loss_gst	number	Total loss, GST.
attachment_id	string	Attachment Id.
user_id_create	string	The user who created the payout.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/contract/payouts/889" } }, "contract_payout_id": "889", "contract_id": "5678", "contract_payout_status_id": "1", "created": "2026-04-01T10:15:00+10:00", "payout_date": "2026-04-30", "price_to_purchase_flag": "yes", "early_termination_fee_flag": "no", "total_loss_flag": "no", "remaining_billings": 22, "calculated_value_net": 18500.0, "calculated_value_gst": 1850.0, "financier_value": 17900.0, "valid_until": "2026-04-30", "price_to_purchase_net": 500.0, "price_to_purchase_gst": 50.0, "early_termination_fee_net": 0, "early_termination_fee_gst": 0, "total_loss_net": 0, "total_loss_gst": 0, "attachment_id": "", "user_id_create": "67" }

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

Validation Message	Comments
404 - Not Found	The contract payout does not exist.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Not Found" }

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

Validation Message	Comments
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "detail": "Not Acceptable" }

Validation Message	Comments
422 - Unprocessable Entity	One or more input fields failed validation. The field name and message are returned in `validation_messages`.

{ "warning_messages": {}, "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

Was this helpful?

Still need help? Ask the team