Skip to main content
Contracts

Get contract

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

GET
/fm/contracts/{contract_id}

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

contract_idstringrequired

Contract Id

Maximum string length: 10
Pattern: ^[1-9]{1}[0-9]*$

Query Parameters

embedenum<string>query

When set to fbt, the response includes an _embedded.fbt object containing derived Fringe Benefits Tax calculations for the contract (equivalent to the legacy FBT screen). These fields are calculated on demand and are not stored columns on the contract.

Available options: fbt
fbt_year_endingstringquery

The 4 digit calendar year in which the FBT year ends (FBT years run 1 April to 31 March). Only used when embed=fbt is supplied; defaults to the current FBT year when omitted. If the requested (or current) FBT year does not overlap the contract's own lifetime at all (e.g. it predates the contract's first FBT period, or the contract had already ended before that FBT year started), _embedded.fbt is omitted from the response instead of returning a self-contradictory result.

Pattern: ^[0-9]{4}$

Headers

Time-Zonestringheaderdefault:UTC

Contract 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

application/vnd.catch-e-api.v1+json

Success

1link_export_flagstring
Example: yes
_embeddedobject

Only present when requested via the embed query parameter on getContract.

accident_management_flagstring
Example: yes
adjusted_residualnumber
Example: 0
amount_financednumber
Example: 0
ancap_ratinginteger
Example: 0
application_collection_datestring
Example: 2026-05-25
application_datestring
Example: YYYY-MM-DD HH:MM:SS
application_referencestring
Example: string
application_statusstring
Example: string
application_status_flagstring
Example: string
approval_limitnumber
Example: 0
approval_notestring
Example:
approx_deliverystring
Example: 2026-05-25
asset_idstring
Example: ASSET-001
billing_common_daystring
Example: 1
billing_deferredinteger
Example: 0
billing_periodsinteger
Example: 0
body_configurationstring
Example: string
bonus_amount_gstnumber
Example: 0
bonus_amount_netnumber
Example: 0
booking_module_flagstring
Example: yes
brokerage_feenumber
Example: 0
budget_depreciationnumber
Example: 0
budget_insurancenumber
Example: 0
budget_interestnumber
Example: 0
budget_residualnumber
Example: 0
budget_residual_gstnumber
Example: 0
budgets_financednumber
Example: 0
build_datestring
Example: 2015
cap_price_servicing_flagstring
Example: yes
cash_on_delivery_flagstring
Example: yes
classificationstring
Example: string
client_cost_centre_idstring
Example: 100001
client_division_idstring
Example: 100001
client_idstring
Example: 100206
client_id_sold_tostring
Example: string
client_order_nostring
Example: PO-12345
client_sub_division_idstring
Example: 100011
co2_emissionsinteger
Example: 0
colourstring
Example: string
colour_preference_2string
Example: string
colour_preference_3string
Example: string
colour_preference_notestring
Example: string
colour_requestedstring
Example: string
company_idstring
Example: 100001
compliance_datestring
Example: string
confirmed_deliverystring
Example: 2026-05-25
contract_endstring
Example: 2031-04-30
contract_idstring
Example: 100001
contract_id_nextstring
Example: string
contract_id_previousstring
Example: string
contract_kmsinteger
Example: 20000
contract_startstring
Example: 2026-05-01
contract_status_idstring
Example: 100001
contract_sub_status_idstring
Example: 100021
cost_centrestring
Example: CC-100
cost_centre_fuelstring
Example: FUEL-100
cost_centre_idstring
Example: 100001
cost_of_fundsnumber
Example: 0
csd_ratenumber
Example: 0
ctp_expiry_datestring
Example: 2026-05-25
ctp_initial_gstnumber
Example: 0
ctp_initial_netnumber
Example: 0
ctp_managed_flagstring
Example: yes
ctp_numberstring
Example: string
current_book_valuenumber
Example: 0
cylindersinteger
Example: 0
dealer_contactstring
Example: string
dealer_delivery_gstnumber
Example: 0
dealer_delivery_netnumber
Example: 0
dealer_discount_gstnumber
Example: 0
dealer_discount_netnumber
Example: 0
dealer_etastring
Example: 2026-05-25
dealer_in_stockstring
Example: no
dealer_rebate_gstnumber
Example: 0
dealer_rebate_netnumber
Example: 0
deferred_interestnumber
Example: 0
delivery_location_typestring
Example: country
depreciable_amountnumber
Example: 0
depreciation_methodstring
Example: string
depreciation_ratenumber
Example: 0
depreciation_startstring
Example: 2026-05-25
descriptionstring
Example: string
dirty_flagstring
Example: YYYY-MM-DD HH:MM:SS
discount_gstnumber
Example: 0
discount_namestring
Example: string
discount_netnumber
Example: 0
divisionstring
Example: string
doorsstring
Example: string
drive_typestring
Example: string
driver_idstring
Example: 100998
driver_pack_flagstring
Example: yes
due_off_notesstring
Example: string
due_off_quote_manager_user_idstring
Example: string
due_off_status_datestring
Example: 2026-05-25
due_off_status_idstring
Example: string
ecm_flagstring
Example: yes
employee_levelstring
Example: string
end_kmsinteger
Example: 0
end_kms_datestring
Example: 2026-05-25
end_kms_valid_flagstring
Example: string
engine_capstring
Example: string
engine_numberstring
Example: string
establishment_feenumber
Example: 0
establishment_fee_funded_flagstring
Example: yes
etag_order_status_idstring
Example: string
excess_km_ratenumber
Example: 0
extended_warranty_collectednumber
Example: 0
extended_warranty_policy_numberstring
Example: string
external_code_1linkstring
Example: string
facility_type_idstring
Example: string
fbt_benefit_typestring
Example: statutory
fbt_business_usenumber
Example: 0
fbt_email_flagstring
Example: yes
fbt_liability_end_datestring
Example: 2026-05-25
fbt_reduced_valuenumber
Example: 0
fbt_reduced_value_datestring
Example: 2026-05-25
fbt_statutory_rate_datestring
Example: 2026-05-25
fbt_treatment_typestring
Example: standard
fbt_valuenumber
Example: 0
finance_advance_arrearsstring
Example: advance
finance_due_dayinteger
Example: 0
finance_endstring
Example: 2026-05-25
finance_pmt_code_initialstring
Example: string
finance_pmt_code_regularstring
Example: string
finance_pmt_code_startstring
Example: string
finance_pmt_finalnumber
Example: 0
finance_pmt_first_datestring
Example: 2026-05-25
finance_pmt_initialnumber
Example: 0
finance_pmt_regularnumber
Example: 0
finance_ratenumber
Example: 0
finance_refstring
Example: string
finance_self_billingstring
Example: yes
finance_startstring
Example: 2026-05-25
finance_uuidstring
Example: string
finance_vehicle_purchase_grossnumber
Example: 0
finance_vehicle_purchase_gstnumber
Example: 0
finance_vehicle_supplier_idstring
Example: string
financier_idstring
Example: string
flag_depreciation_limitstring
Example: string
flag_new_vehiclestring
Example: string
flag_tax_exemptionstring
Example: string
forecast_sales_valuenumber
Example: 0
fuel_capacityinteger
Example: 0
fuel_card_flagstring
Example: yes
fuel_card_orderedstring
Example: yes
fuel_card_pinstring
Example: string
fuel_consumption_lower_limitnumber
Example: 0
fuel_consumption_upper_limitnumber
Example: 0
fuel_typestring
Example: string
funding_sourcestring
Example: string
gap_insurance_collectednumber
Example: 0
gap_policy_numberstring
Example: string
gst_on_interestnumber
Example: 0
imeistring
Example: string
imei_status_flagstring
Example: active
inertia_flagstring
Example: no
initial_billingsinteger
Example: 0
insurance_basenumber
Example: 0
insurance_billing_frequencystring
Example: string
insurance_billing_typestring
Example: string
insurance_broker_fee_monthlynumber
Example: 0
insurance_cancelledstring
Example: 2026-05-25
insurance_categorystring
Example: string
insurance_claim_excessnumber
Example: 0
insurance_customer_annualnumber
Example: 0
insurance_fire_service_levynumber
Example: 0
insurance_funded_basenumber
Example: 0
insurance_high_performance_flagstring
Example: yes
insurance_inception_monthstring
Example: string
insurance_market_valuenumber
Example: 0
insurance_nominated_1string
Example: string
insurance_nominated_2string
Example: string
insurance_policy_nostring
Example: string
insurance_renewalstring
Example: 2026-05-25
insurance_self_billingstring
Example: yes
insurance_stamp_dutynumber
Example: 0
insurance_startstring
Example: 2026-05-25
insurance_terminteger
Example: 0
insurance_typestring
Example: string
insurance_under_25string
Example: string
insurance_windscreen_protection_flagstring
Example: yes
interest_ratenumber
Example: 0
interior_colourstring
Example: string
introducer_feenumber
Example: 0
key_nostring
Example: string
last_editstring
Example: YYYY-MM-DD HH:MM:SS
list_pricenumber
Example: 0
list_price_gstnumber
Example: 0
list_price_netnumber
Example: 0
locationstring
Example: Sydney
log_book_datestring
Example: 2026-05-25
luxury_car_taxnumber
Example: 0
luxury_car_tax_exempt_flagstring
Example: yes
maintenance_cost_per_1000_kms_limitnumber
Example: 0
manufacturer_codestring
Example: string
manufacturer_model_codestring
Example: string
manufacturer_namestring
Example: string
margin_gstnumber
Example: 0
margin_netnumber
Example: 0
market_pricenumber
Example: 0
market_valuenumber
Example: 0
mini_leasestring
Example: string
model_codestring
Example: string
model_namestring
Example: string
motor_club_renewalstring
Example: 2026-05-25
motor_club_statusstring
Example: string
mth_residual_reservenumber
Example: 0
name_on_accountstring
Example: string
notesstring
Example: string
nvic_codestring
Example: string
on_order_flagstring
Example: yes
on_road_costnumber
Example: 0
on_road_price_gstnumber
Example: 0
on_road_price_netnumber
Example: 0
options_notesstring
Example: string
order_follow_upstring
Example: string
order_manager_user_idstring
Example: string
order_notesstring
Example: string
order_ratenumber
Example: 0
order_requiredstring
Example: 2026-05-25
order_statusstring
Example: string
order_status_idstring
Example: string
order_timestring
Example: string
orderedstring
Example: 2026-05-25
original_finance_amountnumber
Example: 0
originator_feenumber
Example: 0
originator_idstring
Example: 100003
pay_cycle_billing_periodsnumber
Example: 0
pay_cycle_idstring
Example: 100001
payout_datestring
Example: 2026-05-25
payout_methodstring
Example: string
payout_valuenumber
Example: 0
payout_value_gstnumber
Example: 0
penalty_ratenumber
Example: 0
periodic_billingsinteger
Example: 0
periods_deferredinteger
Example: 0
phone_swap_flagstring
Example: yes
pink_slip_receivedstring
Example: yes
pink_slip_requiredstring
Example: yes
policy_owner_typestring
Example: string
posting_map_idstring
Example: 100023
premium_plates_netnumber
Example: 0
programstring
Example: Program A
purchase_stamp_dutynumber
Example: 0
quote_acceptedstring
Example: 2026-05-25
quote_createdstring
Example: 2026-05-25
quote_idstring
Example: 135725
quoted_residualnumber
Example: 0
radio_pinstring
Example: string
rebate_gstnumber
Example: 0
rebate_netnumber
Example: 0
red_book_codestring
Example: string
redundancy_collectednumber
Example: 0
redundancy_policy_numberstring
Example: string
reg_bpay_refstring
Example: string
reg_initial_netnumber
Example: 0
reg_managed_flagstring
Example: yes
reg_nostring
Example: FQX123
reg_renewalstring
Example: 2026-05-25
reg_statestring
Example: string
registered_ownerstring
Example: string
registrationstring
Example: 2026-05-25
registration_tokenstring
Example: string
rego_papers_receivedstring
Example: yes
relief_vehicle_statusstring
Example: string
report_finance_payments_flagstring
Example: yes
reserve_price_gstnumber
Example: 0
reserve_price_netnumber
Example: 0
residual_due_datestring
Example: 2026-05-25
residual_insurer_feenumber
Example: 0
residual_reservenumber
Example: 0
revs_feenumber
Example: 0
revs_numberstring
Example: string
revs_statusstring
Example: string
roadside_end_datestring
Example: 2026-05-25
roadside_managed_flagstring
Example: yes
roadside_start_datestring
Example: 2026-05-25
roadside_terminteger
Example: 0
sale_method_idstring
Example: string
sale_price_grossnumber
Example: 0
sale_price_gstnumber
Example: 0
sale_status_datestring
Example: 2026-05-25
sale_status_idstring
Example: string
security_depositnumber
Example: 0
service_interval_kminteger
Example: 0
service_interval_monthsinteger
Example: 0
small_damage_repairs_collectednumber
Example: 0
sold_datestring
Example: 2026-05-25
sold_to_orderstring
Example: string
sold_to_referencestring
Example: string
start_odometerinteger
Example: 0
start_odometer_datestring
Example: 2026-05-25
statestring
Example: NSW
state_authority_account_numberstring
Example: string
state_authority_vehicle_ref_numberstring
Example: string
supplier_idstring
Example: 100453
supplier_id_brokerstring
Example: string
supplier_id_etagstring
Example: 100470
supplier_id_insurerstring
Example: string
supplier_id_introducerstring
Example: string
supplier_id_preferredstring
Example: 100454
supplier_id_resid_insstring
Example: string
supplier_id_roadsidestring
Example: string
supplier_referencestring
Example: SUP-REF-001
suspend_datestring
Example: 2026-05-25
tag_account_numberstring
Example: string
tag_managed_flagstring
Example: yes
tag_numberstring
Example: string
tag_sidostring
Example: string
terminteger
Example: 60
terminated_datestring
Example: 2026-05-25
third_partystring
Example: no
third_party_endstring
Example: 2031-04-30
third_party_lease_idstring
Example: string
third_party_lease_kmsinteger
Example: 0
third_party_lease_rate_netnumber
Example: 0
third_party_lease_terminteger
Example: 0
third_party_startstring
Example: 2026-05-01
third_party_start_odometerinteger
Example: 0
total_brokeragenumber
Example: 0
total_optionsnumber
Example: 0
total_options_gstnumber
Example: 0
transmissionstring
Example: string
trim_requestedstring
Example: string
tyre_allowancestring
Example: string
tyre_codestring
Example: string
tyre_namestring
Example: string
tyre_specstring
Example: string
tyres_per_setinteger
Example: 0
under_repair_flagstring
Example: no
user_id_last_editstring
Example: string
variant_idstring
Example: 184796
variant_namestring
Example: string
vehicle_typestring
Example: string
vinstring
Example: string
walkaway_collectednumber
Example: 0
walkaway_policy_numberstring
Example: string
warranty_expirystring
Example: 2026-05-25
warranty_kmstring
Example: string
warranty_monthsinteger
Example: 0

Still need help? Ask the team