UpdateDriverLiabilities

Allows you to update Drivers' Liabilities.

HTTP Method

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

Input Fields (Header)

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

Input Fields (Body)

 Single Liability update: https://api.test.catch-e.com/fm/driver/liabilities/{{driverLiabilityId}}

JSON Field	Format	Notes	Mandatory
finance_liability_type_id	string	Enter the finance_liability_type_id for the respective Liability Type. See getFinanceLiabilityTypes()	No
finance_liability_financier_id	string	Enter the finance_liability_financier_id for the respective Liability Financier. See getFinanceLiabilityFinanciers()	No
amount	number	Enter the Liability Value.	Yes
description	string	Enter the Liability Description.	No

JSON Example

 Multiple Liabilities update: https://api.test.catch-e.com/fm/driver/liabilities/ [ { "driver_liability_id": 3196579721328459823, "finance_liability_type_id": "16238640163402548265", "finance_liability_financier_id": "16238640163402548279", "amount": 99999.99, "monthly_payment_amount": 1234.56, "liability_limit_amount": 200099 }, { "driver_liability_id": 3196579721328459824, "finance_liability_type_id": "16238640163402548266", "finance_liability_financier_id": "16238640163402548279", "amount": 999.99, "monthly_payment_amount": 12.99 } ]

(Successful) Output Example (sample)

{ "driver_liability_id": 3196434310060049470, "driver_id": 101211, "finance_liability_type_id": 3196195708503852473, "finance_liability_financier_id": 3196195708503852519, "driver_asset_id": null, "amount": 1234.56, "monthly_payment_amount": 34.56, "liability_payout_flag": null, "liability_end_date": null, "liability_limit_amount": 2222.22, "finance_liability_type_name": "Credit Card Limit", "finance_liability_financier_name": "NAB", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver/liabilities/3196434310060049470" } } }

Error Codes

Example error output

{ "validation_messages": { "liability_limit_amount": { "notFloat": "The input does not appear to be a float", "notGreaterThan": "The input is not greater than '0'" } }, "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