getContractBudget

Overview

This method returns a single contract budget record.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'ContractBudgets: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/budgets/[40-CHARACTER-HEX-ID] https://api.{{environment}}.catch-e.com/fm/contract/budgets/[40-CHARACTER-HEX-ID] https://api.test.catch-e.com/fm/contract/budgets/[40-CHARACTER-HEX-ID]

Path Parameters

Key	Format	Notes	Mandatory
contract_budget_id	string	The Contract Budget Id. A 40-character hexadecimal id (0–9, a–f).	Yes

Response Details

Success

200 - OK

Field	Format	Notes
id	string	The Contract Budget Id. A 40-character hexadecimal id.
contract_id	string	Contract Id.
posting_class_id	string	Posting Class Id.
billing_period	number	Billing period.
billing_period_item_no	number	Item number within the billing period.
billing_type_flag	string
billing_interval	string	Pay cycle code.
billing_date	string (date)	Billing date.
payment_method	string	Values: `direct-debit`, `cheque`, `cash`, `credit-card`, `eft`, `other`.
amount_net	number	Net amount.
amount_gst	number	GST amount.
status_flag	string
posting_class_code	string	Posting class code, e.g. FIN, MAINT, REG.

{ "id": "[40-CHARACTER-HEX-ID]", "contract_id": "5678", "posting_class_id": "3", "billing_period": 1, "billing_period_item_no": 1, "billing_type_flag": "string", "billing_interval": "fortnightly", "billing_date": "2026-02-12", "payment_method": "direct-debit", "amount_net": 250.0, "amount_gst": 25.0, "status_flag": "string", "posting_class_code": "FIN" }

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