getContractPaymentStructures

Overview

This method returns the payment structures for a contract, optionally filtered by payment type and status.

By default only active payment structures are returned.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ContractPaymentStructures: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/payment-structures?contract_id=5678 https://api.{{environment}}.catch-e.com/fm/contract/payment-structures?contract_id=5678 https://api.test.catch-e.com/fm/contract/payment-structures?contract_id=5678

Query Parameters

Key	Format	Notes	Mandatory
contract_id	string	Contract Id. A positive whole number, up to 10 digits, with no leading zeros.	Yes
payment_type	string	Filter by payment type. Omit to return all payment types. Allowed values: `finance`, `comprehensive-insurance`, `finance-principal-interest`, `management-fee`, `roadside-assistance`, `sundry-payment`.	No
status_flag	string	Filter by status. Allowed values: `active`, `inactive`. Default `active`.	No
page	integer	Page number. Default `1`.	No
page_size	integer	Number of records per page. Default `25`. Use `-1` to return all records.	No

Response Details

Success

200 - OK

Each record in _embedded.fm_contract_payment_structures contains:

Field	Fomat	Notes
contract_payment_structure_id	string	Contract Payment Structure Id.
contract_id	string	Contract Id.
supplier_id	string	The supplier (payee).
payee_payment_method_id	string	Payee Payment Method Id.
driver_bank_account_id	string	Driver Bank Account Id.
supplier_reference	string	The supplier's reference.
payment_type	string	Values: `finance`, `comprehensive-insurance`, `finance-principal-interest`, `management-fee`, `roadside-assistance`, `sundry-payment`.
payment_interval	string	Values: `daily`, `weekly`, `fortnightly`, `period`, `monthly`, `quarterly`, `bi-annual`, `annual`.
due_day	integer	Due day.
total_payments	integer	Total number of payments.
periods_deferred	integer	Number of deferred periods.
first_payment_due	string (date)	First payment due date.
final_payment_due	string (date)	Final payment due date.
payment_stop_date_flag	string	Values: `yes`, `no`.
payment_stop_date	string (date)	Payment stop date.
payment_on_hold_date_flag	string	Values: `yes`, `no`.
payment_on_hold_date	string (date)	Payment on hold date.
status_flag	string	Values: `active`, `inactive`.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/contract/payment-structures?contract_id=5678&page=1" } }, "_embedded": { "fm_contract_payment_structures": [ { "contract_payment_structure_id": "456", "contract_id": "5678", "supplier_id": "78", "payee_payment_method_id": "9", "driver_bank_account_id": "", "supplier_reference": "[SUPPLIER-REFERENCE]", "payment_type": "finance", "payment_interval": "monthly", "due_day": 15, "total_payments": 48, "periods_deferred": 0, "first_payment_due": "2026-03-15", "final_payment_due": "2030-02-15", "payment_stop_date_flag": "no", "payment_stop_date": "", "payment_on_hold_date_flag": "no", "payment_on_hold_date": "", "status_flag": "active" } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1 }

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	No payment structures were found for the contract.

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