Get Quote Endpoints: GetQuickQuoteWebService

API endpoints for retrieving quotes, inclusions, and insurance

GetQuickQuoteWebService

This API allows you to run the legacy web service getQuickQuote) which has been deprecated and is no longer supported by Catch-e.

Supplementary SWAGGER documentation is available here: api.catch-e.com/docs/#/Web%20Services/getQuickQuoteWebService

Enable

Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapper_login" control.

Populate this control with a 'web_services' user login and password.
This user will be used to run the API from within code.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on WebServices.

Authentication

Authenticate with the API before running this API.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

https://api.test.catch-e.com/web-services/qq/lease/getQuote?

Input Fields (Params)

	Query string key	Format	Notes	Mandatory
1	variantcode / variantid	string / integer	Use a variantcode if you are storing the variant details in your system. Use a variantid if you are using the vehicle_lookup::getVariants web service. Only include one of these input fields.	yes
2	approximate_price	decimal	Gross List Price obtained from web service vehiclelookup::getVariantPrice OR input by user. Note, this cannot be set if approximateonroadprice is set.	no**
3	approximateonroad_price	decimal	Gross On Road Cost for the vehicle, including discounts, first year registration, luxury car tax (where applicable), purchase stamp duty and optional equipment. The component costs are deduced to an accuracy of +/- $0.10. Note, this cannot be set if approximate_price is set.	no**
4	state_registered	string	State codes, VIC, NSW, ACT, NT, TAS, WA, SA, QLD. This value is used to get the 'Insurance Location' via the gbcontrol postcodebystatedefault	yes
5	annual_kilometres	integer	Non zero number	yes
6	lease_period	integer	1 - 60	yes
7	annual_salary	decimal	Annual gross salary	yes
8	postcode	integer	Valid for given state_registered, if not provided a default value will be used	no
9	roadsideassistanceplan_code	string	A valid Roadside Assistance Plan Code to turn on the RSA profile and using the Code	no
10	monthlyfinancegross	decimal	Gross monthly finance payment	no
11	client_code	string	Client code to use for insurance and financier details	no
12	paycyclecode	string	Pay cycle code to use for the quote output e.g. weekly, fortnightly, monthly	no
13	data_source	string	Vehicle data source eg. redbook, glass, user-defined. If not set all data sources are used.	no
14	new_used	string	Purchase condition of vehicle. new, used or demonstrator	no
15	odometer	integer	Starting odometer reading. Required for used and demonstrator vehicles	no
16	contract_type	string	For selecting contract type for the quote. If not used then a quote is created using default contract type from gbcontrol) "defaultpostingmapid"	no
17	fbtbenefittype	string	For selecting 'Fbt Type' for the quote, one of statutory, operating or exempt. If not specified the default statutory is used	no
18	fbtbusinessuse	string	For entering 'Bus Use%' for the quote. If not specified the default 0% is used	no
19	maintenanceserviceflag	string	Maintenance/Service can be excluded from the quote by setting this flag to 'no'. Leaving this key out of the URL is the same as setting the value to 'yes'.	no
20	insurance_flag	string	Comprehensive Insurance can be excluded from the quote by setting this flag to 'no'. Leaving this key out of the URL is the same as setting the value to 'yes'.	no
21	regctpflag	string	Registration Renewal can be excluded from the quote by setting this flag to 'no'. Leaving this key out of the URL is the same as setting the value to 'yes'.	no
22	tyres_flag	string	Tyres can be excluded from the quote by setting this flag to 'no'. Leaving this key out of the URL is the same as setting the value to 'yes'.	no
23	fuel_flag	string	Fuel can be excluded from the quote by setting this flag to 'no'. Leaving this key out of the URL is the same as setting the value to 'yes'.	no
24	dealerdeliverynet	string	Dealer Delivery Fee amount can be passed in URL. Leaving this out of the URL will see the default Dealer Delivery Fee amount used (comes from qtvariantprofiles). 'Please note:' This input field can be used with either 'approximateonroadprice' or 'approximateprice' however it is really only effective for use in conjunction with the 'approximate_price' input field.	no
25	optionalequipmentdeselect_flag	string	Will remove all Options entries for the quote. Leaving this key out of the URL is the same as setting the value to 'no'. 'Please note:' This input field can be used with either 'approximateonroadprice' or 'approximateprice' however it is really only effective for use in conjunction with the 'approximate_price' input field.	no

| 26 | fields | string | To return a subset of fields, enter them here separated by a comma without spaces. e.g. fields=quoteid,fbttypetext,contracttype_name will return:

{ "fbt_type_text": "Employee Contribution Method", "quote_id": 131424, "contract_type_name": "Novated Fully Budgeted"}

| no |

See Field Names below

** ** approximateprice vs. approximateonroadprice**

Either approximateprice or approximateonroadprice is required

When using approximate_price you are effectively setting the 'List Price' (gross) and building the vehicles pricing from the 'ground up'.

When using approximateonroad_price you are effectively setting the 'Total On Road Price' (gross) aka Drive Away price. The 'List Price' is then calculated using all known price parameters such as discounts, first year registration, luxury car tax (where applicable), purchase stamp duty and optional equipment.

Input URL Example

https://api.test.catch-e.com/web-services/qq/lease/getQuote?variant_id=115637&approximate_price=36355&state_registered=VIC&annual_kilometres=20000&lease_period=36&annual_salary=70000&fields=quote_id,fbt_type_text,contract_type_name

Response Details

Validation Messages	Comments
200 OK

{ "quote_id": 100000, "driver_email": "", "quote_date": "10-Mar-2022", "client": "Test Client", "valid_until": "09-Apr-2022",(Note this is a subset of results)}

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized"}

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. | |
| 403 - Forbidden | | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. | |
| 418 - Invalid Credentials | | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Invalid Credentials", "status": 418, "detail": "Web services API wrapper credentials have not been configured"}

| You need to enable Web Services Go to Setup / Reference Data → gbcontrols) and find the "apiwebserviceswrapperlogin" control. Populate this control with a 'webservices' user login and password. This user will be used to run the API from within code. | |
| 422 - Unprocessable Entity | | | |

 "annual_kilometreS": { "isEmpty": "Value is required and can't be empty",

| Input field annual_kilometres is missing. | | |

 "variant_id": { "isEmpty": "Value is required and can't be empty", "noRecordFound": "No record matching the input was found"}}

| Variant ID is missing from request. | | |

 "web_service_error": { "CATCH_E_ERROR_QUOTE_VALIDATION_FAILED": "Validation failed due to the following error(s):1. Vehicle make is required.2. Vehicle model is required.3. Vehicle model year is required.4. Vehicle variant is required.

| The selected variant has a payload that is over the allowable limit. This is stored in Contract Types / Details "Quote Payload Maximum" Either remove the payload restriction or limit the variants that can be selected and used here. The APIs below show the payload of variants in their responses. Get a list of variants Get a variant by variant id
| CATCHEERRORMISSINGFIELDAPPROXIMATEPRICE | Input field missing, either approximateprice or approximateonroadprice needs to be provided | |
| CATCHEERRORAPPROXIMATEPRICEINVALID | Input field invalid evaluates to zero | || CATCHEERRORAPPROXIMATEONROADPRICEINVALID | Input field evaluates to zero | |
| CATCHEERRORONLYONEAPPROXIMATEPRICEALLOWED | You have provided values for both approximateprice, and approximateonroadprice, only one at a time is allowed | || CATCHEERRORMISSINGFIELDSTATEREGISTERED | Input field missing | || CATCHEERRORMISSINGFIELDANNUALKILOMETRES | Input field missing | || CATCHEERRORMISSINGFIELDLEASEPERIOD | Input field missing | || CATCHEERRORMISSINGFIELDANNUALGROSSSALARY | Input field missing | |
| CATCHEERRORVARIANTIDNOTFOUND | Input field invalid record not found | |
| CATCHEERRORVARIANTIDNOTACTIVE | The variant should be 'active' and a qtvariantprofiles record populated. | |
| CATCHEERRORSTATEREGISTEREDINVALID | Input field invalid not recognised | || CATCHEERRORANNUALKILOMETRESINVALID | Input field invalid evaluates to zero | |
| CATCHEERRORLEASEPERIODINVALID | Input field invalid evaluates to zero | || CATCHEERRORANNUALGROSSSALARYINVALID | Input field invalid evaluates to zero | || CATCHEERRORROADSIDEASSISTANCEPLANINVALID | Roadside Assistance Plan Code not found in qtroadsideassistanceplans | |
| CATCHEERRORBADCLIENTCODEDEFAULT | Data set up issue. (Check Global Controls 'clientcodedefault' & 'postcodebystatedefault'). | || CATCHEERRORBADQUOTETEMPLATE | Data set up issue | |
| CATCHEERRORBADCONTRACTTYPEDEFAULT | Data set up issue. (Check gbcontrols.defaultpostingmapid) | |
| CATCHEERRORVARIANTCODENOTFOUND | Input field invalid. Vehicle code not recognised | |
| CATCHEERRORMONTHLYFINANCEGROSSINVALID | Input field invalid unrecognised as a monetary value | |
| CATCHEERRORCLIENTCODEINVALID | Input field invalid unrecognised client | || CATCHEERRORVARIANTIDCODEMISMATCH | Input fields refer to different vehicles | || CATCHEERRORPAYCYCLECODEINVALID | Input field invalid. Pay cycle not recognised | || CATCHEERRORMULTIPLEPRICES | Input field invalid. Only one vehicle price should be provided | | | CATCHEERRORQUOTEVALIDATIONFAILED | There is a data set up issue. This error returns an additional details of the error (see example below).
| | | CATCHEERRORQUOTEVALIDATION_FAILED Validation failed due to the following error(s): 1. Contract Term(Months) must be between 1 and 60. 2. A valid Insurance Postcode is required!

Hint: If the error returned is 1. Insurance Location is required! - check that the qtinsurerlocationsbypostcode table has the required postcode or state based entries for the default insurer. | | |
| CATCHEERRORMISSINGFIELDPOSTCODE | Input field missing and gbcontrol postcodebystatedefault not setup | |
| CATCHEERRORNEWUSEDINVALID | Input field invalid. Must be one of new, used or demonstrator | |
| CATCHEERRORODOMETERINVALID | Input field invalid. Must be a numeric value | |
| CATCHEERRORCONTRACTTYPENOTFOUND | Input field invalid. Must be a valid contract type | |
| CATCHEERRORFBTBENEFITTYPEINVALID | Input field invalid. Must be one of statutory, operating or exempt | |
| CATCHEERRORFBTBUSINESSUSEINVALID | Input field invalid. Must be a decimal value | |
| CATCHEERRORFUELFLAGINVALID | Input field invalid. Expected input values are either 'yes' or 'no'. | || CATCHEERRORTYRESFLAGINVALID | Input field invalid. Expected input values are either 'yes' or 'no'. | |
| CATCHEERRORMAINTENANCESERVICEFLAGINVALID | Input field invalid. Expected input values are either 'yes' or 'no'. | |
| CATCHEERRORREGCTPFLAGINVALID | Input field invalid. Expected input values are either 'yes' or 'no'. | |
| CATCHEERRORINSURANCEFLAGINVALID | Input field invalid. Expected input values are either 'yes' or 'no'. | || CATCHEERRORTOOMANYREQUESTS | Rest call requests exceeded the limit set in ). | |
| BLANK SCREEN | A blank screen will be returned if included_flag='no' and = 0. | |
| 424 - Failed Dependency | | | |

 "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Failed Dependency", "status": 422, "detail": "Upstream service temporarily unavailable. Please retry."}

| The API cannot run at this time. This can happen for a various reasons, for example: service resource limits have been exceeded the system is in maintenance mode | |

GetQuoteEvent

This API returns details for a single Quote Event.

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on QuoteEvents:Get.

Authentication

Authenticate with the API before running this API.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

https://api.catch-e.com/qt/quote-events/{quote_event_id}

Path Variables

Key	Format	Notes	Mandatory
quoteeventid	string	Quote Event ID.	Required

Response Details

Validation Messages	Comments
200 OK

{ "quote_event_id": "100096", "quote_id": "132580", "quote_event_code_id": "100001", "event_date": "2022-11-09", "description": "Re-Test#2: Event Code: Notes (API)", "event_amount": 1.02, "quote_event_action_id": "100001", "due_date": "2022-11-11", "completed_flag": "yes", "attachment_id": null, "user_id_edit": "11212", "last_edit": "2022-11-13 23:28:59", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quote-events/100096" } }, "_embedded": { "quote_event_code": { "quote_event_code_id": "100001", "quote_event_code": "Notes", "name": "Notes", "description": "Quote Note", "template_id": "0", "status_flag": "active" }, "quote_event_action": { "quote_event_action_id": "100001", "name": "Request Docs" } }}

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized"}

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

{ "validation_messages": { "quote_event_id": { "noRecordFound": "No record matching the input was found" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation"}

| Quote Event ID not found. |