Contract / Payouts

Prepare a calculated value estimate for a given contract

Prepare a payout value estimate for a given contract. This method requires the ContractPayouts:Get permission to be associated with your role.

GET

/fm/contract/payouts/estimate

curl --request GET \
  --url 'https://api.catch-e.com/fm/contract/payouts/estimate?contract_id=%3Cstring%3E&payout_date=2023-12-25' \
  --header 'Authorization: <api-key>'

{
  "calculated_value_gst": 1234.5,
  "calculated_value_net": 12345,
  "remaining_billings": 24
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

contract_idstringqueryrequired

Contract id

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

payout_datestringqueryrequired

Payout date in YYYY-MM-DD format

Maximum string length: 10

Response

Success

calculated_value_gstnumber

Example: 1234.5

calculated_value_netnumber

Example: 12345

remaining_billingsinteger

Example: 24

Still need help? Ask the team