Quotes

Create quotes

Create quotes.

POST

/qt/quotes

Create quotes

curl --request POST \
  --url https://api.catch-e.com/qt/quotes \
  --header 'Authorization: <api-key>' \
  --header 'Delegated-Locking-Session-Id: <string>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Time-Zone: UTC' \
  --header 'Content-Type: application/vnd.catch-e-api.v1+json' \
  --data '
[
  {
    "after_hours_assistance_flag": "no",
    "annual_kms": 123,
    "annual_salary": 123,
    "application_date": "YYYY-MM-DD HH:MM:SS",
    "application_reference": "<string>",
    "application_status_flag": "<string>",
    "base_rate": 123,
    "bespoke_field_values": {},
    "bonus_amount_gst": 123,
    "bonus_amount_net": 123,
    "carbon_emissions_offset": {
      "included_flag": "yes"
    },
    "claimable_gst": 123,
    "client_contact_name": "<string>",
    "client_email": "jsmith@example.com",
    "client_fax": "<string>",
    "client_id": "<string>",
    "client_margin_rate": 123,
    "client_name": "<string>",
    "client_phone": "<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,
    "contract_kms": 123,
    "cost_centre": "<string>",
    "ctp_initial_gst": 123,
    "ctp_initial_net": 123,
    "date": "YYYY-MM-DD",
    "date_first_held": "2023-12-25",
    "deal_type_id": "<string>",
    "dealer_comment": "<string>",
    "dealer_delivery_gst": 123,
    "dealer_delivery_net": 123,
    "dealer_discount_gst": 123,
    "dealer_discount_net": 123,
    "dealer_rebate_gst": 123,
    "dealer_rebate_net": 123,
    "delivery_location_type": "country",
    "deposit_gst": 123,
    "deposit_net": 123,
    "discount_gst": 123,
    "discount_net": 123,
    "discount_type_id": "<string>",
    "disposal_fee": 123,
    "disposal_flag": "no",
    "division": "<string>",
    "driver": {
      "accountant_contact_name": "",
      "accountant_contact_phone": "",
      "accountant_firm_name": "",
      "address_id_home": null,
      "address_id_post": null,
      "addresses": {
        "home": {
          "address_1": "<string>",
          "address_2": "<string>",
          "address_detail_pid": "GAVIC424617164",
          "area": "<string>",
          "country_id": "<string>",
          "postcode": "<string>",
          "state": "VIC"
        },
        "post": {
          "address_1": "<string>",
          "address_2": "<string>",
          "address_detail_pid": "GAVIC424617164",
          "area": "<string>",
          "country_id": "<string>",
          "postcode": "<string>",
          "state": "VIC"
        }
      },
      "allowances": 0,
      "annual_salary": 0,
      "asset_bank_accounts": 123,
      "asset_bank_accounts_description": "",
      "asset_furniture": 123,
      "asset_furniture_description": "",
      "asset_investment_properties": 123,
      "asset_investment_properties_description": "",
      "asset_motor_vehicle": 123,
      "asset_motor_vehicle_description": "",
      "asset_other_investments": 123,
      "asset_other_investments_description": "",
      "asset_resident_property": 123,
      "asset_resident_property_description": "",
      "asset_shares": 123,
      "asset_shares_description": "",
      "asset_super": 123,
      "asset_super_description": "",
      "ato_loan_flag": "no",
      "australian_resident": "yes",
      "card_account_number": "",
      "client_cost_centre_id": "0",
      "client_id": "",
      "contact_note": "<string>",
      "corporate_type_id_previous_employer": "0",
      "created": "0000-00-00 00:00:00",
      "credit_check_authorised_flag": "yes",
      "date_of_birth": null,
      "driver_claims_flag": "yes",
      "driver_employment_type_id": "0",
      "driver_id_external": "0",
      "driver_lic_exp": null,
      "driver_licence": null,
      "driver_licence_card_number": null,
      "driver_licence_state": "VIC",
      "driver_occupation_code_id": "0",
      "employee_alias": "",
      "employee_area": null,
      "employee_end": "0000-00-00",
      "employee_group": null,
      "employee_no": null,
      "employee_pay_office": null,
      "employee_sl_acc": null,
      "employee_start": "0000-00-00",
      "employee_super": 0,
      "employer_address_1": "",
      "employer_address_2": "",
      "employer_address_3": "",
      "employer_address_postcode": "",
      "employer_address_state": "VIC",
      "employer_super": 0,
      "expense_credit_card": 123,
      "expense_household": 123,
      "expense_mortgage": 123,
      "expense_other": 123,
      "expense_private_education_childcare": 123,
      "expense_rent": 123,
      "expense_vehicle": 123,
      "external_code": "",
      "fbt_type": null,
      "financier_applicant_reference": "",
      "gender": "Male",
      "generated_password": "<string>",
      "given_name": null,
      "home_car_postcode": null,
      "home_email": null,
      "home_fax": null,
      "home_phone": null,
      "home_postcode": null,
      "home_state": null,
      "home_street": null,
      "home_street_no": null,
      "home_street_type": null,
      "home_suburb": null,
      "home_unit_no": null,
      "income_government_benefits": 123,
      "income_gross": 123,
      "income_investment": 123,
      "income_net": 123,
      "income_other": 123,
      "income_rental_net": 123,
      "income_spouse_gross": 123,
      "income_spouse_net": 123,
      "income_superannuation": 123,
      "insurance_broker_fee_exempt_flag": "yes",
      "kyc_verified_flag": "no",
      "landlord_name": "",
      "landlord_telephone": "",
      "last_edit": "2023-11-07T05:31:56Z",
      "liability_credit_card_limit": 123,
      "liability_credit_card_limit_description": "",
      "liability_investment_mortgages": 123,
      "liability_investment_mortgages_description": "",
      "liability_loans": 123,
      "liability_loans_description": "",
      "liability_mortgages": 123,
      "liability_mortgages_description": "",
      "liability_other": 123,
      "liability_other_description": "",
      "liability_overdraft": 123,
      "liability_overdraft_description": "",
      "liability_rent": 123,
      "liability_rent_description": "",
      "licence_class": "",
      "marital_status": "de-facto",
      "middle_name": "",
      "mobile": null,
      "name_on_account": "",
      "no_of_dependents": null,
      "override_warnings_flag": "no",
      "pay_cycle_id": "0",
      "preferred_name": null,
      "previous_address_1": "",
      "previous_address_2": "",
      "previous_address_3": "",
      "previous_address_country_id": null,
      "previous_address_detail_pid": "GAVIC424617164",
      "previous_address_postcode": "",
      "previous_address_state": "VIC",
      "previous_address_years_at_address": 0,
      "previous_employer_abn": "<string>",
      "previous_employer_name": "",
      "previous_employer_phone": "",
      "previous_years_employed": 0,
      "report_delivery_type": "email",
      "residency_status": "citizen",
      "residential_status": "own",
      "salutation": "Mr",
      "start_at_address": "0000-00-00",
      "stop_becs_flag": "no",
      "supplier_id_etag": "0",
      "supplier_id_financier": "0",
      "surname": null,
      "tag_account_number": "",
      "tag_number": "",
      "user_id_package_advisor": null,
      "work_contact_given": null,
      "work_contact_position": null,
      "work_contact_surname": null,
      "work_fax": null,
      "work_name": null,
      "work_phone": null,
      "work_phone_ext": null,
      "work_position": null,
      "work_postcode": null,
      "work_state": null,
      "work_street": null,
      "work_street_no": null,
      "work_street_type": null,
      "work_suburb": null,
      "work_type": null,
      "work_unit_no": null,
      "years_at_address": 0,
      "years_with_employer": 0
    },
    "driver_email": "jsmith@example.com",
    "driver_fax": "<string>",
    "driver_given_name": "<string>",
    "driver_id": "<string>",
    "driver_phone": "<string>",
    "driver_surname": "<string>",
    "duration": 123,
    "ecm_flag": "yes",
    "employer_fbt_type": "full-fbt-payable",
    "establishment_fee": 123,
    "fbt_benefit_type": "statutory",
    "fbt_business_use": 123,
    "fbt_treatment_type": "standard",
    "fbt_value": 123,
    "finance_type_id": "<string>",
    "fuel": {
      "cost_per_litre": 123,
      "fuel_type_id": "<string>",
      "included_flag": "yes",
      "litres_per_100km": 123,
      "monthly_amount_net": 123,
      "usage_type": "metro"
    },
    "gap_insurance_flag": "no",
    "inclusion_plans": [
      {
        "included_flag": "yes",
        "inclusion_code": "<string>",
        "inclusion_plan_code": "<string>",
        "inclusion_plan_code_qualified": "<string>",
        "retail_price_gross": 123
      }
    ],
    "insurance": {
      "annual_insurance": 123,
      "billing_type": "<string>",
      "claim_excess": 123,
      "fund_1st_year_flag": "no",
      "included_flag": "yes",
      "insurance_type_id": "<string>",
      "monthly_amount_net": 123,
      "supplier_id": "<string>"
    },
    "insurance_at_fault_flag": "no",
    "insurance_conviction_flag": "no",
    "insurance_loading_types": {
      "driver_restriction": {
        "insurance_loading_type_id": "<string>"
      },
      "licence": {
        "insurance_loading_type_id": "<string>"
      },
      "past_claims": {
        "insurance_loading_type_id": "<string>"
      }
    },
    "insurance_loss_licence_flag": "no",
    "insurer_location_id": "<string>",
    "insurer_location_postcode": "<string>",
    "list_price_gst": 123,
    "list_price_net": 123,
    "location_name": "<string>",
    "lock_base_rate_flag": "no",
    "lock_commission_flag": "no",
    "lock_comprehensive_insurance_flag": "no",
    "lock_dealer_discount_flag": "no",
    "lock_discount_flag": "no",
    "lock_fbt_value_flag": "yes",
    "lock_luxury_car_tax_flag": "no",
    "lock_purchase_stamp_duty_flag": "no",
    "lock_quote_flag": "no",
    "lti": {
      "included_flag": "yes",
      "lti_top_up_benefit_id": "<string>",
      "retail_price_gross": 123
    },
    "luxury_car_tax": 123,
    "luxury_car_tax_paid_flag": "yes",
    "maintenance_service": {
      "included_flag": "yes",
      "maintenance_service_profile_id": "<string>",
      "monthly_amount_net": 123,
      "service_kms": 123,
      "service_mths": 123
    },
    "margin_gst": 123,
    "margin_net": 123,
    "new_used": "new",
    "odometer": 123,
    "opportunity_id": "<string>",
    "opportunity_number": "<string>",
    "opportunity_stage_id": "<string>",
    "optional_equipment": [
      {
        "cost_price_net": 123,
        "description": "<string>",
        "discount_net": 123,
        "gst": 123,
        "included_flag": "yes",
        "list_price_net": 123,
        "optional_equipment_id": "<string>",
        "residual_rate": 123
      }
    ],
    "originator_fee": 123,
    "originator_id": "<string>",
    "override_warnings_flag": "no",
    "parent_quote_id": "<string>",
    "pay_cycle_id": "<string>",
    "plate_year": 123,
    "policy_owner_type": "driver",
    "posting_map_id": "<string>",
    "premium_plates_net": 123,
    "previous_fbt_value": 123,
    "previous_lease_start": "2023-12-25",
    "price_comment": "<string>",
    "pricing_received": "<string>",
    "pricing_reference": "<string>",
    "pricing_requested": "<string>",
    "procurement_fee": 123,
    "procurement_flag": "no",
    "purchase_stamp_duty": 123,
    "quote_status_id": "<string>",
    "rebate_gst": 123,
    "rebate_net": 123,
    "recalculate_commission_flag": "no",
    "redundancy_insurance_flag": "no",
    "reg_ctp": {
      "annual_ctp": 123,
      "annual_plates": 123,
      "annual_reg": 123,
      "included_flag": "yes",
      "monthly_amount_net": 123,
      "renewals": 123
    },
    "reg_initial_net": 123,
    "relief_vehicle": {
      "included_flag": "yes",
      "monthly_amount_net": 123
    },
    "residual_net": 123,
    "roadside_assistance": {
      "cost": 123,
      "included_flag": "yes",
      "monthly_amount_net": 123,
      "premium": 123,
      "roadside_assistance_plan_id": "<string>"
    },
    "small_damage_repairs": {
      "included_flag": "yes",
      "monthly_amount_net": 123,
      "premium": 123,
      "small_damage_repairs_id": "<string>"
    },
    "state": "NSW",
    "supplier_id_dealer": "<string>",
    "supplier_id_financier": "<string>",
    "term": 123,
    "trade_in_amount_gst": 123,
    "trade_in_amount_net": 123,
    "trade_in_reg_no": "<string>",
    "trim_preference": "<string>",
    "tyre_rim_insurance": {
      "included_flag": "yes",
      "tyre_rim_insurance_plan_id": "<string>"
    },
    "tyres": {
      "included_flag": "yes",
      "limit_flag": "no",
      "monthly_amount_net": 123,
      "tyre_id": "<string>",
      "tyre_km_interval": 123,
      "tyres_estimated": 123,
      "tyres_per_set": 123,
      "unit_cost_net": 123
    },
    "user_id_assigned": "<string>",
    "user_id_client_manager": "<string>",
    "variant_id": "<string>",
    "vehicle_maintenance_program": {
      "included_flag": "yes",
      "monthly_amount_net": 123
    },
    "vehicle_source_id": "<string>",
    "vehicle_tracking_system_flag": "yes",
    "walkaway": {
      "included_flag": "yes",
      "walkaway_plan_id": "<string>"
    },
    "warrant_of_fitness": {
      "included_flag": "yes"
    },
    "warranty_kms": 123,
    "warranty_mths": 123
  }
]
'

{
  "_embedded": {
    "qt_quotes": [
      {
        "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>",

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

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

Headers

Delegated-Locking-Session-Idstringheader

(Optional) Locking responsibility will be delegated to the specified Session Id.

This header enables the client to instruct the API to merely verify the presence of locks with the specified session id, but not attempt to obtain them itself. It requires the DelegatedLocking permission to be associated with your role.

Maximum string length: 32

Pattern: ^[0-9a-f]{32}

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

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

Time-Zonestringheaderdefault:UTC

Quotes will be created 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\/\:\+\-\_]+$

Body

JSON payload

itemsobject[]

Show child attributes

Response

Quote created successfully

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team