Skip to main content
Drivers Assets & Liabilities APIs

GetFinanceLiabilityTypes

GetFinanceLiabilityTypes

Overview

Allows you to retrieve a Financiers Liability Types for use in the createDriverLiabilities() and updateDriverLiabilities() APIs.
This API uses an alternative authentication protocol.

API Authentication Protocols

NOTE: This service is to be used by experienced developers ONLY. Please contact Catch-e Support if in any doubt.

Additional documentation can be found here for completed development,

or here for work in progress once deployed to Staging,

or here for work in progress once deployed to Test (Note: VPN Access required to access Test environments).

For accessing an API feature, a valid access_token must be passed in all the queries in the 'Authorization' header. A valid access_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

Security Scheme type: API Key
Header parameter name: Authorisation

Input Fields

JSON Field

Format

Notes

Mandatory

Client-Id

string

This is your client name as found in your Catch-e Login URL. For example: https://demo.catch-e.net.au

Yes

username

string

Catch-e username.

Yes

password

string

Catch-e password.

Yes

token_timeout

string

Timeout for token, if not set the authenticating users role session timeout will be used

No

2fa_code

string

Catch-e two-factor authentication code.

No

To access a specific API, your user Role must be found in gb_role_api_permissions for the respective gb_api_permissions (API function).

Successful Authentication Response

{ "access_token": "aaaaaa/bbbbbb.ccccccc.dddddd", "expires_in": 3600, "token_type": "bearer" }

HTTP Method

Use the HTTP Method 'GET' for consuming this API.

Input URL Examples

For a list of Liability Types:

https://api.test.catch-e.com/fm/finance/liability/types 

(Successful) Output Example (sample)

[ { "finance_liability_type_id": 3196195708503852464, "name": "Overdraft", "sequence_link_finance_asset_type_id": null, "financier_required_flag": "yes", "payout_required_flag": "no", "end_date_required_flag": "no", "limit_amount_required_flag": "yes" }, { "finance_liability_type_id": 3196195708503852465, "name": "Mortgages", "sequence_link_finance_asset_type_id": null, "financier_required_flag": "yes", "payout_required_flag": "no", "end_date_required_flag": "no", "limit_amount_required_flag": "no" } ] 

Error Codes

Example error output

{ "status": 404, "title": "Not Found", "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "detail": "API endpoint not found" }

Was this helpful?

Still need help? Ask the team