Drivers / Assets and Liabilities

Get liability for a driver

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

GET

/fm/driver/liabilities/{driver_liability_id}

curl --request GET \
  --url https://api.catch-e.com/fm/driver/liabilities/{driver_liability_id} \
  --header 'Authorization: <api-key>'

{
  "_links": {
    "driver_asset": {
      "href": "https://api.catch-e.com/fm/driver/assets/3196434310060048408"
    },
    "self": {
      "href": "https://api.catch-e.com/fm/driver/liabilities/3196434310060048409"
    }
  },
  "amount": 500000,
  "driver_asset_id": "3196434310060048400",
  "driver_id": "101171",
  "driver_liability_id": "3196434310060048400",
  "finance_liability_financier_id": "3196195708503852500",
  "finance_liability_financier_name": "NAB",
  "finance_liability_type_id": "3196195708503852500",
  "finance_liability_type_name": "Mortgages",
  "liability_end_date": null,
  "liability_limit_amount": null,
  "liability_payout_flag": null,
  "monthly_payment_amount": 2500
}

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

driver_liability_idstringrequired

Driver Liability Id

Maximum string length: 20

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

Response

Success

amountnumber

driver_asset_idstring

driver_idstring

driver_liability_idstring

finance_liability_financier_idstring

finance_liability_financier_namestring

finance_liability_type_idstring

finance_liability_type_namestring

liability_end_datestring

liability_limit_amountnumber

liability_payout_flagstring

monthly_payment_amountnumber

Still need help? Ask the team