Contract / Payouts

Raise a new contract payout

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

POST

/fm/contract/payouts

curl --request POST \
  --url https://api.catch-e.com/fm/contract/payouts \
  --header 'Authorization: <api-key>' \
  --header 'Time-Zone: UTC' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contract_id": "100000",
  "contract_payout_status_id": "<string>",
  "early_termination_fee_flag": "no",
  "early_termination_fee_net": 12345,
  "financier_value": 123,
  "override_warnings_flag": "no",
  "payout_date": "YYYY-MM-DD",
  "price_to_purchase_flag": "no",
  "price_to_purchase_net": 12345,
  "total_loss_flag": "no",
  "total_loss_net": 12345,
  "valid_until": "YYYY-MM-DD"
}
'

{
  "attachment_id": "<string>",
  "calculated_value_gst": 123,
  "calculated_value_net": 123,
  "contract_id": "<string>",
  "contract_payout_id": "<string>",
  "contract_payout_status_id": "<string>",
  "created": "<string>",
  "early_termination_fee_flag": "<string>",
  "early_termination_fee_gst": 123,
  "early_termination_fee_net": 123,
  "financier_value": 123,
  "payout_date": "<string>",
  "price_to_purchase_flag": "<string>",
  "price_to_purchase_gst": 123,
  "price_to_purchase_net": 123,
  "remaining_billings": 123,
  "total_loss_flag": "<string>",
  "total_loss_gst": 123,
  "total_loss_net": 123,
  "user_id_create": "<string>",
  "valid_until": "<string>"
}

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

Headers

Time-Zonestringheaderdefault:UTC

Payouts will be processed in the specified timezone.

The timezone value can be given in several formats, none of which are case sensitive:

As a named time zone, such as 'Europe/Helsinki', 'US/Eastern', or 'MET'.
As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. A leading zero can optionally be used for hours values less than 10;

Maximum string length: 100

Pattern: ^[a-zA-Z0-9\/\:\+\-\_]+$

Body

JSON payload

contract_idstringrequired

Contract Id

Example: 100000

contract_payout_status_idstring

(Optional) Contract Payout status to transition to on create

early_termination_fee_flagenum<string>required

Early Termination Fee flag

Available options: yes, no

Example: no

early_termination_fee_netnumber

Example: 12345

financier_valuenumber

override_warnings_flagenum<string>

Override warning validation. If not specified, defaults to 'no'

Available options: yes, no

Example: no

payout_datestringrequired

Payout date in YYYY-MM-DD format

Example: YYYY-MM-DD

price_to_purchase_flagenum<string>required

Price to Purchase flag

Available options: yes, no

Example: no

price_to_purchase_netnumber

Example: 12345

total_loss_flagenum<string>required

Total Loss flag

Available options: yes, no

Example: no

total_loss_netnumber

Example: 12345

valid_untilstring

Valid Until date in YYYY-MM-DD format

Example: YYYY-MM-DD

Response

Success

attachment_idstring

calculated_value_gstnumber

calculated_value_netnumber

contract_idstring

contract_payout_idstring

contract_payout_status_idstring

createdstring

early_termination_fee_flagstring

early_termination_fee_gstnumber

early_termination_fee_netnumber

financier_valuenumber

payout_datestring

price_to_purchase_flagstring

price_to_purchase_gstnumber

price_to_purchase_netnumber

remaining_billingsinteger

total_loss_flagstring

total_loss_gstnumber

total_loss_netnumber

user_id_createstring

valid_untilstring

Still need help? Ask the team