Quote / Inclusions

Get an inclusion plan by inclusion plan id

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

GET

/qt/inclusion-plans/{inclusion_plan_id}

curl --request GET \
  --url https://api.catch-e.com/qt/inclusion-plans/{inclusion_plan_id} \
  --header 'Authorization: <api-key>'

{
  "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
}

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

inclusion_plan_idstringrequired

Inclusion Plan Id

Maximum string length: 10

Pattern: ^[0-9]+$

Response

Success

cost_price_netnumber

cost_price_ratenumber

effective_datestring

inclusion_codestring

inclusion_plan_codestring

inclusion_plan_code_qualifiedstring

inclusion_plan_idstring

margin_netnumber

plan_namestring

retail_price_grossnumber

retail_price_netnumber

status_flagenum<string>

Available options: active, inactive

term_lowerinteger

term_upperinteger

vehicle_value_lowernumber

vehicle_value_uppernumber

Still need help? Ask the team