getContractPayRunDates

Overview

Get contract pay run dates.

This method requires the Contract:PayRunDates permission to be associated with your role.

It performs the same function as the corresponding action in the Contracts screen.

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Contract:PayRunDates'.

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/contracts/{contract_id}/pay-run-dates

https://api.{{environment}}.catch-e.com/fm/contracts/{contract_id}/pay-run-dates

https://api.test.catch-e.com/fm/contracts/{contract_id}/pay-run-dates

Input Fields (Path)

Key	Format	Notes	Mandatory
contract_id	string	Contract Id	Yes

Response Details

Success

200 - Success

[  {  "pay_run_date": "2026-07-25",  "billing_period": 1,  "billing_period_item_no": 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

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

Validation Message	Comments
406 - Not Acceptable

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

Validation Message	Comments
422 - Unprocessible Entity	- Data being passed in the described field is invalid, the format is invalid or it is missing

{  "warning_messages": {  "fieldName": {  "warningExceptionCode": "A textual description of the warning exception"  }  },  "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

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

Validation Message	Comments
default - Unexpected Error

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