Drivers

Update a list of drivers

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

PUT

/fm/drivers

curl --request PUT \
  --url https://api.catch-e.com/fm/drivers \
  --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": "<string>",
    "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

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

itemsobject[]

Show child attributes

Response

Drivers updated successfully

bodyobject

Still need help? Ask the team