Web Services

Returns quote template placeholders for a quick quote

Get a Quick Quote.

GET

/web-services/qq/lease/getQuote

curl --request GET \
  --url 'https://api.catch-e.com/web-services/qq/lease/getQuote?variant_id=%3Cstring%3E&variant_code=%3Cstring%3E&approximate_price=123&approximate_on_road_price=123&state_registered=VIC&annual_kilometres=123&lease_period=123&annual_salary=123&postcode=%3Cstring%3E&roadside_assistance_plan_code=%3Cstring%3E&monthly_finance_gross=123&client_code=%3Cstring%3E&pay_cycle_code=%3Cstring%3E&data_source=%3Cstring%3E&new_used=new&odometer=123&contract_type=%3Cstring%3E&fbt_benefit_type=%3Cstring%3E&fbt_business_use=123&maintenance_service_flag=yes&insurance_flag=yes&reg_ctp_flag=yes&tyres_flag=yes&fuel_flag=yes&optional_equipment_deselect_flag=yes&dealer_delivery_net=123&fields=%3Cstring%3E' \
  --header 'Authorization: <api-key>'

{
  "amount_financed": "12345.67",
  "annual_km": "100000",
  "area": null,
  "base_rate": "0.1",
  "body": "HATCHBACK",
  "broker_fee": "0",
  "ceo_monthly_gross": "12.34",
  "ceo_monthly_gst": "1.23",
  "ceo_monthly_net": "12.34",
  "ceo_notes": "Included",
  "ceo_yearly_gross": "123.45",
  "ceo_yearly_gst": "12.34",
  "ceo_yearly_net": "123.45",
  "client": "Test Client",
  "client_contact": null,
  "client_contact_name": "null,",
  "client_group": null,
  "client_id": "123456"
}

This method requires the WebServices permission to be associated with your role.

This API invokes the legacy qq::lease::getQuote web service. Note, this endpoint will be deprecated once a full service replacement has been developed.

This service returns quote template placeholders for a quick quote.

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

variant_idstringquery

Variant Id

variant_codestringquery

Variant Code

approximate_pricenumberquery

Approximate Price

approximate_on_road_pricenumberquery

Approximate On Road Price

state_registeredenum<string>queryrequired

State Registered

Available options: VIC, NSW, ACT, NT, TAS, WA, SA, QLD

annual_kilometresnumberqueryrequired

Annual Kilometres

lease_periodintegerqueryrequired

Lease Period

annual_salarynumberqueryrequired

Annual Salary

postcodestringquery

Postcode

roadside_assistance_plan_codestringquery

Roadside Assistance Plan Code

monthly_finance_grossnumberquery

Monthly Finance Gross

client_codestringquery

Client Code

pay_cycle_codestringquery

Pay Cycle Code

data_sourcestringquery

Data Source

new_usedenum<string>query

New / Used

Available options: new, used, demonstrator

odometernumberquery

Odometer

contract_typestringquery

Contract Type

fbt_benefit_typestringquery

FBT Benefit Type

fbt_business_usenumberquery

Bus Use% for the quote

maintenance_service_flagenum<string>query

Maintenance Service Flag