Clients

Create clients

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

POST

/fm/clients

Create clients

curl --request POST \
  --url https://api.catch-e.com/fm/clients \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Time-Zone: UTC' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "abn": "<string>",
    "acn": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "address_detail_pid": "GAVIC424617164",
    "advance_arrears": "advance",
    "agreed_lessee_rate": 123,
    "allow_operating_fbt_type_flag": "yes",
    "allow_quoting_flag": "no",
    "allow_quoting_within_cap_flag": "yes",
    "approval_limit": 123,
    "approval_note": "<string>",
    "arbn": "<string>",
    "area": "<string>",
    "bank_account_number": "<string>",
    "bank_account_suffix": "<string>",
    "bank_bsb": "<string>",
    "bespoke_field_values": {},
    "billing_by_client_order_no_flag": "no",
    "billing_email_attachment_type": "pdf",
    "billing_group_email_flag": "no",
    "billing_interval": "monthly",
    "billing_terms_id": "<string>",
    "billing_type_flag": "any",
    "booking_billing_type": "billing",
    "booking_note": "<string>",
    "budgets_term_deferred_flag": "yes",
    "business_start_date": "2023-12-25",
    "car_allowance_impact_flag": "no",
    "channel_id": "<string>",
    "client_agreement_type_id": "<string>",
    "client_class": "<string>",
    "client_code": "<string>",
    "client_credit_ratings_id": "<string>",
    "client_defaults": {
      "accident_management_fee": 123,
      "carbon_emission_offset_flag": "yes",
      "client_group_flag": "no",
      "delivery_fee_funded_flag": "no",
      "establishment_fee": 123,
      "excess_km_rate": 123,
      "fuel_on_delivery_funded_flag": "no",
      "insurance_broker_fee_exempt_flag": "yes",
      "maintenance_program_fee": 123,
      "management_fee": 123,
      "novated_commission_rate": 123,
      "novated_residual_basis": "on-road-price",
      "policy_owner_type": "insurer_internal",
      "relief_vehicle_flag": "yes",
      "residual_margin_rate": 123,
      "residual_margin_rate_commercial": 123,
      "roadside_assistance_plan_code": "<string>",
      "supplier_id_financier": "<string>",
      "supplier_id_insurer": "<string>"
    },
    "client_group_id": "<string>",
    "client_group_note": "<string>",
    "client_id_external": "<string>",
    "client_id_parent": "<string>",
    "client_industry_id": "<string>",
    "client_type": "fleet",
    "common_day": 1,
    "company_tax_rate": 123,
    "competitors": "<string>",
    "contact1_email": "jsmith@example.com",
    "contact1_job_title": "<string>",
    "contact1_name": "<string>",
    "contact1_note": "<string>",
    "contact1_phone": "<string>",
    "contact2_email": "jsmith@example.com",
    "contact2_job_title": "<string>",
    "contact2_name": "<string>",
    "contact2_note": "<string>",
    "contact2_phone": "<string>",
    "contact3_email": "jsmith@example.com",
    "contact3_job_title": "<string>",
    "contact3_name": "<string>",
    "contact3_note": "<string>",
    "contact3_phone": "<string>",
    "contact4_email": "jsmith@example.com",
    "contact4_job_title": "<string>",
    "contact4_name": "<string>",
    "contact4_note": "<string>",
    "contact4_phone": "<string>",
    "contact5_email": "jsmith@example.com",
    "contact5_job_title": "<string>",
    "contact5_name": "<string>",
    "contact5_note": "<string>",
    "contact5_phone": "<string>",
    "contact_note": "<string>",
    "contract_inertia_flag": "no",
    "contract_pay_cycle_from_quote_flag": "yes",
    "corporate_type_id": "<string>",
    "cost_centres_mandatory_flag": "no",
    "country_id": "<string>",
    "delivery_fee": 123,
    "discount_ford": "<string>",
    "discount_holden": "<string>",
    "discount_mitsubishi": "<string>",
    "discount_spare1": "<string>",
    "discount_spare2": "<string>",
    "discount_spare3": "<string>",
    "discount_spare4": "<string>",
    "discount_spare5": "<string>",
    "discount_toyota": "<string>",
    "disposal_fee": 123,
    "document_fee": 123,
    "document_fee_budgeted": 123,
    "due_date": "2023-12-25",
    "early_terminations_policy": "<string>",
    "ecm_allowed_flag": "no",
    "ecm_flag": "yes",
    "employer_fbt_type": "full-fbt-payable",
    "establishment_fee": 123,
    "etags_managed_flag": "yes",
    "etags_managed_note": "<string>",
    "event_ecm_flag": "no",
    "event_nuds_flag": "no",
    "facility_type_id": "<string>",
    "fax": "<string>",
    "fbt_email_novated": "no",
    "fbt_email_other": "no",
    "fbt_note": "<string>",
    "fbt_reporting_flag": "no",
    "finance_accepted_date": "2023-12-25",
    "finance_budget_term_deferred_flag": "yes",
    "finance_limit": 123,
    "finance_review_date": "2023-12-25",
    "financial_year_end": "January",
    "financials_date": "2023-12-25",
    "fixed_statutory_rate": 123,
    "fixed_super_rate": 123,
    "foc_car_policy": "<string>",
    "free_km_buffer": 123,
    "fuel_card_note": "<string>",
    "fuel_fee": 123,
    "fuel_managed_flag": "yes",
    "fuel_on_delivery": 123,
    "fuel_supplier": "<string>",
    "gross_up_rate_type": "fbt_type1_gross_up_factor",
    "gst_on_ecm_flag": "yes",
    "guarantor1_name": "<string>",
    "guarantor1_phone": "<string>",
    "guarantor2_name": "<string>",
    "guarantor2_phone": "<string>",
    "guarantor3_name": "<string>",
    "guarantor3_phone": "<string>",
    "history_only_flag": "no",
    "inclusion_client_exclusions": [
      "<string>"
    ],
    "infringement_note": "<string>",
    "initial_billings": 123,
    "insurer": "<string>",
    "interest_margin": 123,
    "interim_service_flag": "yes",
    "invoice_options": "detail-only",
    "itc_passed_on_flag": "yes",
    "itc_passed_on_rate": 123,
    "last_contact_date": "2023-12-25",
    "lead_time": 123,
    "lease_replacement_fee": 123,
    "lessee_rate_include_vmp_flag": "no",
    "luxury_charge_applied_flag": "yes",
    "luxury_charge_event_flag": "no",
    "luxury_charge_invoiced_flag": "yes",
    "maintenance_uplift_rate": 123,
    "management_fee": 123,
    "medicare_levy_flag": "yes",
    "mla_date": "2023-12-25",
    "mla_non_standard_flag": "yes",
    "mla_note": "<string>",
    "mobile": "<string>",
    "name": "<string>",
    "next_contact_date": "2023-12-25",
    "no_of_ftes": 123,
    "novated_leases_flag": "yes",
    "novated_leases_note": "<string>",
    "novated_management_fee": 123,
    "package_admin_fee": 123,
    "packaging_advice_fee": 123,
    "packaging_fees_per_year": 123,
    "pass_on_itcs": "<string>",
    "pay_cycle_id": "<string>",
    "pay_cycle_id2": "<string>",
    "pay_cycle_id2_active_flag": "no",
    "pay_cycle_id3": "<string>",
    "pay_cycle_id3_active_flag": "no",
    "pay_cycle_id_active_flag": "no",
    "payment_method": "direct-debit",
    "payroll_cut_off": "<string>",
    "payroll_cut_off_days": 123,
    "payroll_date": "2023-12-25",
    "payroll_date2": "2023-12-25",
    "payroll_date3": "2023-12-25",
    "pcode": "<string>",
    "periodic_start": 123,
    "periods_deferred": 123,
    "phone": "<string>",
    "policy_number": "<string>",
    "postal_address1": "<string>",
    "postal_address2": "<string>",
    "postal_address_detail_pid": "GAVIC424617164",
    "postal_area": "<string>",
    "postal_country_id": "<string>",
    "postal_pcode": "<string>",
    "postal_state": "VIC",
    "potential_finance": 123,
    "potential_fleet_managed": 123,
    "potential_fleet_size": 123,
    "potential_novated": 123,
    "potential_operating": 123,
    "print_finance_flag": "no",
    "proposal_date": "2023-12-25",
    "prospect_note": "<string>",
    "prospect_priority": "",
    "prospect_probability": "20%",
    "prospect_start": "2023-12-25",
    "purchase_order_no": "<string>",
    "purchase_stamp_duty_exempt_flag": "no",
    "quarterly_rates_flag": "yes",
    "quarterly_rates_note": "<string>",
    "quote_client_note": "<string>",
    "quote_internal_note": "<string>",
    "rcti_flag": "no",
    "recall_notice_note": "<string>",
    "reg_ctp_type": "business",
    "reg_label_note": "<string>",
    "report_delivery_type": "email",
    "residual_fee": 123,
    "residual_margin": 123,
    "return_itc_via_payroll_flag": "no",
    "revs_fee": 123,
    "salary_type": "total-package",
    "send_approval_email_flag": "yes",
    "send_reg_label_novated": "driver",
    "send_reg_label_others": "client-contact-1",
    "shared_fleet_flag": "yes",
    "shared_fleet_note": "<string>",
    "sic_code": "<string>",
    "sl_export_flag": "yes",
    "sourcing_fee": 123,
    "state": "VIC",
    "supplier_id_broker": "<string>",
    "supplier_id_insurer": "<string>",
    "supplier_id_repairer": "<string>",
    "target_strike_rate": 123,
    "user_id": "<string>",
    "user_id_sales": "<string>",
    "visit_last_date": "2023-12-25",
    "visit_next_date": "2023-12-25",
    "wear_tear_allowance": 123
  }
]
'

{
  "_embedded": {
    "fm_clients": [
      {
        "abn": "<string>",
        "acn": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "address_detail_pid": "GAVIC424617164",
        "advance_arrears": "advance",
        "agreed_lessee_rate": 123,
        "allow_operating_fbt_type_flag": "yes",
        "allow_quoting_flag": "no",
        "allow_quoting_within_cap_flag": "yes",
        "approval_limit": 123,
        "approval_note": "<string>",
        "arbn": "<string>",
        "area": "<string>",
        "bank_account_number": "<string>",
        "bank_account_suffix": "<string>",
        "bank_bsb": "<string>",
        "bespoke_field_values": {},
        "billing_by_client_order_no_flag": "no",
        "billing_email_attachment_type": "pdf",
        "billing_group_email_flag": "no",
        "billing_interval": "monthly",
        "billing_terms_id": "<string>",
        "billing_type_flag": "any",
        "booking_billing_type": "billing",
        "booking_note": "<string>",
        "budgets_term_deferred_flag": "yes",
        "business_start_date": "2023-12-25",
        "car_allowance_impact_flag": "no",
        "channel_id": "<string>",
        "client_agreement_type_id": "<string>",
        "client_class": "<string>",
        "client_code": "<string>",
        "client_credit_ratings_id": "<string>",
        "client_defaults": {
          "accident_management_fee": 123,
          "carbon_emission_offset_flag": "yes",
          "client_default_id": "<string>",
          "client_group_flag": "no",
          "delivery_fee_funded_flag": "no",
          "establishment_fee": 123,
          "excess_km_rate": 123,
          "fuel_on_delivery_funded_flag": "no",
          "insurance_broker_fee_exempt_flag": "yes",
          "maintenance_program_fee": 123,
          "management_fee": 123,
          "novated_commission_rate": 123,
          "novated_residual_basis": "on-road-price",
          "policy_owner_type": "insurer_internal",
          "relief_vehicle_flag": "yes",
          "residual_margin_rate": 123,
          "residual_margin_rate_commercial": 123,
          "roadside_assistance_plan_code": "<string>",
          "supplier_id_financier": "<string>",
          "supplier_id_insurer": "<string>"
        },
        "client_group_id": "<string>",
        "client_group_note": "<string>",
        "client_id": "<string>",
        "client_id_external": "<string>",
        "client_id_parent": "<string>",
        "client_industry_id": "<string>",
        "client_type": "fleet",
        "common_day": 1,
        "company_tax_rate": 123,
        "competitors": "<string>",
        "contact1_email": "jsmith@example.com",
        "contact1_job_title": "<string>",
        "contact1_name": "<string>",
        "contact1_note": "<string>",
        "contact1_phone": "<string>",
        "contact2_email": "jsmith@example.com",
        "contact2_job_title": "<string>",
        "contact2_name": "<string>",
        "contact2_note": "<string>",
        "contact2_phone": "<string>",

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

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

Quote events will be shown 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

Client 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