Update Quote Endpoints: PatchQuote - Options tab

PatchQuote - Options tab

The fields listed on this page are all found primarily on the Quotes / Options tab.

Refer to main page for full details of patchQuote functionality.

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

Body - JSON

Sample JSON content

Adding one Optional Equipment record

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

Adding two Optional Equipment records

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

Removing one Optional Equipment record

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

Removing multiple Optional Equipment records

"optional_equipment": [ { "included_flag": "no", "optional_equipment_id": "100000" }, { "included_flag": "no", "optional_equipment_id": "100001" }, { "included_flag": "no", "optional_equipment_id": "100002" }]NOTE: Repeat for each optional_equipment_id you want removed.

Example for modifying an Optional Equipment

"optional_equipment": [ { "included_flag": "yes", "optional_equipment_id": "100000", "description": "This is an 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

The fields listed on this page are all found on the Quotes:Other tab.

Note: Not all fields are supported yet. If a field is listed below it is supported.

Refer to main page for full details of patchQuote functionality.

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

Body - JSON

| bespokefieldvalues | string | **Nominate the required for each field. A range of different input values can be used for bespoke fields, see the notes below for the requirements of each input type. 6 input types are appropriate for use here. Not all input types are validated in the API, so test fully when setting up your calls. The API will also validate supplied values against a (if present). Settings for are not validated. Settings for are not validated.
** | input_type | Description | Validation |
| number | Right justified numeric character entry | Yes. See 422 Response Details. | | | |
| listbox | For the nominated , pass the required as the API value. | Yes. See 422 Response Details. | | | |
| textarea | Will allow alpha, numeric and character text content | No | | | |
| text | Will allow alpha, numeric and character text content | No | | | |
| date | Will allow date content and will pop a date selector | No. Any value can be passed and will be displayed. | | | |
| checkbox | Checked = yes, unchecked = no | No. Any value can be passed and will be displayed. | | | |
| blank | Will insert a blank row on screen (used for aesthetics only) | Input type should not be used here. | | | |
| label | Used to contain the section heading label | Input type should not be used here. | No | | |

Sample JSON content

This example displays a section of content if bespoke fields were being used in the API

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

{ "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" }}

Response Details

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

| If the setting is 'listbox' for the target field, the must be passed. | |

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

| If the setting is 'number' for the target field, only an number can be passed. |

Useful Queries

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 valuefrom gb_bespoke_fields as bfleft join gb_bespoke_field_values as bfv on bfv.bespoke_field_id = bf.bespoke_field_idleft join gb_bespoke_listboxes as bl on bl.bespoke_field_id = bf.bespoke_field_id and bl.bespoke_listbox_id = bfv.valuewhere bf.table_name = 'qt_quotes' and bfv.record_id = 100009 # quote_id;

PatchQuote - Vehicle tab

The fields listed on this page are primarily found on the Quotes / Vehicle tab.

Note: All Quotes / Vehicle tab fields are supported.

Refer to main page for full details of patchQuote functionality.

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

Refer to Options tab for details about adding/removing or editing Optional Equipment.

Body - JSON

| datefirstheld | string | IF: ‘New or Used’ does not equal ‘New’
and
= ‘yes’ (using existing hierarchical logic from then )
and
Quote “Luxury Car Tax” already equals zero or patchQuote payload contains "luxurycartax": "0.00":
and
"datefirstheld" is not in patchQuote payload:
THEN:
"fbttreatmenttype" will be set to 'standard'.
Notes:
A blank date (0000-00-00) is considered to be prior to 2022-07-01.
See FBT Treatment Type for additional explanation of ATO Rules. | No |
| luxurycartaxpaidflag | string | IF: ‘New or Used’ does not equal ‘New’ and = ‘yes’ (using existing hierarchical logic from then ) and Quote “Luxury Car Tax” already equals zero or patchQuote payload contains "luxurycartax": "0.00": and "luxurycartaxpaidflag" is not in patchQuote payload: THEN: "fbttreatmenttype" will be set to 'standard'. Notes: See FBT Treatment Type for additional explanation of ATO Rules. | No |
| pricecomment | string | Updates the Pricing Comments | No || pricingrequested | timestamp | Updates the Pricing Requested | No |
| pricingreceived | timestamp | Updates the Pricing Received | No || pricingreference | string | Updates the Pricing Reference | No |

PatchQuote Supporting APIs

The APIs shown below offer ways of obtaining data required for patchQuote. For example, patchQuote expects paycycleid. Use getPayCycles to get the paycycleid for your chosen Pay Cycle.

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

Note: These APIs are not configured for external use but may be made available on request.
Contact your Account Manager to discuss.

Quote / Status & Sub Status

Quote / Competitors

Quote / Deal Types

Quote / (Contract) Type Code

Quote / Discount Types

Quote / Finance Types

Quote / Fuel Types

Quote / Inclusions

Quote / Insurance

Quote / Loan Termination Insurance

Quote / Location Rego

Quote / Maintenance and Service

Quote / Opportunity Stages

Quote / Power Plant Types

Quote / Roadside Assistance

Quote / Tyre Rim Insurance

Quote / Tyres

Quote / Variants

Details can be found here.

Quote / Vehicle Types

Quote / Vehicle Usage Types

Quote / Walkaway

Legend