Skip to main content
Drivers Assets & Liabilities APIs

CreateDriverLiabilities

CreateDriverLiabilities

Overview

Allows you to add new Drivers' Liabilities.

HTTP Method

Use the HTTP Method 'POST' for consuming this web service.

Input Fields (Header)

  • Header should contain the 'Content-Type' Key with the Value = 'application/json' or 'application/hjson'.

  • Header should contain the 'Accept' Key with the Value = 'application/vnd.catch-e-api.v1+json, application/problem+json'

Input Fields (Body)

JSON Field

Format

Notes

Mandatory

driver_id

Int

Driver ID

Yes

finance_liability_type_id

string

Enter the finance_liability_type_idfor the respective Liability Type. See GetFinanceLiabilityTypes()

Yes

finance_liability_financier_id

string

Enter the finance_liability_financier_id for the respective Liability Financier. See getFinanceLiabilityFinanciers()

Yes

amount

number

Enter the Liability Value.

Yes

description

string

Enter the Liability Description.

No

JSON Example

[ { "driver_id": "100000", "finance_liability_type_id": "2196195708503852111", "finance_liability_financier_id": "4196195708503852222", "driver_asset_id": "4196296702502852222", "amount": 123456.78, "monthly_payment_amount": 1234.56, "liability_payout_flag": "no", "liability_end_date": "2022-05-01", "liability_limit_amount": 0 }, { "driver_id": "100000", "finance_liability_type_id": "2196195708503852111", "finance_liability_financier_id": "4196195708503852222", "driver_asset_id": "4196296702502852223", "amount": 456.78, "monthly_payment_amount": 34.56, "liability_payout_flag": "no", "liability_end_date": "2022-05-01", "liability_limit_amount": 0 } ] 

(Successful) Output Example (sample)

{ "driver_liability_id": 3196434310060049502, "driver_id": 101211, "finance_liability_type_id": 3196195708503852473, "finance_liability_financier_id": 3196195708503852478, "driver_asset_id": null, "amount": 1000.77, "monthly_payment_amount": 12.34, "liability_payout_flag": "no", "liability_end_date": "2025-01-01", "liability_limit_amount": 1111.11, "finance_liability_type_name": "Credit Card Limit", "finance_liability_financier_name": "ANZ Banking", "_links": { "self": { "href": "https://api.catch-e.com/fm/driver/liabilities/3196434310060049502" } } } 

Error Codes

Example error output

{ "validation_messages": { "liability_end_date": { "dateInvalidDate": "The input does not appear to be a valid date" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Was this helpful?

Still need help? Ask the team