Quotes

Get quote

This method requires the Quotes:Get permission to be associated with your role.

GET

/qt/quotes/{quote_id}

Get quote

curl --request GET \
  --url https://api.catch-e.com/qt/quotes/{quote_id} \
  --header 'Authorization: <api-key>' \
  --header 'Time-Zone: UTC'

{
  "accepted_count": 123,
  "accident_management_fee": {
    "included_flag": "yes"
  },
  "advance_arrears": "advance",
  "after_hours_assistance_flag": "no",
  "allowances": 123,
  "annual_kilometers": 123,
  "annual_salary": 123,
  "application_collection_date": "YYYY-MM-DD",
  "application_date": "YYYY-MM-DD HH:MM:SS",
  "application_reference": "<string>",
  "application_status": "<string>",
  "application_status_flag": "<string>",
  "arrears_interest": 123,
  "ato_loan_flag": "no",
  "base_rate": 123,
  "base_residual_rate": 123,
  "bespoke_field_values": {},
  "billing_periods": 123,
  "bonus_amount_gst": 123,
  "bonus_amount_net": 123,
  "broker_fee": 123,
  "broker_rate": 123,
  "budgets": [
    {
      "amount_gst": 123,
      "amount_net": 123,
      "notes": "<string>",
      "posting_class_id": "<string>",
      "total_amount_gst": 123,
      "total_amount_net": 123
    }
  ],
  "budgets_financed": 123,
  "cancelled": 123,
  "capitalised_interest": 123,
  "carbon_emissions_offset": {
    "included_flag": "yes"
  },
  "claimable_gst": 123,
  "client_contact_name": "<string>",
  "client_cost_centre_id": "<string>",
  "client_division_id": "<string>",
  "client_email": "jsmith@example.com",
  "client_fax": "<string>",
  "client_group_flag": "no",
  "client_id": "<string>",
  "client_margin_net": 123,
  "client_margin_rate": 123,
  "client_name": "<string>",
  "client_phone": "<string>",
  "client_residual_rate": 123,
  "client_type": "<string>",
  "colour_preference": "<string>",
  "colour_preference_2": "<string>",
  "colour_preference_3": "<string>",
  "colour_preference_note": "<string>",
  "comments": "<string>",
  "comments_internal": "<string>",
  "commission": 123,
  "commission_rate": 123,
  "competitor_id": "<string>",
  "competitor_margin_id": "<string>",
  "comprehensive_insurance": 123,
  "contract_kms": 123,
  "cost_centre": "<string>",
  "csd_gst": 123,
  "csd_net": 123,
  "csd_rate": 123,
  "ctp_initial_gst": 123,
  "ctp_initial_net": 123,
  "date": "YYYY-MM-DD",
  "date_first_held": "YYYY-MM-DD",
  "date_to": "YYYY-MM-DD",
  "deal_type_id": "<string>",
  "dealer_comment": "<string>",
  "dealer_delivery_gst": 123,
  "dealer_delivery_net": 123,

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Path Parameters

quote_idstringrequired

Quote Id

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]*$

Headers

Time-Zonestringheaderdefault:UTC

Quote will be returned in the specified timezone.

The timezone value can be given in several formats, none of which are case sensitive:

As a named time zone, such as 'Europe/Helsinki', 'US/Eastern', or 'MET'.
As a string indicating an offset from UTC of the form [H]H:MM, prefixed with a + or -, such as '+10:00', '-6:00', or '+05:30'. A leading zero can optionally be used for hours values less than 10;

Maximum string length: 100

Pattern: ^[a-zA-Z0-9\/\:\+\-\_]+$

Response

Success

accepted_countnumber

accident_management_feeobject

Show child attributes

advance_arrearsenum<string>

Available options: advance, arrears

after_hours_assistance_flagenum<string>default:no

Available options: yes, no

allowancesnumber

annual_kilometersnumberrequired

annual_salarynumberrequired

application_collection_datestring

Example: YYYY-MM-DD

application_datestring

Example: YYYY-MM-DD HH:MM:SS

application_referencestring

application_statusstring

application_status_flagstring

arrears_interestnumber

ato_loan_flagenum<string>default:no

Available options: yes, no

base_ratenumber

base_residual_ratenumber

bespoke_field_valuesobject

billing_periodsnumber

bonus_amount_gstnumber

bonus_amount_netnumber

broker_feenumber

broker_ratenumber

budgetsobject[]

Budget

Show child attributes

budgets_financednumber

cancellednumber

capitalised_interestnumber

carbon_emissions_offsetobject

Show child attributes

claimable_gstnumber

client_contact_namestring

client_cost_centre_idstring

client_division_idstring

client_emailstring

client_faxstring

client_group_flagenum<string>default:no

Available options: yes, no

client_idstringrequired

client_margin_netnumber

client_margin_ratenumber

client_namestring

client_phonestring

client_residual_ratenumber

client_typestring

colour_preferencestring

colour_preference_2string

colour_preference_3string

colour_preference_notestring

commentsstring

comments_internalstring

commissionnumber

commission_ratenumber

competitor_idstring

competitor_margin_idstring

comprehensive_insurancenumber

contract_kmsnumber

cost_centrestring

csd_gstnumber

csd_netnumber

csd_ratenumber

ctp_initial_gstnumber

ctp_initial_netnumber

datestring

Example: YYYY-MM-DD

date_first_heldstring

Example: YYYY-MM-DD

date_tostring

Example: YYYY-MM-DD

deal_type_idstring

dealer_commentstring

dealer_delivery_gstnumber

dealer_delivery_netnumber

dealer_discount_gstnumber

dealer_discount_netnumber

dealer_rebate_gstnumber

dealer_rebate_netnumber

deferred_interestnumber

delivery_feenumber

delivery_location_typeenum<string>

Available options: country, semi-metro, metro

deposit_gstnumber

deposit_netnumber

depreciable_amountnumber

discount_gstnumber

discount_namestring

discount_netnumber

discount_type_idstring

disposal_feenumber

disposal_flagenum<string>default:no

Available options: yes, no

divisionstringrequired

driver_emailstring

(Optional) Will be populated from Driver object (if specified)

driver_faxstring

(Optional) Will be populated from Driver object (if specified)

driver_given_namestring

(Optional) Will be populated from Driver object (if specified)

driver_idstring

(Optional) Id of existing driver record

driver_phonestring

(Optional) Will be populated from Driver object (if specified)

driver_surnamestring

(Optional) Will be populated from Driver object (if specified)

durationnumber

early_termination_feenumber

ecm_flagenum<string>default:no

Available options: yes, no

employer_fbt_typeenum<string>default:full-fbt-payable

Available options: concessional-30000-exempt, concessional-17000-exempt, rebatable, full-fbt-payable, not-applicable

establishment_feenumber

establishment_fee_funded_flagenum<string>default:yes

Available options: yes, no

excess_km_flagenum<string>default:no

Available options: yes, no

excess_km_ratenumber

extended_warrantyobject

Show child attributes

fbt_benefit_typeenum<string>default:statutory

Available options: statutory, operating, exempt

fbt_business_usenumber

fbt_statutory_ratenumber

fbt_treatment_typeenum<string>

Available options: standard, ev-exempt-reportable

fbt_valuenumber

fbt_value_yearlynumber

finance_administration_fee_gstnumber

finance_administration_fee_netnumber

finance_methodenum<string>default:future-value

Available options: future-value, arrears_no_deferred

finance_pmt_gstnumber

finance_pmt_netnumber

finance_ratenumber

finance_type_idstring

finance_uuidstring

financed_amountnumber

fuelobject

Show child attributes

fuel_on_delivery_feenumber

gap_insurancenumber

gap_insurance_flagenum<string>default:yes

Available options: yes, no

gst_on_interestnumber

high_km_adjustment_ratenumber

inclusion_plansobject[]

Inclusion Plans

Show child attributes

insuranceobject

Show child attributes

insurance_at_fault_flagenum<string>

Available options: yes, no

insurance_conviction_flagenum<string>

Available options: yes, no

insurance_disclosuresobject[]

Insurance Disclosures

Show child attributes

insurance_loading_typesobject

Insurance Loading Types

Show child attributes

insurance_loss_licence_flagenum<string>

Available options: yes, no

insurer_location_idstring

insurer_location_postcodestring

interest_on_residualnumber

lessee_ratenumber

list_price_gstnumber

list_price_netnumber

location_namestring

location_registration_idstring

lock_base_rate_flagenum<string>default:no

Lock base rate flag

Available options: yes, no

lock_commission_flagenum<string>default:no

Lock commission flag

Available options: yes, no

lock_comprehensive_insurance_flagenum<string>default:no

Available options: yes, no

lock_dealer_discount_flagenum<string>default:no

Available options: yes, no

lock_discount_flagenum<string>default:no

Available options: yes, no

lock_fbt_value_flagenum<string>default:no

Available options: yes, no

lock_lease_rate_flagenum<string>default:no

Available options: yes, no

lock_luxury_car_tax_flagenum<string>default:no

Available options: yes, no

lock_purchase_stamp_duty_flagenum<string>default:no

Available options: yes, no

lock_quote_flagenum<string>default:no

Available options: yes, no

lock_redundancy_insurance_flagenum<string>default:no

Available options: yes, no

lock_residual_flagenum<string>default:no

Available options: yes, no

look_aheadnumber

ltiobject

Show child attributes

luxury_car_taxnumber

luxury_car_tax_exempt_flagenum<string>default:no

Available options: yes, no

luxury_car_tax_paid_flagenum<string>

Available options: yes, no

luxury_chargenumber

maintenance_serviceobject

Show child attributes

margin_gstnumber

margin_netnumber

months_in_arrearsnumber

mortgage_dutynumber

new_usedenum<string>default:new

Available options: new, used, demonstrator

odometernumber

If 'new_used' is set to 'used' or 'demonstrator' this value must bet set to a non-zero value

on_road_price_gstnumber

on_road_price_netnumber

opportunity_idstringrequired

opportunity_numberstring

opportunity_stage_idstring

optional_equipmentobject[]

Optional equipment

Show child attributes

optional_equipment_gstnumber

optional_equipment_netnumber

originator_feenumber

originator_idstring

other_brokeragenumber

package_admin_feenumber

packaging_advice_feenumber

parent_quote_idstring

pay_cycle_billing_periodsnumber

pay_cycle_idstring

periods_deferrednumber

plate_yearnumber

policy_owner_typeenum<string>default:driver

Available options: insurer_internal, client, driver

post_tax_existingnumber

posting_map_idstringrequired

pre_tax_existingnumber

premium_plates_netnumber

previous_fbt_valuenumber

(Optional) Must be a positive number.

price_commentstring

pricing_receivedstring

pricing_referencestring

pricing_requestedstring

procurement_feenumber

procurement_flagenum<string>default:no

Available options: yes, no

purchase_stamp_dutynumber

purchase_stamp_duty_exempt_flagenum<string>default:no

Available options: yes, no

quote_datestring

Example: YYYY-MM-DD

quote_statusobject

Show child attributes

quote_status_idstring

quote_sub_status_idstring

rebate_gstnumber

rebate_netnumber

recalculate_commission_flagenum<string>default:no

Recalculate commission flag

Available options: yes, no

reduced_super_flagenum<string>default:no

Available options: yes, no

redundancy_insurancenumber

redundancy_insurance_costnumber

redundancy_insurance_flagenum<string>default:no

Available options: yes, no

redundancy_insurance_ratenumber

redundancy_insurance_validation_flagenum<string>default:no

Available options: yes, no

reg_ctpobject

Show child attributes

reg_initial_netnumber

relief_vehicleobject

Show child attributes

residual_basisenum<string>

Available options: on-road-price, amount-financed, depreciable-amount, fbt-value, net-vehicle-cost

residual_cash_pool_gstnumber

residual_cash_pool_netnumber

residual_cash_pool_ratenumber

residual_gstnumber

residual_insurancenumber

residual_insurance_ratenumber

residual_netnumber

residual_ratenumber

residual_rate_grossnumber

residual_rate_netnumber

revs_feenumber

roadside_assistanceobject

Show child attributes

small_damage_repairsobject

Show child attributes

stateenum<string>required

Available options: NSW, ACT, NT, WA, SA, VIC, TAS, QLD, NZ

status_flagenum<string>required

Available options: accepted, cancelled, dealer, declined, deleted, draft, expired, external, open, pricing-received, re-quote, recurring, requested, review, sample, sent

superannuationnumber

supplier_id_brokerstring

supplier_id_dealerstring

supplier_id_financierstring

supplier_id_insurerstring

supplier_id_residual_insurerstring

termnumberrequired

total_brokeragenumber

trade_in_amount_gstnumber

trade_in_amount_netnumber

trade_in_reg_nostring

trade_in_vehicle_descriptionstring

trim_preferencestring

tyre_rim_insuranceobject

Show child attributes

tyre_rim_insurance_flagenum<string>default:no

Available options: yes, no

tyresobject

Show child attributes

usage_adjustment_ratenumber

user_id_assignedstring

user_id_client_managerstringrequired

variant_adjustment_ratenumber

variant_bonus_idstring

variant_idstringrequired

vehicle_maintenance_programobject

Show child attributes

vehicle_source_idstring

vehicle_tracking_system_flagenum<string>

Available options: yes, no

vehicle_usage_type_idstring

walkawayobject

Show child attributes

walkaway_flagenum<string>default:no

Available options: yes, no

Example: no

warrant_of_fitnessobject

Show child attributes

warranty_kmsnumber

warranty_mthsnumber

Still need help? Ask the team