getContractPayoutEstimate

Overview

This method prepares a calculated payout value estimate for a contract, as at a given payout date. It does not raise a payout.

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

Permissions

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

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

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/fm/contract/payouts/estimate?contract_id=5678&payout_date=2026-04-30 
https://api.{{environment}}.catch-e.com/fm/contract/payouts/estimate?contract_id=5678&payout_date=2026-04-30 
https://api.test.catch-e.com/fm/contract/payouts/estimate?contract_id=5678&payout_date=2026-04-30

Query Parameters

Key	Format	Notes	Mandatory
contract_id	string	Contract Id. A positive whole number, up to 10 digits, with no leading zeros.	Yes
payout_date	string (date)	Payout date, in yyyy-MM-dd format.	Yes

Response Details

Success

200 - OK

Field	Format	Notes
calculated_value_net	number	Calculated payout value, net.
calculated_value_gst	number	Calculated payout value, GST.
remaining_billings	integer	Number of remaining billings.

{ "calculated_value_net": 18500.0, "calculated_value_gst": 1850.0, "remaining_billings": 22 }

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 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
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" }