getApprovals

Overview

Get a list of approvals.

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

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

Permissions

The permission for this API is stored in [gb_api_permissions]permission as 'Approvals: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/approvals

https://api.{{environment}}.catch-e.com/fm/approvals

https://api.test.catch-e.com/fm/approvals

Input Fields (Query)

Key	Format	Notes	Mandatory	Default
contract_id	string	Optional Contract Id	No
client_id	string	Optional Client Id	No
driver_id	string	Optional Driver Id	No
creator_user_id	string	Optional Creator User Id	No
supplier_id	string	Optional Supplier Id	No
supplier_franchise_vehicle_id	string	Optional Supplier Franchise Vehicle Id	No
client_group_id	string	Optional Client Group Id	No
supplier_group_id	string	Optional Supplier Group Id	No
reg_no	string	Optional Reg No	No
card_number	string	Optional Card Number This field supports the wildcard % operator.	No
from_date	string	Optional From Date	No
to_date	string	Optional From Date	No
status_flag	string	Optional Status Flag Allowed: active, batch, cancelled, deleted, history-only, posted, rejected, requested	No
approval_sub_status_id	string	Optional Approval Sub Status Id	No
page	integer	Optional page number	No	1
page_size	integer	Optional page size	No	25

Input Fields (Header)

Key	Format	Notes	Mandatory
Time-Zone	string	Approvals will be processed 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

{  "_links": {  "self": {  "href": "https://api.catch-e.loc/fm/approvals"  }  },  "_embedded": {  "fm_approvals": [  {  "approval_id": "string",  "contract_id": "string",  "user_id": "string",  "supplier_id": "string",  "supplier_franchise_vehicle_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",  "franchise_notes": "string",  "invoice_no": "string",  "invoice_date": "2026-07-25",  "billing_period": 0,  "reimbursement_flag": "no",  "driver_aware_flag": "no",  "odometer": 0,  "odometer_date": "2026-07-25",  "odometer_valid_flag": "string",  "bank_details_correct_flag": "no",  "attachment_id": "string",  "source": "internal",  "external_order_number": "string",  "approval_limit": 0,  "created": "2026-07-25",  "last_edit": "2026-07-25",  "user_id_edit": "string",  "posted_date": "2026-07-25",  "credit_note_flag": "no",  "approval_sub_status_id": "string",  "requested_audit_attempt_count": 0,  "status_flag": "string",  "maintenance_lines": [  {  "maintenance_id": "string",  "job_number": 0,  "posting_class_id": "string",  "vmrs_code_id": "string",  "work_code_id": "string",  "cause_code_id": "string",  "type": "P",  "recharge_flag": "Y",  "description": "string",  "quantity": 0,  "retail_price": 0,  "cost_price": 0,  "gst_cost": 0  }  ]  }  ]  },  "page_count": 1,  "page_size": 25,  "total_items": 1,  "page": 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
409 - Conflict

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

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