getClaim

Overview

Get a claim.

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

It performs the same function as the corresponding action in the Contract / Claims screen.

Permissions

The permission for this API is stored in [gb_api_permissions]permission as 'Contract:GetClaim'.

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/claims/{approval_id}

https://api.{{environment}}.catch-e.com/fm/contract/claims/{approval_id}

https://api.test.catch-e.com/fm/contract/claims/{approval_id}

Input Fields (Path)

Key	Format	Notes	Mandatory
approval_id	string	Approval Id	Yes

Input Fields (Header)

Key	Format	Notes	Mandatory
Time-Zone	string	Claims will be shown in the specified timezone. The timezone value can be given in several formats, none of which are case sensitive: - As a named time zone, such as 'Europe/Helsinki', 'US/Eastern', or 'MET'. - As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. A leading zero can optionally be used for hours values less than 10;	No

Response Details

Success

200 - Success

{  "approval_id": "string",  "contract_id": "string",  "user_id": "string",  "supplier_id": "string",  "supplier_contact": "string",  "supplier_phone": "string",  "payee_payment_method_id": "string",  "driver_bank_account_id": "string",  "driver_name": "string",  "driver_phone": "string",  "client_phone": "string",  "misc_phone": "string",  "notes": "string",  "invoice_no": "string",  "invoice_date": "2026-07-25",  "billing_period": 0,  "reimbursement_flag": "no",  "bank_details_correct_flag": "no",  "attachment_id": "string",  "created": "2026-07-25",  "last_edit": "2026-07-25",  "user_id_edit": "string",  "posted_date": "2026-07-25",  "approval_sub_status_id": "string",  "status_flag": "string",  "maintenance_lines": [  {  "maintenance_id": "string",  "invoice_date": "2026-07-25",  "odometer": 0,  "posting_class_id": "string",  "vmrs_code_id": "string",  "description": "string",  "quantity": 0,  "retail_price": 0,  "gst_cost": 0  }  ] }

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