Contract / Payouts

Get a list of contract payouts

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

GET

/fm/contract/payouts

curl --request GET \
  --url 'https://api.catch-e.com/fm/contract/payouts?contract_id=%3Cstring%3E&page=1&page_size=25' \
  --header 'Authorization: <api-key>' \
  --header 'Time-Zone: UTC'

{
  "_embedded": {
    "items": [
      {
        "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>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "<string>"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

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_idstringquery

Optional contract id - only show contract payouts for the specified contract

Maximum string length: 10

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

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Headers

Time-Zonestringheaderdefault:UTC

Payout timestamps will be presented 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\/\:\+\-\_]+$

Response

Success

_embeddedobject

Show child attributes

_linksobject

Show child attributes

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team