varyContractPaymentStructure

Overview

This method modifies an existing payment structure for a contract, for example the payment interval, due day, first payment due date, or on-hold and stop dates.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ContractPaymentStructures:Vary'.

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-structures/456/vary https://api.{{environment}}.catch-e.com/fm/contract/payment-structures/456/vary https://api.test.catch-e.com/fm/contract/payment-structures/456/vary

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

Path Parameters

Key	Format	Notes	Mandatory
contract_payment_structure_id	string	The Contract Payment Structure Id. A positive whole number, up to 10 digits, with no leading zeros.	Yes

Input Fields (JSON)

Key	Format	Notes	Mandatory
supplier_id	string	Supplier Id.	Yes
contract_id	string	Contract Id.	Yes
periods_deferred	integer	Number of deferred periods. Minimum 0.	No
first_payment_due	string (date)	First payment due date, in yyyy-MM-dd format.	No
payment_interval	string	Allowed values: `daily`, `weekly`, `fortnightly`, `period`, `monthly`, `quarterly`, `bi-annual`, `annual`.	No
due_day	integer	Due day.	No
payment_on_hold_date_flag	string	Allowed values: `yes`, `no`.	No
payment_on_hold_date	string (date)	Payment on hold date, in yyyy-MM-dd format. Required when payment_on_hold_date_flag is `yes`.	Conditional
payment_stop_date_flag	string	Allowed values: `yes`, `no`.	No
payment_stop_date	string (date)	Payment stop date, in yyyy-MM-dd format. Required when payment_stop_date_flag is `yes`.	Conditional

Example

{ "supplier_id": "78", "contract_id": "5678", "payment_on_hold_date_flag": "yes", "payment_on_hold_date": "2026-06-15" }

Response Details

Success

204 - No Content

The payment structure was varied 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	The payment structure does 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
423 - Locked	The contract is locked by another process or user.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Locked", "status": 423, "detail": "Locked" }

Validation Message	Comments
424 - Failed Dependency	Lock expected. A Delegated-Locking-Session-Id was supplied, but the expected lock for that session was not found.

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Failed Dependency", "status": 424, "detail": "Failed Dependency" }

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