Skip to main content
Quote / Inclusions

Get an inclusion by inclusion id

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

GET
/qt/inclusions/{inclusion_id}
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
inclusion_idstringrequired

Inclusion Id

Maximum string length: 10
Pattern: ^[0-9]+$

Response

application/vnd.catch-e-api.v1+json

Success

calculate_fsl_flagenum<string>
Available options: yes, no
calculate_gst_flagenum<string>
Available options: yes, no
calculate_stamp_duty_flagenum<string>
Available options: yes, no
edit_flagenum<string>
Available options: yes, no
financed_flagenum<string>
Available options: yes, no
inclusion_codestring
inclusion_idstring
namestring
posting_class_idstring
providerenum<string>
Available options: internal, bespoke, eric
status_flagenum<string>
Available options: active, inactive, suspended
supplier_idstring
vehicle_value_basisenum<string>
Available options: amount-financed, depreciable_amount, on-road-price