This method updates an existing client record using the PATCH method.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Clients/patchClient

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / APIs and check on Clients:Update.

Note: This API is not configured for external use. Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/fm/clients/{client_id}

Headers

Body (JSON)

Include any of the client fields you wish to update. Only the fields you specify will be modified. Refer to the CreateClient endpoint for the full list of available fields.

{ "name": "Updated Client Name", "phone": "03 9999 8888", "client_defaults": { "novated_commission_rate": "0.0123" } } 

Response Details

Successful Response Example

A successful PATCH request returns the complete updated client object with all fields hydrated:

{ "bespoke_field_values": [], "inclusion_client_exclusions": [], "client_defaults": { "client_default_id": "100544", "client_id": "100547", "client_group_flag": "no", "relief_vehicle_flag": "yes", "delivery_fee_funded_flag": "no", "fuel_on_delivery_funded_flag": "no", "supplier_id_financier": null, "policy_owner_type": "driver", "supplier_id_insurer": null, "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.0123, "insurance_broker_fee_exempt_flag": "yes", "carbon_emission_offset_flag": "yes", "roadside_assistance_plan_code": "", "accident_management_fee": 0 }, "client_id": "100547", "client_id_external": "0", "client_code": "Test002", "client_id_parent": "0", "name": "Test API-20554", "channel_id": "0", "client_type": "lead", "client_industry_id": "0", "client_credit_ratings_id": null, "sic_code": "", "financial_year_end": "June", "company_tax_rate": 0, "user_id": "11244", "user_id_sales": "11244", "address1": null, "address2": null, "area": null, "state": null, "pcode": null, "country_id": null, "phone": null, "mobile": null, "fax": null, "abn": null, "acn": null, "arbn": null, "corporate_type_id": "0", "business_start_date": "0000-00-00", "contact1_name": null, "contact1_job_title": "", "contact1_phone": null, "contact1_email": null, "contact1_note": null, "contact2_name": null, "contact2_job_title": "", "contact2_phone": null, "contact2_email": null, "contact2_note": null, "contact3_name": null, "contact3_job_title": "", "contact3_phone": null, "contact3_email": null, "contact3_note": null, "contact4_name": null, "contact4_job_title": "", "contact4_phone": null, "contact4_email": null, "contact4_note": null, "contact5_name": "", "contact5_job_title": "", "contact5_phone": "", "contact5_email": null, "contact5_note": "", "guarantor1_name": "", "guarantor1_phone": "", "guarantor2_name": "", "guarantor2_phone": "", "guarantor3_name": "", "guarantor3_phone": "", "payroll_cut_off": "", "potential_fleet_size": 0, "postal_address1": null, "postal_address2": null, "postal_area": null, "postal_state": null, "postal_pcode": null, "postal_country_id": null, "insurer": null, "supplier_id_insurer": null, "supplier_id_broker": null, "policy_number": "", "due_date": null, "supplier_id_repairer": "0", "client_agreement_type_id": "0", "mla_non_standard_flag": "no", "mla_date": null, "facility_type_id": null, "finance_accepted_date": null, "finance_limit": null, "finance_review_date": null, "delivery_fee": null, "establishment_fee": null, "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": null, "residual_fee": null, "interest_margin": null, "management_fee": null, "disposal_fee": 0, "fuel_on_delivery": null, "maintenance_uplift_rate": 0, "fuel_supplier": null, "fuel_managed_flag": null, "foc_car_policy": null, "early_terminations_policy": null, "mla_note": null, "client_class": null, "discount_holden": null, "discount_ford": null, "discount_toyota": null, "discount_mitsubishi": null, "discount_spare1": null, "discount_spare2": null, "discount_spare3": null, "discount_spare4": null, "discount_spare5": null, "pass_on_itcs": null, "contact_note": null, "shared_fleet_flag": "no", "shared_fleet_note": null, "etags_managed_flag": "no", "etags_managed_note": null, "quarterly_rates_flag": "no", "quarterly_rates_note": null, "novated_leases_flag": "no", "novated_leases_note": null, "visit_last_date": "0000-00-00", "visit_next_date": "0000-00-00", "client_group_id": "0", "client_group_note": null, "billing_interval": "monthly", "contract_pay_cycle_from_quote_flag": "no", "periods_deferred": 0, "finance_budget_term_deferred_flag": "no", "budgets_term_deferred_flag": "no", "initial_billings": 0, "periodic_start": 1, "common_day": "1", "report_delivery_type": "email", "billing_type_flag": "periodic", "billing_terms_id": "100014", "booking_billing_type": "billing", "billing_group_email_flag": "no", "billing_email_attachment_type": "pdf", "purchase_order_no": null, "billing_by_client_order_no_flag": "no", "rcti_flag": "no", "payment_method": "eft", "contract_inertia_flag": "no", "bank_bsb": null, "bank_account_number": null, "bank_account_suffix": null, "approval_note": "", "infringement_note": null, "fuel_card_note": null, "booking_note": null, "reg_label_note": null, "send_reg_label_novated": "driver", "send_reg_label_others": "client-contact-1", "recall_notice_note": null, "quote_internal_note": null, "quote_client_note": null, "employer_fbt_type": "full-fbt-payable", "ecm_allowed_flag": null, "fbt_reporting_flag": "no", "fbt_email_novated": "no", "fbt_email_other": "no", "fbt_note": "", "event_ecm_flag": "no", "event_nuds_flag": "no", "history_only_flag": "no", "prospect_start": null, "last_contact_date": null, "next_contact_date": null, "proposal_date": null, "financials_date": null, "lead_time": null, "prospect_priority": null, "prospect_probability": null, "potential_operating": 0, "potential_novated": 0, "potential_finance": 0, "potential_fleet_managed": 0, "no_of_ftes": 0, "target_strike_rate": 0, "competitors": "", "prospect_note": null, "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": 1, "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": "100001", "pay_cycle_id_active_flag": "yes", "payroll_date": "2024-08-01", "pay_cycle_id2": "100002", "pay_cycle_id2_active_flag": "yes", "payroll_date2": "2024-09-01", "pay_cycle_id3": "100003", "pay_cycle_id3_active_flag": "yes", "payroll_date3": "2024-10-01", "payroll_cut_off_days": 0, "packaging_fees_per_year": 0, "packaging_advice_fee": 0, "package_admin_fee": 0, "salary_type": null, "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": "yes", "allow_quoting_within_cap_flag": "no", "interim_service_flag": "yes", "approval_limit": 0, "send_approval_email_flag": "yes", "dirty_flag": "2024-07-01 05:53:14", "_embedded": { "client_packaging_defaults": { "aba_description": "", "aba_self_balancing_flag": "yes", "apca_number": "", "bank_account_enabled_flag": "yes", "bank_account_name": "", "bank_account_name_short": "", "bank_account_number": null, "bank_bsb": null, "client_id": "100547", "client_packaging_default_id": "14728602546281119856", "financial_institution_id": null, "pay_run_processing_state": null, "pay_run_start": 0, "pay_run_start2": 0, "pay_run_start3": 0, "pay_run_weekend_treatment": null, "payroll_fbt": null, "payroll_gst": null, "payroll_itc": null, "payroll_lcc": null, "payroll_post_tax": null, "payroll_pre_tax": null, "report_delivery_type": "email", "report_groups": [], "taxable_sales": "all-items", "_links": { "self": { "href": "https://api.test.catch-e.com/sp/client/packaging-defaults/100547" } } } }, "_links": { "self": { "href": "https://api.test.catch-e.com/fm/clients/100547" } } } 

Error Response Examples

403 Forbidden

{ "detail": "Forbidden" } 

You do not have permissions for this request.

422 Unprocessable Entity

{ "validationMessages": { "fields": { "notInArray": "Unknown field specified" } } } 

The syntax of the fields key is not correct. Having spaces in the list of fields is one possible reason.

Patching Multiple Clients

To patch (update) multiple Client records you can include multiple datasets in a single request. The example shown here is updating the Novated Commission Rate for the first Client record and the Client Name for the second record.

URL Examples

https://api.catch-e.com/fm/clients

Input Fields (JSON)

[ { "client_id": "100000", "client_defaults": { "novated_commission_rate": "0.0123" } }, { "client_id": "100001", "name": "Updated Client Name" } ] 

The response will return all updated clients with their modified fields and all associated client defaults and packaging defaults records.