Quote & Lease Operations API: Qt Salesforce createQuote — Audit History

API endpoints for quote (Qt_*) and lease (Qq_*) operations and fleet reports

Audit History

Audit history is created when using this web service. The history is attributed to the userid passed in the parameter 'useridclientmanager'.

Input Fields

Sort	Query string key	Format	Notes	Mandatory
1	annual_kilometres	integer	Non-zero positive number	yes
2	client_code	string	Catch-e client_code, a short text string identifying the client	yes
3	driverannualsalary	decimal	Annual gross salary	yes
4	driver_surname	string	Surname of the driver	yes
5	state_registered	string	State codes, VIC, NSW, ACT, NT, TAS, WA, SA, QLD, NZ. When is 'AUS' then it must be either 'NSW', 'VIC', 'QLD', 'ACT', 'TAS', 'SA', 'WA', or 'NT'. When is 'NZ' then it must be 'NZ'.	yes
6	term	integer	1 - 60	yes
7	useridclient_manager	int	Active Catch-e user_id i.e. not at 'deleted' status	yes
8	variant_id	int	Catch-e variant identifier	yes
9	aftermarketrequestedflag	string	Override the default Aftermarket inclusion flag, 'yes' or 'no'	no
10	colour_preference	string	Set the colour preference	no
11	createnewdriver_flag	string	Set this to 'yes' to create a new Driver. Requires driverexternalcode if set to 'yes'.	no
12	deal_type	string	Deal Type field in Salesforce	no
13	driveraddress1	string	Postal / Home address line 1 e.g. Level 1, 30 Coora Road'	no
14	driveraddress2	string	Postal / Home address line 2	no
15	driver_area	string	Postal / Home area e.g. 'Oakleigh South'	no
16	driverexternalcode	string	Pacman Unique reference used to identify this driver	no
17	drivergivenname	string	Given name	no
18	driverhomeemail	string	Home email	no
19	driver_id	string	An alternative to passing the driverexternalcode. The driverid passed in here will be updated with data submitted in this call. If URL contains: ‘driverid=100000’ then, If driverid match is found, update Driver record (if any changes required). If URL contains: ‘driverid=0’ or not passed then, Do not create a new Driver Record. Simply add the driversurname to driversurname and driverannualsalary to annualsalary. If URL contains: ‘createnewdriverflag=yes’ then, Create a new Driver.	no
20	driver_phone	string	Home phone number for Driver	no
21	driver_postcode	string	Postal / Home postcode	no
22	driver_state	string	Postal / Home state	no
23	driverworkphone	string	Work phone number	no
24	fbt_value	decimal	Sets the FBT Value in the quote and turn on the lockfbtvalue_flag	no
25	inclusion{inclusioncode}_flag	string	Setting this to ‘yes’ will select and apply the defined inclusion to the quote. ‘no’ or omitting this key will set the plan as unchecked in the quote. If there is only one available plan, the second key is not required as the default plan will be used. eg: inclusionINC1flag = ‘yes’ would populate this inclusion into the quote.	no
26	inclusion{inclusionplancode}plan	string	If there are multiple plans available for an inclusion, the plan to use must also be defined. eg:inclusionINC1plan = ‘LIPLAN2’ would populate this plan into the quote.	no
27	insuranceloadingtypedriverrestriction	string	One of nodriverslessthan26yo, alldrivers, nodriverslessthan22yo. Insert one of the 'loadingcode' values stored in	no
28	insuranceloadingtype_licence	string	One of noloss, lossin2to5years, lossin0to2years. Insert one of the 'loadingcode' values stored in	no
29	insuranceloadingtypepastclaims	string	One of noclaims0to5years, 1claimin12months, 1claimin1to3years, 2+claims0to3years, 3+claimsin0to5years. Insert one of the 'loading_code' values stored in	no
30	insurerlocationpostcode	integer	Use this if your insurance set-up is configured by postcode, otherwise locationname should be used. The postcode must be valid for the supplied stateregistered. If not passed in the respective postcode from Global Controls 'postcodebystate_default' will be used to determine the Insurance price.	no
31	listpricegross	decimal	Numeric dollar value, takes precedent over listpricenet i.e. if this is set then listpricenet is ignored	no
32	listpricegst	decimal	Numeric dollar value	no
33	listpricenet	decimal	Numeric dollar value	no
34	location_name	string	Set the Insurance location you want applied. This will display on the Quotes → Contract tab.	no
35	new_used	string	Indicates whether the vehicle is new or used, defaults to 'new'	no
36	odometer	string	If 'new_used' is set to 'used' or 'demonstrator' this value must bet set to a non-zero integer	no
37	opportunity_id	string	Salesforce opportunity id	no
38	opportunity_number	string	Salesforce opportunity #	no
39	parentquoteid	int	Quote ID to use as the parent of the new quote	no
40	paycyclecode	string	Allows you to set the Pay Cycle for this quote. The list of available codes is stored in If not passed the Client Pay Cycle will be used.	no
41	postingmapcode	string	Contract type code	no
42	procurement_flag	string	Sets the quote vehicle procurement flag	no
43	productcarbonemissionsoffsetflag	string	Override the default Carbon Emissions profile flag, 'yes' or 'no'	no
44	productcomprehensiveinsurance_flag	string	Override the default Comprehensive Insurance profile flag, 'yes' or 'no'	no
45	productextendedwarranty_flag	string	Override the default Extended Warranty profile flag, 'yes' or 'no'	no
46	productltitopupbenefit_name	string	If more than one active “Top Up Benefit” exists for the “Plan” passed, then a ‘productltitopupbenefit_name’ should be passed as well. The Quote created should pre-populate the “Plan” and “Top Up Benefit” and include the “Premium” in its calculations.	no
47	productnlpiflag	string	Override the default NLPI inclusion flag, 'yes' or 'no'	no
48	productroadsideassistance_flag	string	Override the default Roadside Asistance inclusion flag, 'yes' or 'no'	no
49	productrvehamount_net	string	Add the Relief Vehicle monthly cost to the Profile (Quotes / Lease -> 'Monthly Budget')	no
50	productrvehflag	string	Override the default Relief Vehicle inclusion flag, 'yes' or 'no'	no
51	productsmalldamagerepairsflag	string	Override the default Small Damage Repairs profile flag, 'yes' or 'no'. If the quote term does not match one of the SDR profile records, SDR will be checked on but the premium will not calculate.	no
52	producttyreandrimflag	string	Override the default Tyre and Rim inclusion flag, 'yes' or 'no'	no
53	productvehiclemaintenanceprogramflag	string	Override the default Vehicle Maintenanace profile flag, 'yes' or 'no'	no
54	productwalkawayflag	string	Override the default Walkaway inclusion flag, 'yes' or 'no'	no
55	purchasestampduty	decimal	Sets the Purchase Stamp Duty in the quote and turn on the lockpurchasestampdutyflag	no
56	suppliercodefinancier	string	Set an alternative Financier. This will override the Financier default set on the Quote Defaults and must map to a Supplier with a 'Supplier Type' set to "Financier" on the Suppliers / Account tab.	no
57	useridassigned	int	Set the Quote 'Assigned' user. Must be an active Catch-e user_id i.e. not at 'deleted' status	no
58	driverdriverlicence	string	If Driver found or new Driver created, Driver's "Licence No" will be updated.	no
59	driverdriverlicence_state	string	If Driver found or new Driver created, Driver's "Licence State" will be updated.	no
60	driver_mobile	string	If Driver found or new Driver created, Driver's "Mobile" will be updated.	no
61	previousfbtvalue	integer	It's optional and can only be a positive number.	no
62	previousleasestart	integer	User can give a previous lease start date	no
63	productltiflag	string	Either yes or no are the only acceptable values to be passed,if the fag is set to yes, If ‘productltiflag’ = yes is passed, and only one active “Plan” / “Top Up Benefit” is found, the Quote created should pre-populate the “Plan” and “Top Up Benefit” and include the “Premium” in its calculations.	no
64	productltiplan_code	string	If the ‘productltiplan_code’ passed has only one active “Top Up Benefit”, the Quote created should pre-populate the “Plan” and “Top Up Benefit” and include the “Premium” in its calculations.	no
65	status_flag	string	Must be one of values. Default value is stored in .	no
66	cost_centre	string	Must be one of values.	no
67	division	string	Must be one of values.	no
68	plate_year	string	Pass a value to specify the Plate Year. The plateyear can be any year between 1900-2099. If plateyear not passed, the value for Default Year is used.	no
69	driver_salutation	string	enum('Mr','Mrs','Ms','Miss','Dr','Prof','Rev','Capt')	no
70	driver_gender	string	enum('Male','Female','Other')	no
71	driverdateof_birth	string	Date of Birth	no
72	employerfbttype	string	Choose from 'full-fbt-payable', 'concessional-30000-exempt', 'concessional-17000-exempt', 'rebatable' or 'not-applicable'. If this field is passed, the value must conform to the Employer FBT Type business rules, otherwise the call is rejected. If this field is not passed, the quote will update based on the Employer FBT Type business rules.	no
73	fbtbenefittype	string	Choose from 'statutory','operating' or 'exempt'. If Clients:Quote defaults	Clients / Quote Defaults "Allow Operating FBT Type" is un-checked, then you cannot use 'operating'.
74	fbtbusinessuse	string	Bus. Use%	no

Input URL Example

https://yourname.catch-e.net.au/services/qt/salesforce/createQuote/?opportunity_id=006O0000001sxBWIAY&opportunity_number=61&variant_id=123456&state_registered=VIC&annual_kilometres=20000&term=36&client_code=ABC&driver_annual_salary=70000&driver_external_code=1233456&driver_surname=smith&deal_type=dealer-sourced&insurer_location_postcode=3000&login=yourlogin&password=yourpassword

https://yourname.catch-e.net.au/services/qt/salesforce/createQuote?login=yourlogin&password=yourpassword&variant_id=163522&user_id_client_manager=10133&term=36&annual_kilometres=5000&state_registered=WA&client_code=ABC&driver_annual_salary=100000&driver_surname=DSurname&posting_map_code=NOFB&location_name=location test

Output Example

123456

Error Codes

	Error Codes	Notes
1	CATCHEERROROPPORTUNITYID_MISSING	Input field missing
2	CATCHEERROROPPORTUNITYNUMBER_MISSING	Input field missing
3	CATCHEERRORVARIANTID_MISSING	Input field missing
4	CATCHEERRORUSERIDCLIENTMANAGER_MISSING	Input field missing
5	CATCHEERRORMISSINGFIELDLEASEPERIOD	Input field missing
6	CATCHEERRORMISSINGFIELDANNUALKILOMETRES	Input field missing
7	CATCHEERRORTERMMISSING	Input field missing
8	CATCHEERRORANNUALKILOMETRES_MISSING	Input field missing
9	CATCHEERRORSTATEREGISTERED_MISSING	Input field missing
10	CATCHEERRORINSURERLOCATIONPOSTCODEMISSING	Input field missing
11	CATCHEERRORCLIENTCODE_MISSING	Input field missing
12	CATCHEERRORDRIVERANNUALSALARYMISSING	Input field missing
13	CATCHEERRORDRIVEREXTERNALCODEMISSING	Input field missing
14	CATCHEERRORDRIVERSURNAME_MISSING	Input field missing
15	CATCHEERRORDEALTYPE_MISSING	Input field missing
16	CATCHEERRORDEALTYPE_INVALID	Input field invalid, must be either 'dealer-non-sourced', 'dealer-sourced', 'private-sale', 'refinance', 'sale-and-leaseback', or 'generic-quote'
17	CATCHEERRORSTATEREGISTERED_MISSING	Input field missing
18	CATCHEERRORLISTPRICENETMISSING	Input field missing, this only occurs if the listpricegst has been included
19	CATCHEERRORLISTPRICEGSTMISSING	Input field missing, this only occurs if the listpricenet has been included
20	CATCHEERRORODOMETERMISSING	Input field missing, this only applicable if NEW_USED is not 'new' e.g. 'used' or 'demonstrator'
21	CATCHEERROROPPORTUNITYID_INVALID	Input field is empty
22	CATCHEERROROPPORTUNITYNUMBER_INVALID	Input field is empty
23	CATCHEERRORVARIANTID_INVALID	Input field invalid record not found
24	CATCHEERRORLISTPRICEGROSSINVALID	Input field invalid evaluates to zero
25	CATCHEERRORLISTPRICENETINVALID	Input field invalid evaluates to zero
26	CATCHEERRORANNUALKILOMETRES_INVALID	Input field invalid evaluates to zero
27	CATCHEERRORSTATEREGISTERED_INVALID	Input field invalid. When [ is 'AUS' then it must be either 'NSW', 'VIC', 'QLD', 'ACT', 'TAS', 'SA', 'WA', or 'NT' When is 'NZ' then it must be 'NZ'.
28	CATCHEERRORTERMINVALID	Input field invalid evaluates to zero
29	CATCHEERRORUSERIDCLIENTMANAGER_INVALID	Input field contains unknown account manager
30	CATCHEERRORDRIVERANNUALSALARYINVALID	Input field invalid evaluates to zero
31	CATCHEERRORBADQUOTE_TEMPLATE	Data set up issue

| 32 | CATCHEERRORQUOTEVALIDATIONFAILED | There is a data set up issue. This error returns an additional details of the error (see example below). | | : : CATCHEERRORQUOTEVALIDATIONFAILED : Validation failed due to the following error(s): : 1. Procurement fee must contain a value. :

In this example, the default = '0', but the = 'no'.
To fix this, update to contain a value or set the input field procurementflag = 'no' or remove it from the call. | | || 33 | CATCHEERRORCLIENTCODEINVALID | Client cannot be read |
| 34 | CATCHEERRORDRIVEREXTERNALCODEINVALID | Input field is blank |
| 35 | CATCHEERRORDRIVERSURNAMEINVALID | Input field is blank || 36 | CATCHEERRORPARENTQUOTEIDINVALID | Quote cannot be read || 37 | CATCHEERRORFAILEDCREATINGDRIVER | Driver record insert failed |
| 38 | CATCHEERRORFAILEDUPDATINGDRIVER | Driver record update failed || 39 | CATCHEERRORINSURERLOCATIONPOSTCODEINVALID | Input field not an int || 40 | CATCHEERRORNEWUSEDINVALID | Input field invalid |
| 41 | CATCHEERRORODOMETERINVALID | Input field evaluates to zero, this is only applicable if NEWUSED is not 'new', e.g. 'used' or 'demonstrator' || 42 | CATCHEERRORREADINGENCRYPTEDFIELDS | Error reading encrypted fields on callback |
| 43 | CATCHEERRORPOSTINGMAPCODEINVALID | Invalid contract type |
| 44 | CATCHEERRORFBTVALUEINVALID | Must be a non-zero currency value || 45 | CATCHEERRORUPDATINGOPPORTUNITY | Failed to update Salesforce database || 46 | CATCHEERRORQUOTESAVEFAILED | Failed saving quote in Catch-e database |
| 47 | CATCHEERRORBADCONTRACTTYPEDEFAULT | Bad setup in Catch-e. Contract Type "Status" may be 'inactive' or missing Quote Template value. |
| 48 | CATCHEERRORLOADINGTYPEPASTCLAIMSINVALID | Input field invalid || 49 | CATCHEERRORLOADINGTYPELICENCEINVALID | Input field invalid || 50 | CATCHEERRORLOADINGTYPEDRIVERRESTRICTIONINVALID | Input field invalid |
| 51 | CATCHEERRORPROCUREMENTFLAGINVALID | Input field invalid || 52 | CATCHEERRORFINANCIERCODEINVALID | An invalid suppliercodefinancier has been set. The code must map to a Supplier with a 'Supplier Type' set to "Financier" on the Suppliers / Account tab. |
| 53 | CATCHEERRORPAYCYCLECODEINVALID | The Pay Cycle Code is invalid. |
| 54 | CATCHEERRORLTIPLANCODEMISSING | If more than one active “Plan” is found and ‘productltiplancode’ not passed. || 55 | CATCHEERRORLTIPLANCODEINVALID | If ‘productltiplancode’ not found. |
| 56 | CATCHEERRORLTITOPUPBENEFITNAMEMISSING | If more than one active “Top Up Benefit” is found and ‘productltitopupbenefitname’ not passed. || 57 | CATCHEERRORLTITOPUPBENEFITNAMEINVALID | If ‘productltitopupbenefitname’ not found. |
| 58 | CATCHEERRORINCLUSIONPLAN{CODE}INVALID | No match found for nominated Inclusion Plan Code |
| 59 | CATCHEERRORINCLUSIONSELECTIONINVALID | No match has been found for against the Inclusion for one or more nominated plans || 60 | CATCHEERRORQUOTEVALIDATIONFAILED | Previous FBT Value must be 0 or a positive number. |
| 61 | CATCHEERRORINVALIDCOSTCENTRE | The costcentre passed is not stored in the database for the Client. |
| 62 | CATCHEERRORINVALIDDIVISION | The division passed is not stored in the database for the Client. |
| 63 | CATCHEERRORINVALIDPLATEYEAR | The plateyear is not within valid range 1900-2099. |
| 64 | CATCHEERROREMPLOYERFBTTYPEINVALID | employerfbttype is not valid for this client. See Employer FBT Type for full details of validation. |
| 65 | CATCHEERROROPERATINGFBTBENEFITTYPENOTALLOWED | Operating FBT type is not allowed due to Client "Allow Operating FBT Type" configuration |

Error Output Example 1

CATCHEERRORVARIANTID_MISSING