Approvals

Get an approval

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

GET

/fm/approvals/{approval_id}

Get an approval

curl --request GET \
  --url https://api.catch-e.com/fm/approvals/{approval_id} \
  --header 'Authorization: <api-key>' \
  --header 'Time-Zone: UTC'

{
  "approval_id": "<string>",
  "approval_limit": 0,
  "approval_sub_status_id": "<string>",
  "attachment_id": "<string>",
  "bank_details_correct_flag": "no",
  "billing_period": 0,
  "client_phone": "<string>",
  "contract_id": "<string>",
  "created": "2023-12-25",
  "credit_note_flag": "no",
  "driver_aware_flag": "no",
  "driver_bank_account_id": "<string>",
  "driver_name": "<string>",
  "driver_phone": "<string>",
  "external_order_number": "<string>",
  "franchise_notes": "<string>",
  "invoice_date": "2023-12-25",
  "invoice_no": "<string>",
  "last_edit": "2023-12-25",
  "maintenance_lines": [
    {
      "cause_code_id": "<string>",
      "cost_price": 123,
      "description": "<string>",
      "gst_cost": 123,
      "job_number": 123,
      "maintenance_id": "<string>",
      "posting_class_id": "<string>",
      "quantity": 123,
      "recharge_flag": "Y",
      "retail_price": 123,
      "type": "P",
      "vmrs_code_id": "<string>",
      "work_code_id": "<string>"
    }
  ],
  "misc_phone": "<string>",
  "notes": "<string>",
  "odometer": 123,
  "odometer_date": "2023-12-25",
  "odometer_valid_flag": "<string>",
  "payee_payment_method_id": "<string>",
  "posted_date": "2023-12-25",
  "reimbursement_flag": "no",
  "requested_audit_attempt_count": 123,
  "source": "internal",
  "status_flag": "<string>",
  "supplier_contact": "<string>",
  "supplier_franchise_vehicle_id": "<string>",
  "supplier_id": "<string>",
  "supplier_phone": "<string>",
  "user_id": "<string>",
  "user_id_edit": "<string>"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

approval_idstringrequired

Approval Id

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]{0,9}$

Headers

Time-Zonestringheaderdefault:UTC

Approvals 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;

Maximum string length: 100

Pattern: ^[a-zA-Z0-9\/\:\+\-\_]+$

Response

Success

approval_idstring

approval_limitnumberdefault:0

approval_sub_status_idstring

attachment_idstring

bank_details_correct_flagenum<string>default:no

Available options: yes, no

billing_periodintegerdefault:0

client_phonestring

contract_idstring

createdstring

credit_note_flagenum<string>default:no

Available options: yes, no

driver_aware_flagenum<string>default:no

Available options: yes, no

driver_bank_account_idstring

driver_namestring

driver_phonestring

external_order_numberstring

franchise_notesstring

invoice_datestring

invoice_nostring

last_editstring

maintenance_linesobject[]

Show child attributes

misc_phonestring

notesstring

odometerinteger

odometer_datestring

odometer_valid_flagstring

payee_payment_method_idstring

posted_datestring

reimbursement_flagenum<string>default:no

Available options: yes, no

requested_audit_attempt_countinteger

sourceenum<string>default:internal

Available options: internal, 1link

status_flagstring

supplier_contactstring

supplier_franchise_vehicle_idstring

supplier_idstring

supplier_phonestring

user_idstring

user_id_editstring

Still need help? Ask the team