Quote / Financiers

Get a list of financier margin rates

Get a list of financier margin rates.

GET

/qt/financier-margin-rates

curl --request GET \
  --url 'https://api.catch-e.com/qt/financier-margin-rates?supplier_id=%3Cstring%3E&make_id=%3Cstring%3E&model_id=%3Cstring%3E&variant_id=%3Cstring%3E&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "qt_financier_margin_rates": [
      {
        "effective_from": "0000-00-00",
        "financier_margin_rate_id": "<string>",
        "interest_margin_rate": 0,
        "make_id": "<string>",
        "model_id": "<string>",
        "status_flag": "active",
        "supplier_id": "<string>",
        "variant_id": "<string>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/qt/financier-margin-rates"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

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

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

Query Parameters

supplier_idstringquery

Optional Supplier Id

Maximum string length: 10

make_idstringquery

Optional Make Id

Maximum string length: 10

model_idstringquery

Optional Model Id

Maximum string length: 10

variant_idstringquery

Optional Variant Id

Maximum string length: 10

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team