Drivers

Update a driver

This method requires the Drivers:Update permission to be associated with your role.

PUT

/fm/drivers/{driver_id}

Update a driver

curl --request PUT \
  --url https://api.catch-e.com/fm/drivers/{driver_id} \
  --header 'Authorization: <api-key>' \
  --header 'Delegated-Locking-Session-Id: <string>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'

{}

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

driver_idstringrequired

Driver Id

Maximum string length: 10

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

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]*$

Body

JSON payload

accountant_contact_namestringdefault:

accountant_contact_phonestringdefault:

accountant_firm_namestringdefault:

address_id_homestringdefault:null

Do not specify this value if you provide an addresses property

address_id_poststringdefault:null

Do not specify this value if you provide an addresses property

addressesobject

Show child attributes

allowancesnumberdefault:0

annual_salarynumberdefault:0

asset_bank_accountsnumber

asset_bank_accounts_descriptionstringdefault:

asset_furniturenumber

asset_furniture_descriptionstringdefault:

asset_investment_propertiesnumber

asset_investment_properties_descriptionstringdefault:

asset_motor_vehiclenumber

asset_motor_vehicle_descriptionstringdefault:

asset_other_investmentsnumber

asset_other_investments_descriptionstringdefault:

asset_resident_propertynumber

asset_resident_property_descriptionstringdefault:

asset_sharesnumber

asset_shares_descriptionstringdefault:

asset_supernumber

asset_super_descriptionstringdefault:

ato_loan_flagenum<string>default:no

Available options: yes, no

australian_residentenum<string>default:yes

Available options: yes, no

card_account_numberstringdefault:

client_cost_centre_idstringdefault:0

client_idstringdefault:

contact_notestring

corporate_type_id_previous_employerstringdefault:0

createdstringdefault:0000-00-00 00:00:00

credit_check_authorised_flagenum<string>

Available options: yes, no

date_of_birthstringdefault:null

driver_claims_flagenum<string>default:yes

Available options: yes, no

driver_employment_type_idstringdefault:0

driver_id_externalstringdefault:0

driver_lic_expstringdefault:null

driver_licencestringdefault:null

driver_licence_card_numberstringdefault:null

driver_licence_stateenum<string>

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

driver_occupation_code_idstringdefault:0

employee_aliasstringdefault:

employee_areastringdefault:null

employee_endstringdefault:0000-00-00

employee_groupstringdefault:null

employee_nostringdefault:null

employee_pay_officestringdefault:null

employee_sl_accstringdefault:null

employee_startstringdefault:0000-00-00

employee_supernumberdefault:0

employer_address_1stringdefault:

employer_address_2stringdefault:

employer_address_3stringdefault:

employer_address_postcodestringdefault:

employer_address_stateenum<string>

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

employer_supernumberdefault:0

expense_credit_cardnumber

expense_householdnumber

expense_mortgagenumber

expense_othernumber

expense_private_education_childcarenumber

expense_rentnumber

expense_vehiclenumber

external_codestringdefault:

fbt_typestringdefault:null

financier_applicant_referencestringdefault:

genderenum<string>

Available options: Male, Female, Other

generated_passwordstring

given_namestringdefault:null

home_car_postcodestringdefault:null

home_emailstringdefault:null

home_faxstringdefault:null

home_phonestringdefault:null

home_postcodestringdefault:null

home_statestringdefault:null

home_streetstringdefault:null

home_street_nostringdefault:null

home_street_typestringdefault:null

home_suburbstringdefault:null

home_unit_nostringdefault:null

income_government_benefitsnumber

income_grossnumber

income_investmentnumber

income_netnumber

income_othernumber

income_rental_netnumber

income_spouse_grossnumber

income_spouse_netnumber

income_superannuationnumber

insurance_broker_fee_exempt_flagenum<string>default:yes

Available options: yes, no

kyc_verified_flagenum<string>default:no

Available options: yes, no

landlord_namestringdefault:

landlord_telephonestringdefault:

last_editstring

liability_credit_card_limitnumber

liability_credit_card_limit_descriptionstringdefault:

liability_investment_mortgagesnumber

liability_investment_mortgages_descriptionstringdefault:

liability_loansnumber

liability_loans_descriptionstringdefault:

liability_mortgagesnumber

liability_mortgages_descriptionstringdefault:

liability_othernumber

liability_other_descriptionstringdefault:

liability_overdraftnumber

liability_overdraft_descriptionstringdefault:

liability_rentnumber

liability_rent_descriptionstringdefault:

licence_classstringdefault:

marital_statusenum<string>

Available options: de-facto, single, divorced, married, other, separated, widowed

middle_namestringdefault:

mobilestringdefault:null

name_on_accountstringdefault:

no_of_dependentsintegerdefault:null

override_warnings_flagenum<string>

Override warning validation. If not specified, defaults to 'no'

Available options: yes, no

Example: no

pay_cycle_idstringdefault:0

preferred_namestringdefault:null

previous_address_1stringdefault:

previous_address_2stringdefault:

previous_address_3stringdefault:

previous_address_country_idstringdefault:null

previous_address_detail_pidstring

Example: GAVIC424617164

previous_address_postcodestringdefault:

previous_address_stateenum<string>

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

previous_address_years_at_addressnumberdefault:0

previous_employer_abnstring

previous_employer_namestringdefault:

previous_employer_phonestringdefault:

previous_years_employednumberdefault:0

report_delivery_typeenum<string>default:email

Available options: self-service, email, post

residency_statusenum<string>

Available options: citizen, permanent-resident, visa, non-resident

residential_statusenum<string>

Available options: own, buying, rent, board, live-with-parents

salutationenum<string>

Available options: Mr, Mrs, Ms, Miss, Mx, Dr, Prof, Rev, Capt

start_at_addressstringdefault:0000-00-00

stop_becs_flagenum<string>default:no

Available options: yes, no

supplier_id_etagstringdefault:0

supplier_id_financierstringdefault:0

surnamestringdefault:null

tag_account_numberstringdefault:

tag_numberstringdefault:

user_id_package_advisorstringdefault:null

work_contact_givenstringdefault:null

work_contact_positionstringdefault:null

work_contact_surnamestringdefault:null

work_faxstringdefault:null

work_namestringdefault:null

work_phonestringdefault:null

work_phone_extstringdefault:null

work_positionstringdefault:null

work_postcodestringdefault:null

work_statestringdefault:null

work_streetstringdefault:null

work_street_nostringdefault:null

work_street_typestringdefault:null

work_suburbstringdefault:null

work_typestringdefault:null

work_unit_nostringdefault:null

years_at_addressnumberdefault:0

years_with_employernumberdefault:0

Response

Driver updated successfully

bodyobject

Still need help? Ask the team