Clients

Get a list of clients

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

GET

/fm/clients

curl --request GET \
  --url 'https://api.catch-e.com/fm/clients?client_code=%3Cstring%3E&client_group_code=%3Cstring%3E&client_type=%3Cstring%3E&name=%3Cstring%3E&contact1_name=%3Cstring%3E&include_inactive_flag=no&fields=%3Cstring%3E&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_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

Query Parameters

client_codestringquery

Optional Client Code

This field supports the wildcard % operator.

client_group_codestringquery

Optional Client Group Code

This field supports the wildcard % operator.

client_typestringquery

Optional Client Type

namestringquery

Optional Name

This field supports the wildcard % operator.

contact1_namestringquery

Optional Contact1 Name

This field supports the wildcard % operator.

include_inactive_flagenum<string>querydefault:no

Set to yes if inactive Clients required in the list. Note 'deleted' records cannot be returned.

Available options: yes, no

fieldsstring[]query

Define fields required. If no fields are specified, then all fields are returned.

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_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