Clients

Copy client

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

POST

/fm/clients/{client_id}/copy

Copy client

curl --request POST \
  --url https://api.catch-e.com/fm/clients/{client_id}/copy \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Time-Zone: UTC' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'client_code=%3Cstring%3E'

{
  "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>",
  "contact3_email": "jsmith@example.com",
  "contact3_job_title": "<string>",
  "contact3_name": "<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

Path Parameters

client_idstringrequired

Source Client Id

Maximum string length: 10

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

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

Client will be processed 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

client_codestringrequired

Target Client Code

Maximum string length: 64

Response

Success

abnstring

acnstring

address1string

address2string

address_detail_pidstring

Example: GAVIC424617164

advance_arrearsenum<string>default:advance

Available options: advance, arrears

agreed_lessee_ratenumber

allow_operating_fbt_type_flagenum<string>default:yes

Available options: yes, no

allow_quoting_flagenum<string>default:no

Available options: yes, no

allow_quoting_within_cap_flagenum<string>default:yes

Available options: yes, no

approval_limitnumber

approval_notestring

arbnstring

areastring

bank_account_numberstring

bank_account_suffixstring

bank_bsbstring

bespoke_field_valuesobject

billing_by_client_order_no_flagenum<string>default:no

Available options: yes, no

billing_email_attachment_typeenum<string>default:pdf

Available options: pdf, csv, pdf-and-csv

billing_group_email_flagenum<string>default:no

Available options: yes, no

billing_intervalenum<string>default:monthly

Available options: weekly, fortnightly, monthly, bi-annually, annually, period

billing_terms_idstring

billing_type_flagenum<string>default:any

Available options: any, periodic, combined

booking_billing_typeenum<string>default:billing

Available options: single, billing

booking_notestring

budgets_term_deferred_flagenum<string>

Available options: yes, no

business_start_datestring

car_allowance_impact_flagenum<string>default:no

Available options: yes, no

channel_idstring

client_agreement_type_idstring

client_classstring

client_codestring

client_credit_ratings_idstring

client_defaultsobject

Client Defaults

Show child attributes

client_group_idstring

client_group_notestring

client_idstring

client_id_externalstring

client_id_parentstring

client_industry_idstring

client_typeenum<string>

Available options: fleet, prospect, sundry, inactive, lead

common_dayenum<string>default:1

Available options: monday, tuesday, wednesday, thursday, friday, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, eom

company_tax_ratenumber

competitorsstring

contact1_emailstring

contact1_job_titlestring

contact1_namestring

contact1_notestring

contact1_phonestring

contact2_emailstring

contact2_job_titlestring

contact2_namestring

contact2_notestring

contact2_phonestring

contact3_emailstring

contact3_job_titlestring

contact3_namestring

contact3_notestring

contact3_phonestring

contact4_emailstring

contact4_job_titlestring

contact4_namestring

contact4_notestring

contact4_phonestring

contact5_emailstring

contact5_job_titlestring

contact5_namestring

contact5_notestring

contact5_phonestring

contact_notestring

contract_inertia_flagenum<string>default:no

Available options: yes, no

contract_pay_cycle_from_quote_flagenum<string>

Available options: yes, no

corporate_type_idstring

cost_centres_mandatory_flagenum<string>default:no

Available options: yes, no

country_idstring

delivery_feenumber

dirty_flagstring

discount_fordstring

discount_holdenstring

discount_mitsubishistring

discount_spare1string

discount_spare2string

discount_spare3string

discount_spare4string

discount_spare5string

discount_toyotastring

disposal_feenumber

document_feenumber

document_fee_budgetednumber

due_datestring

early_terminations_policystring

ecm_allowed_flagenum<string>

Available options: no, yes

ecm_flagenum<string>default:yes

Available options: yes, no

employer_fbt_typeenum<string>default:full-fbt-payable

Available options: full-fbt-payable, concessional-30000-exempt, concessional-17000-exempt, rebatable, not-applicable

establishment_feenumber

etags_managed_flagenum<string>

Available options: yes, no

etags_managed_notestring

event_ecm_flagenum<string>default:no

Available options: yes, no

event_nuds_flagenum<string>default:no

Available options: yes, no

facility_type_idstring

faxstring

fbt_email_novatedenum<string>default:no

Available options: yes, no

fbt_email_otherenum<string>default:no

Available options: yes, no

fbt_notestring

fbt_reporting_flagenum<string>default:no

Available options: yes, no

finance_accepted_datestring

finance_budget_term_deferred_flagenum<string>

Available options: yes, no

finance_limitnumber

finance_review_datestring

financial_year_endenum<string>

Available options: January, February, March, April, May, June, July, August, September, October, November, December

financials_datestring

fixed_statutory_ratenumber

fixed_super_ratenumber

foc_car_policystring

free_km_bufferinteger

fuel_card_notestring

fuel_feenumber

fuel_managed_flagenum<string>

Available options: yes, no

fuel_on_deliverynumber

fuel_supplierstring

gross_up_rate_typeenum<string>default:fbt_type1_gross_up_factor

Available options: fbt_type1_gross_up_factor, fbt_type2_gross_up_factor

gst_on_ecm_flagenum<string>default:yes

Available options: yes, no

guarantor1_namestring

guarantor1_phonestring

guarantor2_namestring

guarantor2_phonestring

guarantor3_namestring

guarantor3_phonestring

history_only_flagenum<string>default:no

Available options: yes, no

inclusion_client_exclusionsstring[]

Inclusion Client Exclusions

infringement_notestring

initial_billingsinteger

insurerstring

interest_marginnumber

interim_service_flagenum<string>default:yes

Available options: yes, no

invoice_optionsenum<string>default:detail-only

Available options: detail-only, summary-only, summary-and-detail

itc_passed_on_flagenum<string>default:yes

Available options: yes, no

itc_passed_on_ratenumber

last_contact_datestring

lead_timeinteger

lease_replacement_feenumber

lessee_rate_include_vmp_flagenum<string>default:no

Available options: yes, no

luxury_charge_applied_flagenum<string>default:yes

Available options: yes, no

luxury_charge_event_flagenum<string>default:no

Available options: yes, no

luxury_charge_invoiced_flagenum<string>default:yes

Available options: yes, no

maintenance_uplift_ratenumber

management_feenumber

medicare_levy_flagenum<string>default:yes

Available options: yes, no

mla_datestring

mla_non_standard_flagenum<string>

Available options: yes, no

mla_notestring

mobilestring

namestring

next_contact_datestring

no_of_ftesinteger

novated_leases_flagenum<string>

Available options: yes, no

novated_leases_notestring

novated_management_feenumber

package_admin_feenumber

packaging_advice_feenumber

packaging_fees_per_yearnumber

pass_on_itcsstring

pay_cycle_idstring

pay_cycle_id2string

pay_cycle_id2_active_flagenum<string>default:no

Available options: yes, no

pay_cycle_id3string

pay_cycle_id3_active_flagenum<string>default:no

Available options: yes, no

pay_cycle_id_active_flagenum<string>default:no

Available options: yes, no

payment_methodenum<string>

Available options: direct-debit, cheque, cash, other, credit-card, eft

payroll_cut_offstring

payroll_cut_off_daysinteger

payroll_datestring

payroll_date2string

payroll_date3string

pcodestring

periodic_startinteger

periods_deferredinteger

phonestring

policy_numberstring

postal_address1string

postal_address2string

postal_address_detail_pidstring

Example: GAVIC424617164

postal_areastring

postal_country_idstring

postal_pcodestring

postal_stateenum<string>

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

potential_financeinteger

potential_fleet_managedinteger

potential_fleet_sizeinteger

potential_novatedinteger

potential_operatinginteger

print_finance_flagenum<string>default:no

Available options: yes, no

proposal_datestring

prospect_notestring

prospect_priorityenum<string>

Available options: , High, Medium, Low

prospect_probabilityenum<string>

Available options: 20%, 40%, 60%, 80%, 100%

prospect_startstring

purchase_order_nostring

purchase_stamp_duty_exempt_flagenum<string>default:no

Available options: yes, no

quarterly_rates_flagenum<string>

Available options: yes, no

quarterly_rates_notestring

quote_client_notestring

quote_internal_notestring

rcti_flagenum<string>default:no

Available options: yes, no

recall_notice_notestring

reg_ctp_typeenum<string>default:business

Available options: business, private

reg_label_notestring

report_delivery_typeenum<string>default:email

Available options: email, post

residual_feenumber

residual_marginnumber

return_itc_via_payroll_flagenum<string>default:no

Available options: yes, no

revs_feenumber

salary_typeenum<string>

Available options: total-package, base-only, base-plus-super, fixed-super

send_approval_email_flagenum<string>default:yes

Available options: yes, no

send_reg_label_novatedenum<string>default:driver

Available options: not-applicable, driver, client-contact-1, client-contact-2, account-payable, account-manager

send_reg_label_othersenum<string>default:client-contact-1

Available options: not-applicable, driver, client-contact-1, client-contact-2, account-payable, account-manager

shared_fleet_flagenum<string>

Available options: yes, no

shared_fleet_notestring

sic_codestring

sl_export_flagenum<string>

Available options: yes, no

sourcing_feenumber

stateenum<string>

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

supplier_id_brokerstring

supplier_id_insurerstring

supplier_id_repairerstring

target_strike_rateinteger

user_idstring

user_id_salesstring

visit_last_datestring

visit_next_datestring

wear_tear_allowancenumber

Still need help? Ask the team