Contract / Claims

Update a claim

This method is idempotent. This method is equivalent to a replace operation.

PUT

/fm/contract/claims/{approval_id}

Update a claim

curl --request PUT \
  --url https://api.catch-e.com/fm/contract/claims/{approval_id} \
  --header 'Authorization: <api-key>' \
  --header 'Delegated-Locking-Session-Id: <string>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Time-Zone: UTC' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attachment_id": "<string>",
  "bank_details_correct_flag": "no",
  "billing_period": 123,
  "contract_id": "<string>",
  "driver_bank_account_id": "<string>",
  "invoice_date": "2023-12-25",
  "invoice_no": "<string>",
  "maintenance_lines": [
    {
      "description": "<string>",
      "gst_cost": 15,
      "invoice_date": "2023-12-25",
      "odometer": 123,
      "odometer_date": "2023-12-25",
      "posting_class_id": "<string>",
      "quantity": 1,
      "retail_price": 150,
      "vmrs_code_id": "<string>"
    }
  ],
  "notes": "<string>"
}
'

{
  "approval_id": "<string>",
  "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",
  "driver_bank_account_id": "<string>",
  "driver_name": "<string>",
  "driver_phone": "<string>",
  "invoice_date": "2023-12-25",
  "invoice_no": "<string>",
  "last_edit": "2023-12-25",
  "maintenance_lines": [
    {
      "description": "<string>",
      "gst_cost": 15,
      "invoice_date": "2023-12-25",
      "maintenance_id": "<string>",
      "odometer": 123,
      "odometer_date": "2023-12-25",
      "posting_class_id": "<string>",
      "quantity": 1,
      "retail_price": 150,
      "vmrs_code_id": "<string>"
    }
  ],
  "misc_phone": "<string>",
  "notes": "<string>",
  "payee_payment_method_id": "<string>",
  "posted_date": "2023-12-25",
  "reimbursement_flag": "no",
  "status_flag": "<string>",
  "supplier_contact": "<string>",
  "supplier_id": "<string>",
  "supplier_phone": "<string>",
  "user_id": "<string>",
  "user_id_edit": "<string>"
}

An fm_approvals table lock is obtained during the execution of this API.

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

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: 20

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

Headers

Delegated-Locking-Session-Idstringheader

(Optional) Locking responsibility will be delegated to the specified Session Id.

This header enables the client to instruct the API to merely verify the presence of locks with the specified session id, but not attempt to obtain them itself. It requires the DelegatedLocking permission to be associated with your role.

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

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

Time-Zonestringheaderdefault:UTC

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

Maximum string length: 100

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

Body

JSON payload

attachment_idstring

bank_details_correct_flagenum<string>default:no

Available options: yes, no

billing_periodinteger

contract_idstringrequired

driver_bank_account_idstring

If omitted, defaults to the driver's claims-default bank account (fm_driver_bank_accounts.claims_default_flag = 'yes'), or the salary-packaged contract's linked bank account where applicable. Re-derived on every update when omitted, even if a different value was previously set explicitly.

invoice_datestring

invoice_nostring

maintenance_linesobject[]

Show child attributes

notesstring

Response

Claim updated successfully

approval_idstring

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

driver_bank_account_idstring

driver_namestring

driver_phonestring

invoice_datestring

invoice_nostring

last_editstring

maintenance_linesobject[]

Show child attributes

misc_phonestring

notesstring

payee_payment_method_idstring

posted_datestring

reimbursement_flagenum<string>default:no

Available options: yes, no

status_flagstring

supplier_contactstring

supplier_idstring

supplier_phonestring

user_idstring

user_id_editstring

Still need help? Ask the team