Create Quote Endpoints: CreateQuotes — Permissions

API endpoints for creating quotes and variants

Permissions

Note: This permission and API are not available by default.
Contact your Account Manager to get access to this API.
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 Quotes:Create.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/qt/quotes

Headers

KeyFormatNotesMandatory
Audit-User-IdstringIf an Authenticated API user has the Audit:UserIdOverride permission, an optional header Audit-User-Id can be supplied on supported web-services that will create any associated Audit Records with the user_id specified.No
Time-ZonestringDate fields will use UTC by default. When a specified timezone. e.g. Australia/Melbourne is included, Date fields will use the specified timezone. Fields that are either 'date-time' or 'timestamps' will use system defaults (Australia-Sydney).No

Body - JSON

JSON FieldFormatNotesMandatory
overridewarningsflagstringIf 'no', quotes will be validated and will not update if a warning is given. If 'yes', alerts will be ignored and the quote will be updated.No
quotestatusidstringMust be a valid record from Default value is stored in .No
dealtypeidstringDeal Type field in SalesforceNo
postingmapidstringPass the postingmapid to nominate the contract type to add to the Quotes / Contract “Type Code” field. Only contract types where Contract Types / Details “Status” is ‘active’ will be selected. If not passed, the following logic will be used; 1. Use Clients / Quote Defaults “Contract Type” if populated. 2. Otherwise, default from .No
termstring1 to 60Yes
annual_kmsstringNon-zero positive numberYes
statestringState 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
cost_centrestringMust be one of values.No
divisionstringMust be one of values.No
location_namestringSet the Insurance location you want applied. This will display on the Quotes → Contract tab.No
parentquoteidstringQuote ID to use as the parent of the new quoteNo
opportunity_idstringSalesforce opportunity idNo
opportunity_numberstringSalesforce opportunity #No
client_idstringPass the Client ID here. I.e. .Yes
client_namestringThis key is optional. If it is not passed, the name associated with the client_id key will be applied here, i.e. . Pass a client name here if you want to record a name in the field that is different to the client's name.No
useridclient_managerstringActive Catch-e user_id i.e. not at 'deleted' statusYes
Driver Fields
driver_idstringAn 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
driver_surnamestringYes
drivergivennamestringNo
driver_phonestringNo

| insuranceloadingtypes | string | pastclaims One of noclaims0to5years, 1claimin12months, 1claimin1to3years, 2+claims0to3years, 3+claimsin0to5years. Insert one of the applicable 'insuranceloadingtypeid' values stored in

license
One of noloss, lossin2to5years, lossin0to2years.Insert one of the applicable 'insuranceloadingtypeid' values stored in

driverrestriction
One of nodriverslessthan26yo, alldrivers, nodriverslessthan22yo.
Insert one of the applicable 'insuranceloadingtypeid' values stored in | No || useridassigned | string | Set the Quote 'Assigned' user. Must be an 'active' Catch-e userid. | No |
| paycycleid | string | Allows you to set the Pay Cycle for this quote. The list of available ids are stored in If not passed the Client Pay Cycle will be used. | No |
| annualsalary | string | Annual gross salary | Yes || 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 || fbtbenefittype | string | Choose from 'statutory','operating' or 'exempt'. If Clients / Quote Defaults "Allow Operating FBT Type" is un-checked, then 'operating' is not a valid choice for the client's quotes. | No || fbtbusinessuse | string | FBT Bus. Use% | No || previousleasestart | string | User can give a previous lease start date | No || previousfbt_value | string | It's optional and can only be a positive number. | No |
| Driver Element | | | |
| driver | string |

"driver": { "addresses": { "home": { "address_1": "Address 1", "address_2": "Address 2", "area": "Address Area", "state": "NSW", "postcode": "3001", "country_id": "16238953344683478812" }, "post": { "address_1": "Address 1", "address_2": "Address 2", "area": "Address Area", "state": "NSW", "postcode": "3002", "country_id": "16238953344683478812" } },

| No |
| dateofbirth | string | Date of Birth | No |
| driverlicence | string | If Driver found or new Driver created, Driver's "Licence No" will be updated. | No || driverlicencestate | string | If Driver found or new Driver created, Driver's "Licence State" will be updated. | No || externalcode | string | Pacman Unique reference used to identify this driver | No |
| gender | string | enum('Male','Female','Other') | No |
| givenname | string | Given name | No || homeemail | string | Home email | No |
| homepostcode | string | | No || homestate | string | | No |
| mobile | string | If Driver found or new Driver created, Driver's "Mobile" will be updated. | No |
| salutation | string | enum('Mr','Mrs','Ms','Miss','Dr','Prof','Rev','Capt') | No |
| surname | string | Surname of the driver | No |
| workphone | string | Work phone number | No || variantid | string | Catch-e variant identifier | Yes |
| plateyear | 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 || newused | string | Indicates whether the vehicle is new or used, defaults to 'new'. Options are 'new', 'used' or 'demonstrator' | No |
| procurementflag | string | Sets the quote vehicle procurement flag | No || odometer | string | If 'newused' is set to 'used' or 'demonstrator' this value must bet set to a non-zero integer | No |
| colourpreference | string | Set the colour preference | No || listpricenet | string | Numeric dollar value | No || listpricegst | string | Numeric dollar value | No || purchasestampduty | string | Sets the Purchase Stamp Duty in the quote and turn on the lockpurchasestampdutyflag | No || fbtvalue | string | Sets the FBT Value in the quote and turn on the lockfbtvalueflag | No || datefirstheld | string | date (yyyy-mm-dd). See also FBT Treatment Type. | No || luxurycartaxpaidflag | string | yes or no. See also FBT Treatment Type. | No || supplierid_financier | 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 |
| insurance | string |

"insurance": { "supplier_id": "string", "insurance_type_id": "string", "billing_type": "string", "claim_excess": 0, "annual_insurance": 0, "fund_1st_year_flag": "no", "monthly_amount_net": 0, "included_flag": "yes" },

| No |
| roadside_assistance | string |

"roadside_assistance": { "roadside_assistance_plan_id": "string", "premium": 0, "cost": 0, "monthly_amount_net": 0, "included_flag": "yes" },

| No |
| relief_vehicle | string |

"relief_vehicle": { "monthly_amount_net": 0, "included_flag": "yes" },

| No |
| vehiclemaintenanceprogram | string |

"vehicle_maintenance_program": { "monthly_amount_net": 0, "included_flag": "yes" },

| No |
| lti | string |

"lti": { "lti_top_up_benefit_id": "string", "retail_price_gross": 0, "included_flag": "yes" },

| No |
| smalldamagerepairs | string |

"small_damage_repairs": { "small_damage_repairs_id": "string", "premium": 0, "monthly_amount_net": 0, "included_flag": "yes" },

| No |
| redundancyinsuranceflag | string |

"redundancy_insurance_flag": "no",

| No |
| carbonemissionsoffset | string |

"carbon_emissions_offset": { "included_flag": "yes" },

| No |
| walkaway | string |

"walkaway": { "walkaway_plan_id": "string", "included_flag": "yes" },

| No |
| tyreriminsurance | string |

"tyre_rim_insurance": { "tyre_rim_insurance_plan_id": "string", "included_flag": "yes" },

| No |
| inclusion_plans | string | Input rules for: Default Lease Inclusion Plans, Excluding selected Lease Inclusion Plans Pricing of Plans etc can be found on the Lease Inclusion Plans page. All of these rules and logic are applied to the createQuotes functionality.

"inclusion_plans": [ { "inclusion_code": "string", "inclusion_plan_code": "string", "inclusion_plan_code_qualified": "string", "retail_price_gross": 0, "included_flag": "yes" } ],

| No |