Skip to main content

Note: Some features in this page are due to be deployed on 04/11/2026 and not currently available

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 Quotes:Create.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL

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

Headers

Audit-User-Id

string

If Authenticated API user has Audit:UserIdOverride permission, optional header to create Audit Records with specified user_id

No

Time-Zone

string

Date fields use UTC by default. Specify timezone (e.g. Australia/Melbourne) for Date field localization. Date-time/timestamp fields use system defaults (Australia/Sydney).

No

Body (JSON)

Quote

Key

Format

Notes

Mandatory

override_warnings_flag

string

If 'no', quotes validated and not updated if warning given. If 'yes', alerts ignored.

No

quote_status_id

string

Must be valid record

No

deal_type_id

string

Deal Type field in Salesforce

No

posting_map_id

string

Contract type. Only active contract types selected. If not passed, uses Clients / Quote Defaults or default from config.

No

term

string

1 to 60

Yes

annual_kms

string

Non-zero positive number

Yes

state

string

State codes: VIC, NSW, ACT, NT, TAS, WA, SA, QLD, NZ

Yes

cost_centre

string

Must be valid value

No

division

string

Must be valid value

No

location_name

string

Insurance location. Displays on Quotes > Contract tab.

No

parent_quote_id

string

Quote ID to use as parent

No

opportunity_id

string

Salesforce opportunity id

No

opportunity_number

string

Salesforce opportunity #

No

client_id

string

Client ID

Yes

client_name

string

Optional. If not passed, name from client_id used. Pass different name if needed.

No

user_id_client_manager

string

Active Catch-e user_id

Yes

Driver

Key

Format

Notes

Mandatory

driver_id

string

Alternative to driver_external_code. Updates Driver record. If driver_id=100000, update. If driver_id=0 or not passed, don't create. If create_new_driver_flag=yes, create.

No

driver_surname

string

Surname of driver

Yes

driver_given_name

string

Given name

No

driver_phone

string

Home phone number

No

insurance_loading_types

string

past_claims, license, driver_restriction with applicable insurance_loading_type_id values

No

user_id_assigned

string

Set Quote 'Assigned' user. Must be active user_id.

No

pay_cycle_id

string

Pay Cycle ID. If not passed, Client Pay Cycle used.

No

annual_salary

string

Annual gross salary

Yes

employer_fbt_type

string

Choose: 'full-fbt-payable', 'concessional-30000-exempt', 'concessional-17000-exempt', 'rebatable', 'not-applicable'

No

fbt_benefit_type

string

Choose: 'statutory', 'operating', 'exempt'

No

fbt_business_use

string

FBT Bus. Use %

No

previous_lease_start

string

Previous lease start date

No

previous_fbt_value

string

Optional; positive number only

No

date_of_birth

string

Date of Birth

No

driver_licence

string

Driver's Licence No

No

driver_licence_state

string

Driver's Licence State

No

external_code

string

Pacman Unique reference

No

gender

string

enum: 'Male', 'Female', 'Other'

No

home_email

string

Home email

No

home_postcode

string

Home postcode

No

home_state

string

Home state

No

mobile

string

Mobile number

No

salutation

string

enum: 'Mr', 'Mrs', 'Ms', 'Miss', 'Dr', 'Prof', 'Rev', 'Capt'

No

work_phone

string

Work phone number

No

Vehicle

Key

Format

Notes

Mandatory

variant_id

string

Catch-e variant identifier

Yes

plate_year

string

Plate Year (1900-2099); default used if not passed

No

new_used

string

'new', 'used', or 'demonstrator'. Defaults to 'new'.

No

procurement_flag

string

Sets quote vehicle procurement flag

No

odometer

string

If new_used is 'used' or 'demonstrator', must be non-zero integer

No

colour_preference

string

Colour preference

No

list_price_net

string

Numeric dollar value

No

list_price_gst

string

Numeric dollar value

No

purchase_stamp_duty

string

Sets Purchase Stamp Duty and lock flag

No

fbt_value

string

Sets FBT Value and lock flag

No

date_first_held

string

date (yyyy-mm-dd)

No

luxury_car_tax_paid_flag

string

yes or no

No

supplier_id_financier

string

Alternative Financier. Must map to Supplier with 'Supplier Type'='Financier'.

No

Driver Element

Key

Format

Notes

Mandatory

driver

string

Complex object with addresses (home/post), contact details, financial info

No

Insurance & Inclusions

Key

Format

Notes

Mandatory

insurance

string

Supplier ID, insurance type, billing, excess, annual amount, fund flag, monthly amount, included flag

No

roadside_assistance

string

Plan ID, premium, cost, monthly amount, included flag

No

relief_vehicle

string

Monthly amount, included flag

No

vehicle_maintenance_program

string

Monthly amount, included flag

No

lti

string

Top up benefit ID, retail price, included flag

No

small_damage_repairs

string

Small damage repairs ID, premium, monthly amount, included flag

No

redundancy_insurance_flag

string

yes or no

No

carbon_emissions_offset

string

Included flag

No

walkaway

string

Walkaway plan ID, included flag

No

tyre_rim_insurance

string

Tyre rim insurance plan ID, included flag

No

inclusion_plans

string

Array of inclusion code, plan code, qualified code, retail price, included flag. Name an Inclusion by inclusion_plan_code_qualified, or by inclusion_code with inclusion_plan_code. If included_flag is left out, the Inclusion is included. Contract Type rules apply: see [createQuote: Inclusion Rules by Contract Type]. Pricing and plan set-up: see Lease Inclusion Plans.

No

Contract Type Inclusion Rules

When a quote is created, Catch-e applies the Contract Type's Inclusion settings. These rules apply to every Contract Type. They do not apply when copying an existing quote.

Unavailable Inclusions

  • If the request names an Inclusion the Contract Type marks as unavailable, the request is rejected and no quote is created.

  • This applies however the Inclusion is named (inclusion code, plan code or qualified code) and whatever the included flag says.

Client and vehicle exclusions

  • If the request names an Inclusion that is excluded for the quote's client, or for the vehicle's make, model or variant, the request is rejected and no quote is created.

  • This applies however the Inclusion is named and whatever the included flag says.

Preselected Inclusions

  • If a Preselected Inclusion has one applicable plan and the request doesn't mention it, it is added to the quote automatically.

  • If the request mentions a Preselected Inclusion, including or excluding it, the request is applied as sent.

  • If a Preselected Inclusion has more than one applicable plan, the request must select a plan for it or exclude it. Otherwise the request is rejected and no quote is created.

  • Where the Inclusion has more than one active plan version, the request must name a plan, not just the inclusion code.

  • A Preselected Inclusion excluded for the client or vehicle is never added automatically.

  • Suspended Inclusions and inactive plan versions are never added automatically.

  • When Inclusions are added automatically, an audit note is recorded on the quote. It is not returned in the response.

Excluding an Inclusion

  • Excluded by inclusion_code: the Inclusion is left off the quote.

  • Excluded by inclusion_plan_code_qualified: the Inclusion is stored on the quote with an included flag of "no".

Applicable plans

A plan is applicable when it is active, its effective date is on or before the quote's effective date (or it has no effective date), and its term and vehicle value ranges include the quote's term and vehicle value. A plan that has been re-priced over time counts once.

Input Example

This example displays most of the available input fields. For complete list please visit api.catch-e.com/docs/#/Quotes/createQuotes

[ { "override_warnings_flag": "no", "duration": "30", "quote_status_id": "100007", "deal_type_id": "100000", "posting_map_id": "100023", "term": "60", "annual_kms": "15000", "contract_kms": "75000", "state": "NSW", "cost_centre": "MATT CC1", "division": "MATT DIV1", "location_name": "Metro", "delivery_location_type": "country", "vehicle_tracking_system_flag": "yes", "parent_quote_id": "135553", "opportunity_id": "123456789101112131", "opportunity_number": "100000", "opportunity_stage_id": "100000", "lock_quote_flag": "no", "client_id": "100290", "client_name": "Client Name Alternative for Quote", "client_contact_name": "Your Quote Consultant Name", "client_email": "email.address@client.com.au", "client_phone": "03 9999 8881", "client_fax": "03 9017 3521", "user_id_client_manager": "10000", "after_hours_assistance_flag": "yes", "comments": "Bonus expires on 01/01/2025\r\n(this will display on the 2nd row in Catch-e APP).", "gap_insurance_flag": "yes", "comments_internal": "Internal Notes will not be shown to external users", "driver_id": "101151", "driver_surname": "Eyes", "driver_given_name": "Blue", "driver_email": "email.address@client.com.au", "driver_phone": "0400000000", "driver_fax": "03 9017 3522", "insurance_loading_types": { "past_claims": { "insurance_loading_type_id": "100000" }, "licence": { "insurance_loading_type_id": "100005" }, "driver_restriction": { "insurance_loading_type_id": "100008" } }, "insurance_loss_licence_flag": "yes", "insurance_at_fault_flag": "yes", "insurance_conviction_flag": "yes", "user_id_assigned": "10000", "pay_cycle_id": "100002", "annual_salary": "90000", "employer_fbt_type": "full-fbt-payable", "fbt_benefit_type": "statutory", "fbt_business_use": "60", "ecm_flag": "yes", "previous_lease_start": "2024-01-01", "previous_fbt_value": "80000", "driver": { "accountant_contact_name": "Accountant name", "accountant_contact_phone": "03 9999 8881", "accountant_firm_name": "Accountant Firm", "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" } }, "allowances": "10", "annual_salary": "90000", "asset_bank_accounts": "10000", "asset_bank_accounts_description": "Bank Asset", "asset_furniture": "10000", "asset_furniture_description": "furniture", "asset_investment_properties": "10000", "asset_investment_properties_description": "investment home", "asset_motor_vehicle": "10000", "asset_motor_vehicle_description": "car", "asset_other_investments": "10000", "asset_other_investments_description": "other invest", "asset_resident_property": "10000", "asset_resident_property_description": "home description", "asset_shares": "10000", "asset_shares_description": "shares", "asset_super": "10000", "asset_super_description": "super", "ato_loan_flag": "yes", "australian_resident": "yes", "card_account_number": "111122223333", "client_cost_centre_id": "100430", "client_id": "100290", "contact_note": "contact note", "corporate_type_id_previous_employer": "100000", "created": "2024-05-03 12:17:25", "credit_check_authorised_flag": "yes", "date_of_birth": "1997-02-10", "driver_claims_flag": "yes", "driver_employment_type_id": "100002", "driver_id_external": "100000", "driver_lic_exp": "2050-01-01", "driver_licence": "LIC 049999999", "driver_licence_state": "NSW", "driver_occupation_code_id": "100000", "employee_alias": "Alias name", "employee_area": "55555", "employee_end": "2099-12-31", "employee_group": "333", "employee_no": "EMP 222333", "employee_pay_office": "55555", "employee_sl_acc": "10000", "employee_start": "2000-01-01", "employee_super": "0", "employer_address_1": "employer address 1", "employer_address_2": "employer address 1", "employer_address_3": "employer address 3", "employer_address_postcode": "3000", "employer_address_state": "VIC", "employer_super": "0", "expense_credit_card": "10000", "expense_household": "10000", "expense_mortgage": "10000", "expense_other": "10000", "expense_private_education_childcare": "10000", "expense_rent": "10000", "expense_vehicle": "10000", "external_code": "driverExternal1", "fbt_type": "1", "financier_applicant_reference": "appRef", "gender": "Male", "generated_password": "0", "given_name": "Blue", "home_car_postcode": "3000", "home_email": "email.address@client.com.au", "home_fax": "03 9999 8882", "home_phone": "0400000000", "home_postcode": "2000", "home_state": "NSW", "home_street": "333", "home_street_no": "55555", "home_street_type": "home_street_type", "home_suburb": "home_suburb", "home_unit_no": "55555", "income_government_benefits": "10000", "income_gross": "100000", "income_investment": "10000", "income_net": "10000", "income_other": "10000", "income_rental_net": "10000", "income_spouse_gross": "10000", "income_spouse_net": "10000", "income_superannuation": "10000", "insurance_broker_fee_exempt_flag": "yes", "kyc_verified_flag": "no", "landlord_name": "landlord_name", "landlord_telephone": "03 9999 8881", "last_edit": "2024-05-03 12:17:25", "liability_credit_card_limit": "10000", "liability_credit_card_limit_description": "liability_credit_card_limit_description", "liability_investment_mortgages": "10000", "liability_investment_mortgages_description": "liability_investment_mortgages_desc", "liability_loans": "10000", "liability_loans_description": "liability_loans_description", "liability_mortgages": "10000", "liability_mortgages_description": "liability_mortgages_description", "liability_other": "10000", "liability_other_description": "liability_other_description", "liability_overdraft": "10000", "liability_overdraft_description": "liability_overdraft_description", "liability_rent": "10000", "liability_rent_description": "10000", "licence_class": "licence_class", "marital_status": "married", "middle_name": "middle_name", "mobile": "0411662453", "name_on_account": "name_on_account", "no_of_dependents": "0", "pay_cycle_id": "100002", "preferred_name": "preferred_name", "previous_address_1": "previous_address_1", "previous_address_2": "previous_address_2", "previous_address_3": "previous_address_3", "previous_address_country_id": "16238953344683478812", "previous_address_postcode": "3000", "previous_address_state": "VIC", "previous_address_years_at_address": "0", "previous_employer_name": "previous_employer_name", "previous_employer_phone": "03 9999 8881", "previous_years_employed": "0", "report_delivery_type": "email", "residency_status": "permanent-resident", "residential_status": "own", "salutation": "Mr", "start_at_address": "2000-01-01", "stop_becs_flag": "no", "supplier_id_etag": "100475", "supplier_id_financier": "100492", "surname": "Eyes", "tag_account_number": "123456789", "tag_number": "9999999999", "user_id_package_advisor": "10000", "work_contact_given": "The Bossman", "work_contact_position": "BigWig", "work_contact_surname": "work_contact_surname", "work_fax": "03 9999 8882", "work_name": "work_name", "work_phone": "0400000000", "work_phone_ext": "1234", "work_position": "work_position", "work_postcode": "3000", "work_state": "VIC", "work_street": "work_street", "work_street_no": "55555", "work_street_type": "work_street_type", "work_suburb": "work_suburb", "work_type": "work_type", "work_unit_no": "55555", "years_at_address": "0", "years_with_employer": "0", "override_warnings_flag": "no" }, "variant_id": "184796", "plate_year": "2022", "new_used": "new", "procurement_flag": "yes", "procurement_fee": "500", "disposal_flag": "yes", "disposal_fee": "400", "odometer": "10", "warranty_mths": "60", "warranty_kms": "77777", "colour_preference": "Fbt Value Should stay LOCKED", "colour_preference_2": "BLUE1 (BLUE2 - BLUE4)", "colour_preference_3": "BLUE1 (BLUE2 - BLUE4)", "colour_preference_note": "Test Colour API-20415", "trim_preference": "Trrim", "supplier_id_dealer": "100001", "dealer_comment": "dealer comments", "discount_type_id": "100001", "list_price_net": "30302.73", "list_price_gst": "3030.27", "lock_discount_flag": "yes", "discount_net": "1", "discount_gst": "0.1", "rebate_net": "2", "rebate_gst": "0.2", "dealer_rebate_net": "3", "dealer_rebate_gst": "0.3", "bonus_amount_net": "201", "bonus_amount_gst": "20.1", "lock_dealer_discount_flag": "yes", "dealer_discount_net": "4", "dealer_discount_gst": "0.4", "margin_net": "5", "margin_gst": "0.5", "dealer_delivery_net": "60.01", "dealer_delivery_gst": "600.01", "lock_luxury_car_tax_flag": "yes", "luxury_car_tax": "294.68", "ctp_initial_net": "560", "ctp_initial_gst": "0", "reg_initial_net": "482", "premium_plates_net": "80", "lock_purchase_stamp_duty_flag": "yes", "purchase_stamp_duty": "3000", "lock_fbt_value_flag": "yes", "fbt_value": "77995.36", "fbt_treatment_type": "standard", "price_comment": "price comments", "pricing_requested": "2024-05-03 12:17:25", "pricing_received": "2024-05-03 12:17:25", "pricing_reference": "price ref", "optional_equipment": [ { "optional_equipment_id": "271573", "description": "Enhanced Autopilot", "cost_price_net": "6027.27", "list_price_net": "30302.73", "discount_net": "1.00", "gst": "602.73", "residual_rate": "0", "included_flag": "yes" } ], "supplier_id_financier": "100492", "finance_type_id": "100000", "deposit_net": "181.82", "deposit_gst": "18.18", "trade_in_reg_no": "TRADEIN", "trade_in_amount_net": "272.73", "trade_in_amount_gst": "27.27", "originator_id": "100006", "application_reference": "App Test 1-1", "application_date": "2024-05-03 12:17:25", "application_status_flag": "successful", "maintenance_service": { "included_flag": "yes", "maintenance_service_profile_id": "100013", "service_mths": "12", "service_kms": "15000", "monthly_amount_net": "50.01" }, "tyres": { "included_flag": "yes", "tyre_id": "100002", "tyres_per_set": "4", "tyre_km_interval": "40001", "unit_cost_net": "400.01", "tyres_estimated": "4", "limit_flag": "yes", "monthly_amount_net": "27.59" }, "reg_ctp": { "included_flag": "yes", "annual_reg": "482.01", "annual_ctp": "560.01", "annual_plates": "10.01", "renewals": "4", "monthly_amount_net": "79.04" }, "insurer_location_id": "100021", "policy_owner_type": "insurer_internal", "lock_comprehensive_insurance_flag": "no", "insurance": { "included_flag": "yes", "supplier_id": "100453", "billing_type": "monthly", "insurance_type_id": "100003", "claim_excess": "500.01", "annual_insurance": "3073.08", "fund_1st_year_flag": "no", "monthly_amount_net": "211.93" }, "fuel": { "included_flag": "yes", "fuel_type_id": "100001", "cost_per_litre": "1.45", "usage_type": "combined", "litres_per_100km": "7.1", "monthly_amount_net": "133.14" }, "roadside_assistance": { "included_flag": "yes", "roadside_assistance_plan_id": "100006", "premium": "72.01", "cost": "60.01", "monthly_amount_net": "6.21" }, "relief_vehicle": { "included_flag": "yes", "monthly_amount_net": "20.69" }, "vehicle_maintenance_program": { "included_flag": "yes", "monthly_amount_net": "2.62" }, "lti": { "included_flag": "yes", "lti_top_up_benefit_id": "100002", "retail_price_gross": "1700.01" }, "small_damage_repairs": { "small_damage_repairs_id": "100004", "included_flag": "yes", "premium": "997.12", "monthly_amount_net": "0.00" }, "redundancy_insurance_flag": "no", "carbon_emissions_offset": { "included_flag": "yes" }, "walkaway": { "included_flag": "yes", "walkaway_plan_id": "100000" }, "tyre_rim_insurance": { "included_flag": "yes", "tyre_rim_insurance_plan_id": "100001" }, "inclusion_plans": [ { "included_flag": "yes", "inclusion_code": "MP", "inclusion_plan_code": "MP1", "inclusion_plan_code_qualified": "MP-MP1-0000-00-00", "retail_price_gross": "707.06" } ], "bespoke_field_values": {} } ]

Response Details

201 Created

The request was successful.

{ "quote_id": "135725", "accepted_count": null, "accident_management_fee": { "included_flag": "yes" }, "advance_arrears": "advance", "after_hours_assistance_flag": "no", "allowances": 0, "annual_salary": 90000, "application_collection_date": "0000-00-00", "application_date": null, "application_reference": "", "application_status": "", "application_status_flag": null, "arrears_interest": 0, "ato_loan_flag": "no", "base_rate": 0.0625, "base_residual_rate": 0, "bespoke_field_values": { "bespoke_field_name": "", "field_name_1": "no", "field_name_2": "", "field_name_3": "", "input_type_checkbox": "", "input_type_date": "", "input_type_listbox": "", "input_type_number": "", "input_type_textarea": "", "input_type_text_20_characters": "" }, "billing_periods": 60, "bonus_amount_gst": 0, "bonus_amount_net": 0, "broker_fee": 0, "broker_rate": 0, "budgets": { "AMFEE": { "posting_class_id": "100119", "amount_net": 0, "amount_gst": 0, "total_amount_net": 0, "total_amount_gst": 0, "notes": "Included" }, "CEO": { "posting_class_id": "100065", "amount_net": 5.52, "amount_gst": 0.55, "total_amount_net": 331.2, "total_amount_gst": 33, "notes": "Included" }, "F": { "posting_class_id": "100004", "amount_net": 232, "amount_gst": 23.2, "total_amount_net": 13920, "total_amount_gst": 1392, "notes": "Included" }, "FIN": { "posting_class_id": "100006", "amount_net": 1487.82, "amount_gst": 148.78, "total_amount_net": 89269.2, "total_amount_gst": 8926.8, "notes": "Included" }, "INS": { "posting_class_id": "100009", "amount_net": 200.6, "amount_gst": 19.13, "total_amount_net": 12036, "total_amount_gst": 1147.8, "notes": "Included" }, "REG": { "posting_class_id": "100017", "amount_net": 76.41, "amount_gst": 7.64, "total_amount_net": 4584.6, "total_amount_gst": 458.4, "notes": "Included" }, "T": { "posting_class_id": "100021", "amount_net": 53.33, "amount_gst": 5.33, "total_amount_net": 3199.8, "total_amount_gst": 319.8, "notes": "4 Included" } }, "budgets_financed": 0, "cancelled": "0000-00-00 00:00:00", "capitalised_interest": 0, "carbon_emissions_offset": { "included_flag": "yes" }, "claimable_gst": 6191, "client_contact_name": "", "client_cost_centre_id": "0", "client_division_id": "0", "client_email": "", "client_fax": "", "client_group_flag": "no", "client_id": "100206", "client_margin_net": 0, "client_margin_rate": 0, "client_name": "", "client_phone": "", "client_residual_rate": 0, "client_type": "", "colour_preference": "", "colour_preference_2": "", "colour_preference_3": "", "colour_preference_note": "", "comments": "", "comments_internal": null, "commission": 96.72, "commission_rate": 0.001, "competitor_id": "0", "competitor_margin_id": "0", "comprehensive_insurance": 0, "contract_kms": 75000, "cost_centre": "", "created": "2024-05-02 23:52:33", "csd_gst": 0, "csd_net": 0, "csd_rate": 0, "ctp_initial_gst": 0, "ctp_initial_net": 560, "date": "2024-05-02", "date_to": "2024-06-01", "deal_type_id": "0", "dealer_comment": null, "dealer_delivery_gst": 77.78, "dealer_delivery_net": 777.77, "dealer_discount_gst": 0, "dealer_discount_net": 0, "dealer_rebate_gst": 0, "dealer_rebate_net": 0, "deferred_interest": 0, "delivery_fee": 0, "delivery_location_type": "metro", "deposit_gst": 0, "deposit_net": 0, "depreciable_amount": 96720.81, "discount_gst": 0, "discount_name": "", "discount_net": 0, "discount_type_id": "0", "disposal_fee": 0, "disposal_flag": "no", "division": "", "driver": null, "driver_email": "", "driver_fax": null, "driver_given_name": "", "driver_id": null, "driver_phone": null, "driver_surname": "Surname", "duration": 30, "early_termination_fee": null, "ecm_flag": "yes", "employer_fbt_type": "full-fbt-payable", "establishment_fee": 0, "establishment_fee_funded_flag": "yes", "excess_km_flag": "no", "excess_km_rate": 0, "extended_warranty": { "warranty_plan_id": "0", "warranty_category_id": "0", "months": 0, "kilometres": 0, "rate": 0, "retail_price_net": 0, "cost": 0, "margin_net": 0, "financed_flag": "no", "included_flag": "no" }, "fbt_benefit_type": "statutory", "fbt_business_use": 0, "fbt_statutory_rate": 0.2, "fbt_treatment_type": "standard", "fbt_value": 97874.81, "fbt_value_yearly": 19138.32, "finance_administration_fee_gst": 0, "finance_administration_fee_net": 0, "finance_method": "arrears_no_deferred", "finance_pmt_gst": 148.78, "finance_pmt_net": 1487.82, "finance_rate": 0.0625, "finance_type_id": null, "finance_uuid": "", "financed_amount": 96817.53, "fuel": { "fuel_type_id": "100001", "cost_per_litre": 1.45, "usage_type": "combined", "litres_per_100km": 12.8, "included_flag": "yes" }, "fuel_on_delivery_fee": null, "gap_insurance": 0, "gap_insurance_flag": "yes", "gst_on_interest": 0, "high_km_adjustment_rate": 0, "inclusion_plan_total": 0, "inclusion_plans": [], "insurance": { "supplier_id": "100453", "insurance_type_id": "100004", "billing_type": "monthly", "claim_excess": 1000, "base_rate_annual": 0, "broker_fee_monthly": 23, "broker_fee_annual": 0, "loading_rate": 0, "loading_rate_flag": "not-applicable", "stamp_duty": 9.26, "fire_service_levy": 1.67, "annual_insurance": 2407.2, "fund_1st_year_flag": "no", "cost": 166.67, "category_code": "-----", "included_flag": "yes" }, "insurance_at_fault_flag": null, "insurance_conviction_flag": null, "insurance_disclosures": { "100000": { "insurance_disclosures_id": "100000", "value": null }, "100001": { "insurance_disclosures_id": "100001", "value": null }, "100002": { "insurance_disclosures_id": "100002", "value": null }, "100003": { "insurance_disclosures_id": "100003", "value": null }, "100004": { "insurance_disclosures_id": "100004", "value": "0000-00-00" } }, "insurance_loading_types": [], "insurance_loss_licence_flag": null, "insurer_location_id": "100021", "insurer_location_postcode": 2000, "interest_on_residual": 0, "last_edit": "2024-05-02 23:52:34", "lessee_rate": 0.062849, "list_price_gst": 8380.95, "list_price_net": 83809.51, "location_name": "", "location_registration_id": "100001", "lock_comprehensive_insurance_flag": "no", "lock_dealer_discount_flag": "no", "lock_discount_flag": "no", "lock_fbt_value_flag": "no", "lock_lease_rate_flag": "no", "lock_luxury_car_tax_flag": "no", "lock_purchase_stamp_duty_flag": "no", "lock_quote_flag": "no", "lock_redundancy_insurance_flag": "no", "lock_residual_flag": "no", "look_ahead": 0, "lti": { "lti_plan_id": "0", "lti_top_up_benefit_id": "0", "external_quotation_number": "0", "retail_price_net": 0, "retail_price_gross": 0, "cost_price_net": 0, "margin_net": 0, "retail_price_gst": 0, "retail_price_stamp_duty": 0, "request_date": "0000-00-00", "included_flag": "no" }, "luxury_car_tax": 4828.8, "luxury_car_tax_exempt_flag": "no", "luxury_charge": 1514.09, "maintenance_service": { "maintenance_service_profile_id": "100024", "service_kms": 10000, "service_mths": 6, "included_flag": "yes" }, "margin_gst": 0, "margin_net": 0, "months_in_arrears": 0, "mortgage_duty": 0, "new_used": "new", "odometer": 0, "on_road_price_gst": 8458.73, "on_road_price_net": 94453.08, "opportunity_id": "0", "opportunity_number": 0, "opportunity_stage_id": "0", "optional_equipment": [], "optional_equipment_gst": 0, "optional_equipment_net": 0, "originator_fee": 0, "originator_id": "0", "other_brokerage": 0, "package_admin_fee": 0, "packaging_advice_fee": 0, "parent_quote_id": null, "pay_cycle_billing_periods": 65, "pay_cycle_id": "100007", "periods_deferred": 0, "plate_year": 2024, "policy_owner_type": "insurer_internal", "post_tax_existing": 0, "posting_map": { "posting_map_id": "100023", "1link_scheme_id": "0", "insurance_group_id": "0", "posting_map_code": "NOFB", "posting_map_group": "novated", "supplier_id_financier": "100462", "name": "Novated Fully Budgeted", "auto_extend_flag": "no", "sl_export_flag": "yes", "billing_adjustments_itemised_flag": "yes", "1link_export_flag": "no", "gst_code_id_residual": "100000", "gst_on_finance_payment_method": "standard", "quote_template": "quote_novated.zip", "url": "", "template_id_fbt_statutory": "100021", "template_id_fbt_operating": "100004", "fbt_email": "yes", "driver_pack_flag": "no", "package_item_profile_car_id": "11989493400773612513", "order_invoice_to": "", "order_delivery_for": "", "order_registration_to": "", "order_registration_notification_to": "", "mail_to_quote_request": "demo@catch-e.com.au", "residual_reserve": 0, "documentation_fee_rate_flag": "no", "include_client_establishment_fee_flag": "yes", "quote_procurement_fee_flag": "yes", "quote_redundancy_insurance_flag": "no", "apply_redundancy_insurance_validation_flag": "yes", "quote_maximum_payload": 0, "quote_excess_km_rate_flag": "no", "approval_note": "", "comprehensive_insurance_fund_1st_year_flag": "no", "insurance_rating_type": "client", "order_manager_as_assigned_flag": "no", "driver_contract_access_flag": "yes", "disclose_running_costs_flag": "yes", "insurance_loading_flag": "yes", "validate_amount_financed_flag": "no", "depreciable_amount_ex_regctp_flag": "yes", "finance_payments_at_cof_flag": "yes", "budgets_financed_flag": "no", "payout_sub_page_flag": "yes", "claim_sub_page_flag": "yes", "funds_check_on_claim_sub_page_flag": "yes", "auto_post_claims_flag": "yes", "funds_check_on_reg_ctp_flag": "yes", "allow_external_approvals_flag": "yes", "service_due_overdue_report_flag": "yes", "residual_value_risk_type_id": "0", "maintenance_risk_type_id": "0", "quote_note": "", "status_flag": "active" }, "posting_map_id": "100023", "pre_tax_existing": 0, "premium_plates_net": 0, "previous_fbt_value": 0, "previous_lease_start": "0000-00-00", "price_comment": null, "pricing_received": "0000-00-00 00:00:00", "pricing_reference": "", "pricing_requested": "0000-00-00 00:00:00", "procurement_fee": 500, "procurement_flag": "yes", "purchase_stamp_duty": 3995, "purchase_stamp_duty_exempt_flag": "no", "quote_date": "2024-05-02", "quote_status": { "quote_status_id": "100007", "description": "sent", "active_flag": "yes", "status_flag": "active" }, "quote_status_id": "100007", "quote_sub_status_id": "0", "rebate_gst": 0, "rebate_net": 0, "reduced_super_flag": "no", "redundancy_insurance": 0, "redundancy_insurance_cost": 0, "redundancy_insurance_flag": "no", "redundancy_insurance_rate": 0, "redundancy_insurance_validation_flag": "yes", "reg_ctp": { "annual_reg": 482, "annual_ctp": 560, "annual_plates": 0, "renewals": 4, "included_flag": "yes" }, "reg_initial_net": 482, "relief_vehicle": { "included_flag": "yes" }, "residual_basis": "depreciable-amount", "residual_cash_pool_gst": 0, "residual_cash_pool_net": 0, "residual_cash_pool_rate": null, "residual_gst": 2720.76, "residual_insurance": 0, "residual_insurance_rate": null, "residual_net": 27207.56, "residual_rate": 0.2813, "residual_rate_gross": 0, "residual_rate_net": 0, "revs_fee": 0, "roadside_assistance": { "roadside_assistance_plan_id": "0", "premium": 0, "cost": 0, "included_flag": "no" }, "small_damage_repairs": { "small_damage_repairs_id": "0", "months": 0, "premium": 0, "cost": 0, "financed_flag": "yes", "included_flag": "no" }, "state": "NSW", "status_flag": "sent", "superannuation": 0, "supplier_id_broker": "100454", "supplier_id_dealer": "0", "supplier_id_financier": "100467", "supplier_id_insurer": "100453", "supplier_id_residual_insurer": "0", "term": 60, "total_brokerage": 96.72, "trade_in_amount_gst": 0, "trade_in_amount_net": 0, "trade_in_reg_no": "", "trade_in_vehicle_description": "", "trim_preference": "", "tyre_rim_insurance": { "tyre_rim_insurance_plan_id": "0", "retail_price_net": 0, "retail_price_gross": 0, "cost_price_net": 0, "margin_net": 0, "included_flag": "no" }, "tyre_rim_insurance_flag": "no", "tyres": { "tyre_id": "100667", "tyres_per_set": 4, "tyre_km_interval": 45001, "unit_cost_net": 800, "limit_flag": "yes", "tyres_estimated": 4, "included_flag": "yes" }, "usage_adjustment_rate": 0, "user_id_assigned": "10000", "user_id_client_manager": "10000", "user_id_create": "10000", "user_id_last_edit": "10000", "variant_adjustment_rate": 0, "variant_bonus_id": null, "variant_id": "184796", "vehicle_maintenance_program": { "included_flag": "no" }, "vehicle_tracking_system_flag": null, "vehicle_usage_type_id": "100000", "walkaway": { "walkaway_plan_id": "0", "retail_price_net": 0, "retail_price_gross": 0, "cost_price_net": 0, "margin_net": 0, "included_flag": "no" }, "walkaway_flag": "no", "warrant_of_fitness": { "annual_warrant_of_fitness": 100, "renewals": 3, "included_flag": "yes" }, "warranty_kms": 0, "warranty_mths": 60, "web_service_initial_edit_flag": "no", "_links": { "self": { "href": "https://api.test.catch-e.com/qt/quotes/135725" } } }

401 Unauthorized

{ "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 ensure the permission is checked.

422 Unprocessable Entity

Invalid Client ID:

{ "client_id": { "noRecordFound": "No record matching the input was found" } }

Invalid Client ID.

Missing posting_map_id:

{ "posting_map_id": { "isEmpty": "Value is required and can't be empty" } }

posting_map_id is required.

client_name too long:

{ "client_name": { "stringLengthTooLong": "The input is more than 100 characters long" } }

client_name must be 100 characters or less. Pass a shorter name.

Client quoting disabled:

{ "client_id": { "clientQuotingDenied": "Client not profiled for quoting. Refer to management." } }

Clients / Quote Defaults "Allow Quoting" is unchecked.

Conflicting driver specification:

{ "driver_id": { "callbackInvalid": "You cannot specify both the driver_id field and driver element" } }

If you specify a driver_id, the driver is assumed pre-configured with all details including addresses. Do not include the driver object; doing so causes a conflict.

Invalid odometer for used vehicle:

{ "new_used": { "invalidOdometer": "When vehicle is 'used' or 'demonstrator', odometer must be greater than zero" } }

Input field "odometer" is missing. This only applies if NEW_USED is not 'new' (e.g., 'used' or 'demonstrator').

Unrecognized field:

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Unrecognized fields: carbon_emission_offset" }

Unknown issue with field name. Check for typos or unsupported fields.

Driver not found:

{ "validation_messages": { "driver_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" }

Driver ID does not exist.

Response Details > 422 Unprocessable Entity

Add the following after the existing Driver not found example, in the same format.

Inclusion not available for the Contract Type:

json

{ "validation_messages": { "[field to be confirmed]": { "[key to be confirmed]": "[message to be confirmed]" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

The Contract Type marks this Inclusion as unavailable.

Inclusion excluded for the client:

json

{ "validation_messages": { "[field to be confirmed]": { "inclusionClientExcluded": "[message to be confirmed]" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

The Inclusion is excluded for the quote's client.

Inclusion excluded for the vehicle:

json

{ "validation_messages": { "[field to be confirmed]": { "inclusionVehicleExcluded": "[message to be confirmed]" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

The Inclusion is excluded for the vehicle's make, model or variant.

Preselected Inclusion needs a plan:

json

{ "validation_messages": { "[field to be confirmed]": { "[key to be confirmed]": "[message to be confirmed]" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

A Preselected Inclusion has more than one applicable plan. Select a plan for it or exclude it.

Was this helpful?

Still need help? Ask the team