getContracts

getContracts

Overview

This API allows you to return a list of Contracts

Visit https://api.catch-e.com/docs/#/Contracts/getContracts

Permissions

The permission for this API is stored in [gb_api_permissions]permission as 'Contracts:Get'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

API access to this function is provided to the role 'web-services' as the default setting.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

URL Examples

https://api.demo.catch-e.com/authenticate
https://api.{{environment}}.catch-e.com/authenticate
https://api.catch-e.com/fm/contracts

Input Fields (Header)

JSON Field

Format

Notes

Mandatory

client_code

String

Client ID

No

client_cost_centre_id

String

Client Code. Supports the wildcard % operator (see Wildcard notes).

No

client_group_code

String

Client Group Code. Supports the wildcard % operator (see Wildcard notes).

No

client_type

String

Client Type

No

name

String

Client Name. Supports the wildcard % operator (see Wildcard notes).

No

contact1_name

String

Contact 1 Name. Supports the wildcard % operator (see Wildcard notes).

No

include_active_flag

String

Set to "yes" if inactive clients are required in the list. Note: deleted records cannot be returned.

No

Response Details

Validation Messages

Comments

200 Success

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

Error Response Details

Validation Messges

Comments

401 Unauthorized

  1. You have not authenticated before running this API or

  2. The token_timeout of the current session has passed. You need to authenticate again.

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Unauthorized"
}

403 Forbidden

  • You do not have permissions for this request.

  • Go to System Roles and enter 'web_services'

  • Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

{
    "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
    "title": "Forbidden",
    "status": 403,
    "detail": "Forbidden"
}

404 - Not Found

  • Invalid or unrecognised Contract ID

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Not Found",
  "status": 404,
  "detail": "Not Found"
}

406 - Not Acceptable

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Not Acceptable",
  "status": 406,
  "detail": "Not Acceptable"
}

409 - Conflict

{
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html",
  "title": "Conflict",
  "status": 409,
  "detail": "Invalid page provided"
}

500 - Internal Error

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }

default - Unexpected Error

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "string", "status": 599, "detail": "string" }