PatchQuote - Options Tab

Fields found primarily on Quotes / Options tab.

Supplementary SWAGGER documentation: api.catch-e.com/docs/#/Quotes/patchQuote

Body - JSON

Array of optional_equipment objects.

Field	Format	Notes	Mandatory
included_flag	string	If 'yes', optional equipment added. If 'no', removed.	Yes
optional_equipment_id	string	Equipment ID to add or remove	Yes
description	string	Override system default description	No
cost_price_net	number	Override system default cost price net	No
list_price_net	number	Override system default list price net	No
discount_net	number	Override system default discount net	No
gst	number	Override system default GST	No
residual_rate	number	Override system default residual rate	No

Examples

Adding one Optional Equipment

"optional_equipment": [ { "included_flag": "yes", "optional_equipment_id": "100000" } ]

Adding two Optional Equipment

"optional_equipment": [ { "included_flag": "yes", "optional_equipment_id": "100000" }, { "included_flag": "yes", "optional_equipment_id": "100001" } ]

Removing one Optional Equipment

"optional_equipment": [ { "included_flag": "no", "optional_equipment_id": "100000" } ]

Removing multiple Optional Equipment

"optional_equipment": [ { "included_flag": "no", "optional_equipment_id": "100000" }, { "included_flag": "no", "optional_equipment_id": "100001" }, { "included_flag": "no", "optional_equipment_id": "100002" } ]

Modifying Optional Equipment with overrides

"optional_equipment": [ { "included_flag": "yes", "optional_equipment_id": "100000", "description": "This is alternative description for the option", "cost_price_net": "545.45", "list_price_net": "545.45", "discount_net": "0", "gst": "54.55", "residual_rate": "0" } ]

PatchQuote - Other Tab

Fields found on Quotes / Other tab. Not all fields supported yet. If field listed here, it is supported.

Supplementary SWAGGER documentation: api.catch-e.com/docs/#/Quotes/patchQuote

Body - JSON

Field	Format	Notes	Mandatory
bespoke_field_values	object	Nominate required value for each field. Range of input values available depending on input_type. 6 input types appropriate for use here. Not all input types validated in API; test fully.	No

Bespoke Field Input Types

Input Type	Description	Validation
number	Right-justified numeric character entry	Yes (see 422 Response)
listbox	Pass required listbox value as API value	Yes (see 422 Response)
textarea	Allows alpha, numeric, character text	No
text	Allows alpha, numeric, character text	No
date	Date content with date selector	No (any value can be passed)
checkbox	Checked = yes, unchecked = no	No (any value can be passed)

Sample JSON

{ "after_hours_assistance_flag": "no", "allowances": 0, "annual_kms": 0, "annual_salary": 0, "application_date": "YYYY-MM-DD", "application_reference": "string", "bespoke_field_values": { "bespoke_field_name": "Bespoke Field Value" } }

422 Validation Errors

Invalid listbox value:

{ "bespoke_field_values": { "invalidBespokeFieldValue": "input_type_listbox: Unsupported value" } }

When input_type is 'listbox', must pass valid listbox value.

Invalid number:

{ "bespoke_field_values": { "invalidBespokeFieldValue": "input_type_number: Must be a number" } }

When input_type is 'number', only numeric value can be passed.

Useful Query

select bfv.record_id as quote_id, bf.bespoke_field_id, bf.field_name, bf.input_type, bf.default_value, bf.input_maxlength, coalesce(bl.value, bfv.value) as value from gb_bespoke_fields as bf left join gb_bespoke_field_values as bfv on bfv.bespoke_field_id = bf.bespoke_field_id left join gb_bespoke_listboxes as bl on bl.bespoke_field_id = bf.bespoke_field_id and bl.bespoke_listbox_id = bfv.value where bf.table_name = 'qt_quotes' and bfv.record_id = 100009;

PatchQuote - Vehicle Tab

Fields primarily found on Quotes / Vehicle tab. All Vehicle tab fields supported.

Supplementary SWAGGER documentation: api.catch-e.com/docs/#/Quotes/patchQuote

Column One

Field	Format	Notes	Mandatory
variant_id	string	Updates Variant	No
plate_year	string	Updates Plate Year	No
new_used	string	Updates New/Used. Values: new, used, demonstrator	No
procurement_flag	checkbox	Updates Procurement flag	No
procurement_fee	number	Updates Procurement Fee	No
disposal_flag	checkbox	Updates Disposal flag	No
disposal_fee	number	Updates Disposal Fee	No
odometer	checkbox	Updates Odometer (mandatory when new_used = used or demonstrator)	No
warranty_months	string	Updates Warranty Mths	No
warranty_kms	string	Updates Warranty KMs	No
colour_preference	string	Updates Colour	No
colour_preference_2	string	Updates 2nd Colour preference	No
colour_preference_3	string	Updates 3rd Colour preference	No
colour_preference_note	string	Updates Colour preference Note	No
trim_preference	string	Updates Trim	No

Column Two

Field	Format	Notes	Mandatory
supplier_id_dealer	string	Updates Preferred Dealer	No
dealer_comment	string	Updates Comments	No
discount_type_id	string	Updates Discount Status	No
delivery_location_type	string	Updates Delivery Type	No
list_price_net	float	Updates List Price (Exc GST)	No
list_price_gst	float	Updates List Price (GST)	No
lock_discount_flag	string	Updates checkbox next to Fleet Discount	No
discount_percentage	float	Updates Discount%	No
discount_net	float	Updates Fleet Discount (Exc GST)	No
discount_gst	float	Updates Fleet Discount (GST)	No
rebate_net	float	Updates Confidential Rebate (Exc GST)	No
rebate_gst	float	Updates Confidential Rebate (GST)	No
dealer_rebate_net	float	Updates Dealer Rebate	No
dealer_rebate_gst	float	Updates Dealer Rebate (GST)	No
bonus_amount_net	float	Updates Bonus (Exc GST)	No
bonus_amount_gst	float	Updates Bonus (GST)	No
lock_dealer_discount_flag	string	Updates checkbox next to Dealer Discount	No
dealer_discount_net	float	Updates Dealer Discount (Exc GST)	No
dealer_discount_gst	float	Updates Dealer Discount (GST)	No
margin_net	float	Updates Margin (Exc GST)	No
margin_gst	float	Updates Margin (GST)	No
dealer_delivery_net	float	Updates Dealer Delivery Fee (Exc GST)	No
dealer_delivery_gst	float	Updates Dealer Delivery Fee (GST)	No
lock_luxury_car_tax_flag	string	Updates checkbox next to Luxury Car Tax	No
luxury_car_tax	float	Updates Luxury Car Tax	No
ctp_initial_net	float	Updates Initial CTP (Exc GST)	No
ctp_initial_gst	float	Updates Initial CTP (GST)	No
reg_initial_net	float	Updates Initial Registration	No
premium_plates_net	float	Updates Premium Plate	No
lock_purchase_stamp_duty_flag	string	Updates checkbox Purch. Stamp Duty	No
purchase_stamp_duty	float	Updates Purch. Stamp Duty. Overrides all calculation variations.	No
lock_fbt_value_flag	checkbox	Updates Lock FBT Value	No
fbt_value	float	Updates FBT Value	No
fbt_treatment_type	checkbox	Updates FBT Treatment Type	No
date_first_held	string	If new_used not 'new' and LCT rules apply and luxury_car_tax = 0 and date_first_held not in payload: fbttreatmenttype set to 'standard'. Blank date (0000-00-00) prior to 2022-07-01.	No
luxury_car_tax_paid_flag	string	If new_used not 'new' and LCT rules apply and luxury_car_tax = 0 and flag not in payload: fbttreatmenttype set to 'standard'	No
price_comment	string	Updates Pricing Comments	No
pricing_requested	timestamp	Updates Pricing Requested	No
pricing_received	timestamp	Updates Pricing Received	No
pricing_reference	string	Updates Pricing Reference	No

PatchQuote Supporting APIs

APIs offering ways to obtain data required for patchQuote. For example, patchQuote expects pay_cycle_id. Use getPayCycles to get pay_cycle_id.

Supplementary SWAGGER documentation: api.catch-e.com/docs/#/Quotes/patchQuote

Note: These APIs not configured for external use by default but may be available on request. Contact your Account Manager.

Quote / Status & Sub Status

Method	Comments
getQuoteStatuses	Get list of Quote Statuses
getQuoteSubStatuses	Get list of Quote Sub Statuses

Quote / Competitors

Method	Comments
getCompetitors	Get list of Competitors
getCompetitorMargins	Get list of Competitor Margins

Quote / Deal Types

Method	Comments	Permission
getDealTypes	Retrieve list of Deal Types	DealTypes:Get

Quote / Contract Type Code

Method	Comments	Permission
getPostingMaps	Retrieve list of Contract Types (Posting Maps)	PostingMaps:Get

Quote / Discount Types

Method	Comments
getDiscountTypes	Get list of Discount Types

Quote / Finance Types

Method	Comments
getFinanceTypes	Get list of Finance Types

Quote / Fuel Types

Method	Comments
getFuelTypes	Get list of Fuel Types
getFuelTypeTranslations	Get list of Fuel Type Translations

Quote / Inclusions

Method	Comments
getInclusion	Get details of single inclusion
getInclusions	Get list of inclusions
getInclusionPlan	Get details of single inclusion plan
getInclusionPlans	Get list of inclusion plans

Quote / Insurance

Method	Comments
getInsuranceLoadingTypes	Get list of insurance loading types
getInsuranceLoadingType	Get details of single insurance loading type
getInsuranceTypes	Get list of insurance types
getInsuranceType	Get details of single insurance type
getInsurerLocations	Get list of insurance locations
getInsurerLocation	Get details of single insurance location

Quote / Loan Termination Insurance

Method	Comments
getLtiPlans	Get list of LTI Plans
getLtiTopUpBenefits	Get list of LTI Top Up Benefits

Quote / Location Rego

Method	Comments
getLocations	Get list of Location Rego ID values (Metro, Semi Metro, Country)

Quote / Maintenance and Service

Method	Comments
getMaintenanceServiceProfiles	Get list of Maintenance Profiles

Quote / Opportunity Stages

Method	Comments	Permission
getOpportunityStages	Get list of Opportunity Stage IDs for Salesforce CRM	OpportunityStages:Get

Quote / Power Plant Types

Method	Comments
getPowerPlantTypes	Get list of Power Plant Types

Quote / Roadside Assistance

Method	Comments
getRoadsideAssistancePlans	Get list of Roadside Assistance Plan IDs

Quote / Tyre Rim Insurance

Method	Comments
getTyreRimInsurancePlans	Get list of Tyre Rim Insurance Plan IDs

Quote / Tyres

Method	Comments
getTyres	Get list of Tyres

Quote / Variants

Refer to CreateVariants documentation for details.

Quote / Vehicle Types

Method	Comments	Permission
getVehicleTypes	Get list of vehicle types	VehicleTypes:Get

Quote / Vehicle Usage Types

Method	Comments	Permission
getVehicleUsageTypes	Get list of Usage Types	VehicleUsageTypes:Get

Quote / Walkaway

	Method Comments
getWalkawayPlans	Get list of Walkaway Plan IDs