Contract / Payments

Has contract posted payments

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

GET

/fm/contract/payment-structures/posted

curl --request GET \
  --url 'https://api.catch-e.com/fm/contract/payment-structures/posted?contract_id=%3Cstring%3E&supplier_id=%3Cstring%3E&payment_type=finance' \
  --header 'Authorization: <api-key>'

{
  "posted_payments": "yes"
}

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]*$

supplier_idstringqueryrequired

Supplier Id

Maximum string length: 10

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

payment_typeenum<string>query

Payment Type

Available options: finance, comprehensive-insurance, finance-principal-interest, management-fee, roadside-assistance, sundry-payment

Response

Success

posted_paymentsenum<string>

Available options: yes, no

Still need help? Ask the team