getContractPaymentSchedules

Overview

This method returns the payment schedule for a contract payment structure, optionally filtered to a single payment period.

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

Permissions

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

Query Parameters

Key	Format	Notes	Mandatory
contract_payment_structure_id	string	Contract Payment Structure Id. A positive whole number, up to 10 digits, with no leading zeros.	Yes
payment_period_no	string	Filter to a payment period number. Up to 10 characters.	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_schedules contains:

Field	Format	Notes
contract_payment_structure_id	string	Contract Payment Structure Id.
posting_class_id	string	Posting Class Id.
payment_period_no	integer	Payment period number.
payment_period_item_no	integer	Payment period item number.
payable_id	string	Payable Id.
payment_date	string	Payment date.
amount_net	number	Net amount.
amount_gst	number	GST amount.
status_flag	string	Values: `pending`, `pre-post`, `posted`, `stopped`, `history-only`, `deleted`, `on-hold`.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/contract/payment-schedules?contract_payment_structure_id=456&page=1" } }, "_embedded": { "fm_contract_payment_schedules": [ { "contract_payment_structure_id": "456", "posting_class_id": "3", "payment_period_no": 1, "payment_period_item_no": 1, "payable_id": "", "payment_date": "2026-03-15", "amount_net": 850.0, "amount_gst": 85.0, "status_flag": "pending" } ] }, "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 schedules were found for the payment structure.

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