Quote / Inclusions

Get a list of inclusion plans

Get a list of inclusion plans.

GET

/qt/inclusion-plans

curl --request GET \
  --url 'https://api.catch-e.com/qt/inclusion-plans?inclusion_code=%3Cstring%3E&inclusion_plan_code=%3Cstring%3E&include_inactive_flag=no&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "qt_inclusion_plans": [
      {
        "cost_price_net": 123,
        "cost_price_rate": 123,
        "effective_date": "2023-12-25",
        "inclusion_code": "<string>",
        "inclusion_plan_code": "<string>",
        "inclusion_plan_code_qualified": "<string>",
        "inclusion_plan_id": "<string>",
        "margin_net": 123,
        "plan_name": "<string>",
        "retail_price_gross": 123,
        "retail_price_net": 123,
        "status_flag": "active",
        "term_lower": 123,
        "term_upper": 123,
        "vehicle_value_lower": 123,
        "vehicle_value_upper": 123
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/qt/inclusion-plans"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

This method requires the InclusionPlans: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

inclusion_codestringquery

Optional Inclusion Code

inclusion_plan_codestringquery

Optional Inclusion Plan Code

include_inactive_flagenum<string>querydefault:no

Set to yes if inactive items required in the list

Available options: yes, no

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