patchContract

Overview

This API allows you to update Contract details. It performs the same function as selecting 'Edit' in the Contracts / Contract screen.

Visit https://api.catch-e.com/docs/#/Contracts/patchContract

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Contracts:Update'. Audit History records can be created simultaneously and you will need permissions to Audit:UserIdOverride to enable this.

Go to System Roles and select the 'web_services' role
Navigate to the Roles / APIs tab
Find the Drivers:Update permission and check its check box
Find the Audit:UserIdOverride permission and check its check box

Authenticate to api using this method Authenticate with the API, Please refer this link for login information.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api. API access to this function is provided to the role 'web-services' as the default setting.

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/authenticate

https://api.{{environment}}.catch-e.com/authenticate

https://api.catch-e.com/fm/contracts/{contract_id}

Input Fields (Header)

JSON Field	Format	Notes	Mandatory
contract_id	String	Contract ID	Yes
Contract Details	Various	At least one of the available placeholders must be included in the JSON payload. A full list of placeholders can be obtained by using the fm_contract table_name in the Request a table data export API.	Yes

Example Below of updating Contract Details

{
  "accident_management_flag": "yes",
  "adjusted_residual": 0,
  "amount_financed": 0,
  "ancap_rating": 0,
  "application_collection_date": "2026-05-25",
  "application_date": "YYYY-MM-DD HH:MM:SS",
  "application_reference": "string",
  "application_status": "string",
  "application_status_flag": "string",
  "approval_limit": 0,
  "approval_note": "",
  "approx_delivery": "2026-05-25",
  "asset_id": "ASSET-001",
  "body_configuration": "string",
  "billing_common_day": "1",
  "billing_deferred": 0,
  "billing_periods": 0,
  "booking_module_flag": "yes",
  "bonus_amount_gst": 0,
  "bonus_amount_net": 0,
  "brokerage_fee": 0,
  "budget_depreciation": 0,
  "budget_insurance": 0,
  "budget_interest": 0,
  "budget_residual": 0,
  "budget_residual_gst": 0,
  "budgets_financed": 0,
  "build_date": "2015",
  "cap_price_servicing_flag": "yes",
  "cash_on_delivery_flag": "yes",
  "classification": "string",
  "client_id": "100206",
  "client_cost_centre_id": "100001",
  "client_division_id": "100001",
  "client_id_sold_to": "string",
  "client_order_no": "PO-12345",
  "client_sub_division_id": "100011",
  "co2_emissions": 0,
  "colour": "string",
  "colour_preference_2": "string",
  "colour_preference_3": "string",
  "colour_preference_note": "string",
  "colour_requested": "string",
  "company_id": "100001",
  "compliance_date": "string",
  "confirmed_delivery": "2026-05-25",
  "contract_end": "2031-04-30",
  "contract_id_next": "string",
  "contract_id_previous": "string",
  "contract_kms": 20000,
  "contract_start": "2026-05-01",
  "contract_status_id": "100010",
  "contract_sub_status_id": "100021",
  "cost_centre": "CC-100",
  "cost_centre_id": "100001",
  "cost_centre_fuel": "FUEL-100",
  "cost_of_funds": 0,
  "csd_rate": 0,
  "ctp_expiry_date": "2026-05-25",
  "ctp_initial_gst": 0,
  "ctp_initial_net": 0,
  "ctp_managed_flag": "yes",
  "ctp_number": "string",
  "current_book_value": 0,
  "cylinders": 0,
  "dealer_contact": "string",
  "dealer_delivery_gst": 0,
  "dealer_delivery_net": 0,
  "dealer_discount_gst": 0,
  "dealer_discount_net": 0,
  "dealer_eta": "2026-05-25",
  "dirty_flag": "YYYY-MM-DD HH:MM:SS",
  "dealer_in_stock": "no",
  "dealer_rebate_gst": 0,
  "dealer_rebate_net": 0,
  "deferred_interest": 0,
  "delivery_location_type": "country",
  "depreciable_amount": 0,
  "depreciation_method": "string",
  "depreciation_rate": 0,
  "depreciation_start": "2026-05-25",
  "description": "string",
  "discount_name": "string",
  "discount_gst": 0,
  "discount_net": 0,
  "division": "string",
  "doors": "string",
  "drive_type": "string",
  "driver_id": "100998",
  "driver_pack_flag": "yes",
  "due_off_notes": "string",
  "due_off_quote_manager_user_id": "string",
  "due_off_status_date": "2026-05-25",
  "due_off_status_id": "string",
  "ecm_flag": "yes",
  "employee_level": "string",
  "end_kms": 0,
  "end_kms_date": "2026-05-25",
  "end_kms_valid_flag": "string",
  "engine_cap": "string",
  "engine_number": "string",
  "establishment_fee": 0,
  "establishment_fee_funded_flag": "yes",
  "etag_order_status_id": "string",
  "excess_km_rate": 0,
  "extended_warranty_collected": 0,
  "extended_warranty_policy_number": "string",
  "external_code_1link": "string",
  "facility_type_id": "string",
  "fbt_benefit_type": "statutory",
  "fbt_business_use": 0,
  "fbt_email_flag": "yes",
  "fbt_liability_end_date": "2026-05-25",
  "fbt_reduced_value": 0,
  "fbt_reduced_value_date": "2026-05-25",
  "fbt_statutory_rate_date": "2026-05-25",
  "fbt_treatment_type": "standard",
  "fbt_value": 0,
  "finance_advance_arrears": "advance",
  "finance_due_day": 0,
  "finance_end": "2026-05-25",
  "finance_pmt_code_initial": "string",
  "finance_pmt_code_regular": "string",
  "finance_pmt_code_start": "string",
  "finance_pmt_first_date": "2026-05-25",
  "finance_pmt_final": 0,
  "finance_pmt_initial": 0,
  "finance_pmt_regular": 0,
  "finance_rate": 0,
  "finance_ref": "string",
  "finance_self_billing": "yes",
  "finance_start": "2026-05-25",
  "finance_uuid": "string",
  "finance_vehicle_purchase_gross": 0,
  "finance_vehicle_purchase_gst": 0,
  "finance_vehicle_supplier_id": "string",
  "financier_id": "string",
  "flag_depreciation_limit": "string",
  "flag_new_vehicle": "string",
  "flag_tax_exemption": "string",
  "forecast_sales_value": 0,
  "fuel_capacity": 0,
  "fuel_card_flag": "yes",
  "fuel_card_ordered": "yes",
  "fuel_card_pin": "string",
  "fuel_consumption_lower_limit": 0,
  "fuel_consumption_upper_limit": 0,
  "fuel_type": "string",
  "funding_source": "string",
  "gap_insurance_collected": 0,
  "gap_policy_number": "string",
  "gst_on_interest": 0,
  "imei": "string",
  "imei_status_flag": "active",
  "initial_billings": 0,
  "insurance_base": 0,
  "insurance_billing_frequency": "string",
  "insurance_billing_type": "string",
  "insurance_broker_fee_monthly": 0,
  "insurance_cancelled": "2026-05-25",
  "insurance_category": "string",
  "insurance_claim_excess": 0,
  "insurance_customer_annual": 0,
  "insurance_fire_service_levy": 0,
  "insurance_funded_base": 0,
  "insurance_high_performance_flag": "yes",
  "insurance_inception_month": "string",
  "insurance_market_value": 0,
  "insurance_nominated_1": "string",
  "insurance_nominated_2": "string",
  "insurance_policy_no": "string",
  "insurance_renewal": "2026-05-25",
  "insurance_self_billing": "yes",
  "insurance_stamp_duty": 0,
  "insurance_start": "2026-05-25",
  "insurance_term": 0,
  "insurance_type": "string",
  "insurance_under_25": "string",
  "insurance_windscreen_protection_flag": "yes",
  "interest_rate": 0,
  "interior_colour": "string",
  "introducer_fee": 0,
  "key_no": "string",
  "list_price": 0,
  "list_price_gst": 0,
  "list_price_net": 0,
  "last_edit": "YYYY-MM-DD HH:MM:SS",
  "location": "Sydney",
  "log_book_date": "2026-05-25",
  "luxury_car_tax": 0,
  "luxury_car_tax_exempt_flag": "yes",
  "maintenance_cost_per_1000_kms_limit": 0,
  "manufacturer_code": "string",
  "manufacturer_model_code": "string",
  "manufacturer_name": "string",
  "margin_gst": 0,
  "margin_net": 0,
  "market_price": 0,
  "market_value": 0,
  "mini_lease": "string",
  "model_code": "string",
  "model_name": "string",
  "motor_club_renewal": "2026-05-25",
  "motor_club_status": "string",
  "mth_residual_reserve": 0,
  "name_on_account": "string",
  "notes": "string",
  "nvic_code": "string",
  "on_order_flag": "yes",
  "on_road_cost": 0,
  "on_road_price_gst": 0,
  "on_road_price_net": 0,
  "options_notes": "string",
  "order_follow_up": "string",
  "order_manager_user_id": "string",
  "order_notes": "string",
  "order_rate": 0,
  "order_required": "2026-05-25",
  "order_status": "string",
  "order_status_id": "string",
  "order_time": "string",
  "ordered": "2026-05-25",
  "original_finance_amount": 0,
  "originator_fee": 0,
  "originator_id": "100003",
  "payout_date": "2026-05-25",
  "payout_method": "string",
  "payout_value": 0,
  "payout_value_gst": 0,
  "pay_cycle_billing_periods": 0,
  "pay_cycle_id": "100001",
  "penalty_rate": 0,
  "periods_deferred": 0,
  "periodic_billings": 0,
  "phone_swap_flag": "yes",
  "pink_slip_received": "yes",
  "pink_slip_required": "yes",
  "policy_owner_type": "string",
  "posting_map_id": "100023",
  "premium_plates_net": 0,
  "program": "Program A",
  "purchase_stamp_duty": 0,
  "quote_accepted": "2026-05-25",
  "quote_created": "2026-05-25",
  "quote_id": "135725",
  "quoted_residual": 0,
  "radio_pin": "string",
  "red_book_code": "string",
  "rebate_gst": 0,
  "rebate_net": 0,
  "redundancy_collected": 0,
  "redundancy_policy_number": "string",
  "reg_bpay_ref": "string",
  "reg_initial_net": 0,
  "reg_managed_flag": "yes",
  "reg_no": "FQX123",
  "reg_renewal": "2026-05-25",
  "reg_state": "string",
  "registered_owner": "string",
  "registration": "2026-05-25",
  "registration_token": "string",
  "rego_papers_received": "yes",
  "relief_vehicle_status": "string",
  "report_finance_payments_flag": "yes",
  "reserve_price_gst": 0,
  "reserve_price_net": 0,
  "residual_due_date": "2026-05-25",
  "residual_insurer_fee": 0,
  "residual_reserve": 0,
  "revs_fee": 0,
  "revs_number": "string",
  "revs_status": "string",
  "roadside_end_date": "2026-05-25",
  "roadside_managed_flag": "yes",
  "roadside_start_date": "2026-05-25",
  "roadside_term": 0,
  "sale_method_id": "string",
  "sale_price_gross": 0,
  "sale_price_gst": 0,
  "sale_status_date": "2026-05-25",
  "sale_status_id": "string",
  "security_deposit": 0,
  "service_interval_km": 0,
  "service_interval_months": 0,
  "small_damage_repairs_collected": 0,
  "sold_date": "2026-05-25",
  "sold_to_order": "string",
  "sold_to_reference": "string",
  "start_odometer": 0,
  "start_odometer_date": "2026-05-25",
  "state": "NSW",
  "state_authority_account_number": "string",
  "state_authority_vehicle_ref_number": "string",
  "supplier_id": "100453",
  "supplier_id_broker": "string",
  "supplier_id_etag": "100470",
  "supplier_id_insurer": "string",
  "supplier_id_introducer": "string",
  "supplier_id_preferred": "100454",
  "supplier_id_resid_ins": "string",
  "supplier_id_roadside": "string",
  "supplier_reference": "SUP-REF-001",
  "suspend_date": "2026-05-25",
  "tag_account_number": "string",
  "tag_managed_flag": "yes",
  "tag_number": "string",
  "tag_sido": "string",
  "term": 60,
  "terminated_date": "2026-05-25",
  "third_party": "no",
  "third_party_end": "2031-04-30",
  "third_party_lease_id": "string",
  "third_party_lease_kms": 0,
  "third_party_lease_rate_net": 0,
  "third_party_lease_term": 0,
  "third_party_start": "2026-05-01",
  "third_party_start_odometer": 0,
  "total_brokerage": 0,
  "total_options": 0,
  "total_options_gst": 0,
  "transmission": "string",
  "trim_requested": "string",
  "tyre_allowance": "string",
  "tyre_code": "string",
  "tyre_name": "string",
  "tyre_spec": "string",
  "tyres_per_set": 0,
  "under_repair_flag": "no",
  "user_id_last_edit": "string",
  "variant_id": "184796",
  "variant_name": "string",
  "vehicle_type": "string",
  "vin": "string",
  "walkaway_collected": 0,
  "walkaway_policy_number": "string",
  "warranty_expiry": "2026-05-25",
  "warranty_km": "string",
  "warranty_months": 0,
  "1link_export_flag": "yes",
  "inertia_flag": "no"
}

Response Details

Validation Messages	Comments
200 Success

{
  "contract_id": "100001",
  "accident_management_flag": "yes",
  "adjusted_residual": 0,
  "amount_financed": 0,
  "ancap_rating": 0,
  "application_collection_date": "2026-05-25",
  "application_date": "YYYY-MM-DD HH:MM:SS",
  "application_reference": "string",
  "application_status": "string",
  "application_status_flag": "string",
  "approval_limit": 0,
  "approval_note": "",
  "approx_delivery": "2026-05-25",
  "asset_id": "ASSET-001",
  "body_configuration": "string",
  "billing_common_day": "1",
  "billing_deferred": 0,
  "billing_periods": 0,
  "booking_module_flag": "yes",
  "bonus_amount_gst": 0,
  "bonus_amount_net": 0,
  "brokerage_fee": 0,
  "budget_depreciation": 0,
  "budget_insurance": 0,
  "budget_interest": 0,
  "budget_residual": 0,
  "budget_residual_gst": 0,
  "budgets_financed": 0,
  "build_date": "2015",
  "cap_price_servicing_flag": "yes",
  "cash_on_delivery_flag": "yes",
  "classification": "string",
  "client_id": "100206",
  "client_cost_centre_id": "100001",
  "client_division_id": "100001",
  "client_id_sold_to": "string",
  "client_order_no": "PO-12345",
  "client_sub_division_id": "100011",
  "co2_emissions": 0,
  "colour": "string",
  "colour_preference_2": "string",
  "colour_preference_3": "string",
  "colour_preference_note": "string",
  "colour_requested": "string",
  "company_id": "100001",
  "compliance_date": "string",
  "confirmed_delivery": "2026-05-25",
  "contract_end": "2031-04-30",
  "contract_id_next": "string",
  "contract_id_previous": "string",
  "contract_kms": 20000,
  "contract_start": "2026-05-01",
  "contract_status_id": "100001",
  "contract_sub_status_id": "100021",
  "cost_centre": "CC-100",
  "cost_centre_id": "100001",
  "cost_centre_fuel": "FUEL-100",
  "cost_of_funds": 0,
  "csd_rate": 0,
  "ctp_expiry_date": "2026-05-25",
  "ctp_initial_gst": 0,
  "ctp_initial_net": 0,
  "ctp_managed_flag": "yes",
  "ctp_number": "string",
  "current_book_value": 0,
  "cylinders": 0,
  "dealer_contact": "string",
  "dealer_delivery_gst": 0,
  "dealer_delivery_net": 0,
  "dealer_discount_gst": 0,
  "dealer_discount_net": 0,
  "dealer_eta": "2026-05-25",
  "dealer_in_stock": "no",
  "dealer_rebate_gst": 0,
  "dealer_rebate_net": 0,
  "dirty_flag": "YYYY-MM-DD HH:MM:SS",
  "deferred_interest": 0,
  "delivery_location_type": "country",
  "depreciable_amount": 0,
  "depreciation_method": "string",
  "depreciation_rate": 0,
  "depreciation_start": "2026-05-25",
  "description": "string",
  "discount_name": "string",
  "discount_gst": 0,
  "discount_net": 0,
  "division": "string",
  "doors": "string",
  "drive_type": "string",
  "driver_id": "100998",
  "driver_pack_flag": "yes",
  "due_off_notes": "string",
  "due_off_quote_manager_user_id": "string",
  "due_off_status_date": "2026-05-25",
  "due_off_status_id": "string",
  "ecm_flag": "yes",
  "employee_level": "string",
  "end_kms": 0,
  "end_kms_date": "2026-05-25",
  "end_kms_valid_flag": "string",
  "engine_cap": "string",
  "engine_number": "string",
  "establishment_fee": 0,
  "establishment_fee_funded_flag": "yes",
  "etag_order_status_id": "string",
  "excess_km_rate": 0,
  "extended_warranty_collected": 0,
  "extended_warranty_policy_number": "string",
  "external_code_1link": "string",
  "facility_type_id": "string",
  "fbt_benefit_type": "statutory",
  "fbt_business_use": 0,
  "fbt_email_flag": "yes",
  "fbt_liability_end_date": "2026-05-25",
  "fbt_reduced_value": 0,
  "fbt_reduced_value_date": "2026-05-25",
  "fbt_statutory_rate_date": "2026-05-25",
  "fbt_treatment_type": "standard",
  "fbt_value": 0,
  "finance_advance_arrears": "advance",
  "finance_due_day": 0,
  "finance_end": "2026-05-25",
  "finance_pmt_code_initial": "string",
  "finance_pmt_code_regular": "string",
  "finance_pmt_code_start": "string",
  "finance_pmt_first_date": "2026-05-25",
  "finance_pmt_final": 0,
  "finance_pmt_initial": 0,
  "finance_pmt_regular": 0,
  "finance_rate": 0,
  "finance_ref": "string",
  "finance_self_billing": "yes",
  "finance_start": "2026-05-25",
  "finance_uuid": "string",
  "finance_vehicle_purchase_gross": 0,
  "finance_vehicle_purchase_gst": 0,
  "finance_vehicle_supplier_id": "string",
  "financier_id": "string",
  "flag_depreciation_limit": "string",
  "flag_new_vehicle": "string",
  "flag_tax_exemption": "string",
  "forecast_sales_value": 0,
  "fuel_capacity": 0,
  "fuel_card_flag": "yes",
  "fuel_card_ordered": "yes",
  "fuel_card_pin": "string",
  "fuel_consumption_lower_limit": 0,
  "fuel_consumption_upper_limit": 0,
  "fuel_type": "string",
  "funding_source": "string",
  "gap_insurance_collected": 0,
  "gap_policy_number": "string",
  "gst_on_interest": 0,
  "imei": "string",
  "imei_status_flag": "active",
  "initial_billings": 0,
  "inertia_flag": "no",
  "insurance_base": 0,
  "insurance_billing_frequency": "string",
  "insurance_billing_type": "string",
  "insurance_broker_fee_monthly": 0,
  "insurance_cancelled": "2026-05-25",
  "insurance_category": "string",
  "insurance_claim_excess": 0,
  "insurance_customer_annual": 0,
  "insurance_fire_service_levy": 0,
  "insurance_funded_base": 0,
  "insurance_high_performance_flag": "yes",
  "insurance_inception_month": "string",
  "insurance_market_value": 0,
  "insurance_nominated_1": "string",
  "insurance_nominated_2": "string",
  "insurance_policy_no": "string",
  "insurance_renewal": "2026-05-25",
  "insurance_self_billing": "yes",
  "insurance_stamp_duty": 0,
  "insurance_start": "2026-05-25",
  "insurance_term": 0,
  "insurance_type": "string",
  "insurance_under_25": "string",
  "insurance_windscreen_protection_flag": "yes",
  "interest_rate": 0,
  "interior_colour": "string",
  "introducer_fee": 0,
  "key_no": "string",
  "list_price": 0,
  "list_price_gst": 0,
  "list_price_net": 0,
  "last_edit": "YYYY-MM-DD HH:MM:SS",
  "location": "Sydney",
  "log_book_date": "2026-05-25",
  "luxury_car_tax": 0,
  "luxury_car_tax_exempt_flag": "yes",
  "maintenance_cost_per_1000_kms_limit": 0,
  "manufacturer_code": "string",
  "manufacturer_model_code": "string",
  "manufacturer_name": "string",
  "margin_gst": 0,
  "margin_net": 0,
  "market_price": 0,
  "market_value": 0,
  "mini_lease": "string",
  "model_code": "string",
  "model_name": "string",
  "motor_club_renewal": "2026-05-25",
  "motor_club_status": "string",
  "mth_residual_reserve": 0,
  "name_on_account": "string",
  "notes": "string",
  "nvic_code": "string",
  "on_order_flag": "yes",
  "on_road_cost": 0,
  "on_road_price_gst": 0,
  "on_road_price_net": 0,
  "options_notes": "string",
  "order_follow_up": "string",
  "order_manager_user_id": "string",
  "order_notes": "string",
  "order_rate": 0,
  "order_required": "2026-05-25",
  "order_status": "string",
  "order_status_id": "string",
  "order_time": "string",
  "ordered": "2026-05-25",
  "original_finance_amount": 0,
  "originator_fee": 0,
  "originator_id": "100003",
  "payout_date": "2026-05-25",
  "payout_method": "string",
  "payout_value": 0,
  "payout_value_gst": 0,
  "pay_cycle_billing_periods": 0,
  "pay_cycle_id": "100001",
  "penalty_rate": 0,
  "periods_deferred": 0,
  "periodic_billings": 0,
  "phone_swap_flag": "yes",
  "pink_slip_received": "yes",
  "pink_slip_required": "yes",
  "policy_owner_type": "string",
  "posting_map_id": "100023",
  "premium_plates_net": 0,
  "program": "Program A",
  "purchase_stamp_duty": 0,
  "quote_accepted": "2026-05-25",
  "quote_created": "2026-05-25",
  "quote_id": "135725",
  "quoted_residual": 0,
  "radio_pin": "string",
  "red_book_code": "string",
  "rebate_gst": 0,
  "rebate_net": 0,
  "redundancy_collected": 0,
  "redundancy_policy_number": "string",
  "reg_bpay_ref": "string",
  "reg_initial_net": 0,
  "reg_managed_flag": "yes",
  "reg_no": "FQX123",
  "reg_renewal": "2026-05-25",
  "reg_state": "string",
  "registered_owner": "string",
  "registration": "2026-05-25",
  "registration_token": "string",
  "rego_papers_received": "yes",
  "relief_vehicle_status": "string",
  "report_finance_payments_flag": "yes",
  "reserve_price_gst": 0,
  "reserve_price_net": 0,
  "residual_due_date": "2026-05-25",
  "residual_insurer_fee": 0,
  "residual_reserve": 0,
  "revs_fee": 0,
  "revs_number": "string",
  "revs_status": "string",
  "roadside_end_date": "2026-05-25",
  "roadside_managed_flag": "yes",
  "roadside_start_date": "2026-05-25",
  "roadside_term": 0,
  "sale_method_id": "string",
  "sale_price_gross": 0,
  "sale_price_gst": 0,
  "sale_status_date": "2026-05-25",
  "sale_status_id": "string",
  "security_deposit": 0,
  "service_interval_km": 0,
  "service_interval_months": 0,
  "small_damage_repairs_collected": 0,
  "sold_date": "2026-05-25",
  "sold_to_order": "string",
  "sold_to_reference": "string",
  "start_odometer": 0,
  "start_odometer_date": "2026-05-25",
  "state": "NSW",
  "state_authority_account_number": "string",
  "state_authority_vehicle_ref_number": "string",
  "supplier_id": "100453",
  "supplier_id_broker": "string",
  "supplier_id_etag": "100470",
  "supplier_id_insurer": "string",
  "supplier_id_introducer": "string",
  "supplier_id_preferred": "100454",
  "supplier_id_resid_ins": "string",
  "supplier_id_roadside": "string",
  "supplier_reference": "SUP-REF-001",
  "suspend_date": "2026-05-25",
  "tag_account_number": "string",
  "tag_managed_flag": "yes",
  "tag_number": "string",
  "tag_sido": "string",
  "term": 60,
  "terminated_date": "2026-05-25",
  "third_party": "no",
  "third_party_end": "2031-04-30",
  "third_party_lease_id": "string",
  "third_party_lease_kms": 0,
  "third_party_lease_rate_net": 0,
  "third_party_lease_term": 0,
  "third_party_start": "2026-05-01",
  "third_party_start_odometer": 0,
  "total_brokerage": 0,
  "total_options": 0,
  "total_options_gst": 0,
  "transmission": "string",
  "trim_requested": "string",
  "tyre_allowance": "string",
  "tyre_code": "string",
  "tyre_name": "string",
  "tyre_spec": "string",
  "tyres_per_set": 0,
  "under_repair_flag": "no",
  "user_id_last_edit": "string",
  "variant_id": "184796",
  "variant_name": "string",
  "vehicle_type": "string",
  "vin": "string",
  "walkaway_collected": 0,
  "walkaway_policy_number": "string",
  "warranty_expiry": "2026-05-25",
  "warranty_km": "string",
  "warranty_months": 0,
  "1link_export_flag": "yes"
}

Error Response Details

Validation Messges	Comments
401 Unauthorized	You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again.

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized"
}

403 Forbidden

You do not have permissions for this request.
Go to System Roles and enter 'web_services'
Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Forbidden",
    "status": 403,
    "detail": "Forbidden"
}

406 - Not Acceptable

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Not Acceptable",
  "status": 406,
  "detail": "Not Acceptable"
}

415 - Unsupported Media Type

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Unsupported Media Type",
  "status": 415,
  "detail": "Not Acceptable"
}

422 - Unprocessable Entity

Data being passed in the described field is invalid, the format is invalid or it is missing

{
  "warning_messages": {
    "fieldName": {
      "warningExceptionCode": "A textual description of the warning exception"
    }
  },
  "validation_messages": {
    "fieldName": {
      "validationExceptionCode": "A textual description of the validation exception"
    }
  },
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "Failed Validation"
}

423 - Locked

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Locked",
  "status": 423,
  "detail": "Locked"
}

424 - Failed Dependancy - Lock Expected

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Failed Dependency",
  "status": 424,
  "detail": "string"
}

500 - Internal Error

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

default - Unexpected Error

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }