editContractPaymentSchedules

Overview

This method edits payment schedule items for one or more payment structures in a single request. Each item is identified by its payment structure, posting class, payment period number and payment period item number.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ContractPaymentSchedules:Edit'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

Use the HTTP Method 'PATCH' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/fm/contract/payment-schedules https://api.{{environment}}.catch-e.com/fm/contract/payment-schedules https://api.test.catch-e.com/fm/contract/payment-schedules

Input Fields (Header)

Key	Format	Notes	Mandatory
Audit-User-Id	string	(Optional) User Id to use for audit purposes. Up to 5 digits. Requires the Audit:UserIdOverride permission.	No

Input Fields (JSON)

Send an array of payment schedule items to update.

Key	Format	Notes	Mandatory
contract_payment_structure_id	string	Contract Payment Structure Id.	Yes
posting_class_id	string	Posting Class Id.	Yes
payment_period_no	integer	Payment period number.	Yes
payment_period_item_no	integer	Payment period item number.	Yes
payment_date	string (date)	Payment date, in yyyy-MM-dd format.	No
amount_net	number	Net amount.	No
amount_gst	number	GST amount.	No

Example

[ { "contract_payment_structure_id": "456", "posting_class_id": "3", "payment_period_no": 4, "payment_period_item_no": 1, "payment_date": "2026-06-16", "amount_net": 900.0, "amount_gst": 90.0 } ]

Response Details

Success

204 - No Content

The payment schedule items were updated successfully. No response body is returned.

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	One or more of the payment schedule items do not exist.

{ "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
415 - Unsupported Media Type	The Content-Type of the request is not supported by this API.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unsupported Media Type", "status": 415, "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" }