getFinancierMarginRates

Due for Release 21/09/2026

getFinancierMarginRates

Overview

Get a list of configured financier margin rates. Each rate represents a configurable interest rate margin — an increase or a discount — that Catch-e can apply on top of a financier's base rate, optionally narrowed to a specific make, model or variant.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'FinancierMarginRates:Get'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/qt/financier-margin-rates https://api.{environment}.catch-e.com/qt/financier-margin-rates https://api.test.catch-e.com/qt/financier-margin-rates

Query Parameters

			KeyFormatNotesMandatory
`supplier_id`	string	Optional Supplier Id. Filters to margin rates configured for the specified financier (financiers are stored as suppliers in Catch-e).	No
`make_id`	string	Optional Make Id. Filters to margin rates scoped to the specified vehicle make.	No
`model_id`	string	Optional Model Id. Filters to margin rates scoped to the specified vehicle model.	No
`variant_id`	string	Optional Variant Id. Filters to margin rates scoped to the specified vehicle variant.	No
`page`	integer	Optional page number. Default value: 1.	No
`page_size`	integer	Optional page size. Default value: 25.	No

Response Details

Success

200 - OK

json

{  "_links": {  "self": {  "href": "https://api.catch-e.loc/qt/financier-margin-rates"  }  },  "_embedded": {  "qt_financier_margin_rates": [  {  "financier_margin_rate_id": "1",  "supplier_id": "100454",  "make_id": "12",  "model_id": "145",  "variant_id": "2201",  "interest_margin_rate": 0.0025,  "effective_from": "2026-09-01",  "status_flag": "active"  }  ]  },  "page_count": 1,  "page_size": 25,  "total_items": 1,  "page": 1 }

(Illustrative values only — not real data.)

		Response FieldFormatNotes
`financier_margin_rate_id`	string	Unique identifier of the configured margin rate row.
`supplier_id`	string	The financier (supplier) this rate applies to.
`make_id`	string	The vehicle make this rate is scoped to, where the rate is make-specific.
`model_id`	string	The vehicle model this rate is scoped to, where the rate is model-specific.
`variant_id`	string	The vehicle variant this rate is scoped to, where the rate is variant-specific.
`interest_margin_rate`	number	The configured margin — an increase or a discount on the financier's base rate.
`effective_from`	string (date)	The date from which this margin rate applies.
`status_flag`	string	Whether the margin rate is currently active.

Error Response Details

401 Unauthorized

Validation Message	Comments
401 Unauthorized	You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

json

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

403 Forbidden

Validation Message

Comments

403 Forbidden

You do not have permissions for this request.

Go to System Roles and enter 'web_services'.

Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

json

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden" }

406 Not Acceptable

json

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Acceptable", "status": 406, "detail": "Not Acceptable" }

422 Unprocessable Entity

json

{  "warning_messages": { "fieldName": { "warningExceptionCode": "A textual description of the warning exception" } },  "validation_messages": { "fieldName": { "validationExceptionCode": "A textual description of the validation exception" } },  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",  "title": "Unprocessable Entity",  "status": 422,  "detail": "Failed Validation" }

500 Internal Error

json

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

default Unexpected Error

json

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }