CreateClients — Body (JSON)

Create Client API Body Fields

Complete reference for client creation and update with all body field specifications.

Core Fields

Field	Format	Notes	Default	Mandatory
client_code	string	Client Code must be unique. Maximum 10 characters.		yes
user_id	number	User ID for A/C Manager field		yes
user_id_sales	number	User ID for Sales field		yes
name	string	Client name. Strongly recommended (used on reports, invoices, quote templates etc)		no
client_id_external	string	External reference	0	no
inclusion_client_exclusions	array	Refer to Clients:Quote defaults for details. Example: { "inclusion_id": "1234567890123456000", "inclusion_id": "1234567890123456001"}		no
client_id_parent	string	Parent client ID	0	no
channel_id	string	Channel ID	0	no
client_type	string	Values: fleet, prospect, sundry, inactive, lead	NULL	no
client_industry_id	string	Industry ID	0	no
client_credit_ratings_id	string	Credit ratings ID	NULL	no
sic_code	string	SIC code		no
financial_year_end	string	Values: January, February, March, April, May, June, July, August, September, October, November, December	June	no
company_tax_rate	number	Tax rate	0	no

Address Fields

Field	Format	Notes	Default	Mandatory
address1	string	Street address line 1	NULL	no
address2	string	Street address line 2	NULL	no
area	string	Suburb/area	NULL	no
state	string	Values: VIC, NSW, ACT, QLD, WA, SA, TAS, NT, NZ	NULL	no
pcode	string	Postcode	NULL	no
country_id	string	Country ID	NULL	no
postal_address1	string	Postal address line 1	NULL	no
postal_address2	string	Postal address line 2	NULL	no
postal_area	string	Postal suburb/area	NULL	no
postal_state	string	Values: VIC, NSW, ACT, QLD, WA, SA, TAS, NT, NZ	NULL	no
postal_pcode	string	Postal postcode	NULL	no
postal_country_id	string	Postal country ID	NULL	no

Contact Fields

Field	Format	Notes	Default	Mandatory
phone	string	Phone number	NULL	no
mobile	string	Mobile number	NULL	no
fax	string	Fax number	NULL	no
contact1_name	string	Contact 1 name	NULL	no
contact1_job_title	string	Contact 1 job title		no
contact1_phone	string	Contact 1 phone	NULL	no
contact1_email	string	Contact 1 email	NULL	no
contact1_note	string	Contact 1 note	NULL	no
contact2_name	string	Contact 2 name	NULL	no
contact2_job_title	string	Contact 2 job title		no
contact2_phone	string	Contact 2 phone	NULL	no
contact2_email	string	Contact 2 email	NULL	no
contact2_note	string	Contact 2 note	NULL	no
contact3_name	string	Contact 3 name	NULL	no
contact3_job_title	string	Contact 3 job title		no
contact3_phone	string	Contact 3 phone	NULL	no
contact3_email	string	Contact 3 email	NULL	no
contact3_note	string	Contact 3 note	NULL	no
contact4_name	string	Contact 4 name	NULL	no
contact4_job_title	string	Contact 4 job title		no
contact4_phone	string	Contact 4 phone	NULL	no
contact4_email	string	Contact 4 email	NULL	no
contact4_note	string	Contact 4 note	NULL	no
contact5_name	string	Contact 5 name		no
contact5_job_title	string	Contact 5 job title		no
contact5_phone	string	Contact 5 phone		no
contact5_email	string	Contact 5 email	NULL	no
contact5_note	string	Contact 5 note		no
contact_note	string	General contact note	NULL	no

Guarantor Fields

Field	Format	Notes	Default	Mandatory
guarantor1_name	string	Guarantor 1 name		no
guarantor1_phone	string	Guarantor 1 phone		no
guarantor2_name	string	Guarantor 2 name		no
guarantor2_phone	string	Guarantor 2 phone		no
guarantor3_name	string	Guarantor 3 name		no
guarantor3_phone	string	Guarantor 3 phone		no

Company Details

Field	Format	Notes	Default	Mandatory
abn	string	Australian Business Number	NULL	no
acn	string	Australian Company Number	NULL	no
arbn	string	ARBN	NULL	no
corporate_type_id	string	Corporate type ID	0	no
business_start_date	date	Format: yyyy-mm-dd	0000-00-00	no

Insurance & Broker

Field	Format	Notes	Default	Mandatory
insurer	string	Insurer name	NULL	no
supplier_id_insurer	string	Insurer supplier ID	NULL	no
supplier_id_broker	string	Broker supplier ID	NULL	no
policy_number	string	Policy number		no
due_date	date	Policy due date. Format: yyyy-mm-dd	NULL	no
supplier_id_repairer	string	Repairer supplier ID	0	no

Client Agreement & Finance

Field	Format	Notes	Default	Mandatory
client_agreement_type_id	string	Agreement type ID	0	no
mla_non_standard_flag	string	Values: yes, no	no	no
mla_date	date	Format: yyyy-mm-dd	NULL	no
facility_type_id	string	Facility type ID	NULL	no
finance_accepted_date	date	Format: yyyy-mm-dd	NULL	no
finance_limit	number	Finance limit	NULL	no
finance_review_date	date	Format: yyyy-mm-dd	NULL	no

Fees

Field	Format	Notes	Default	Mandatory
delivery_fee	number	Delivery fee	NULL	no
establishment_fee	number	Establishment fee	NULL	no
sourcing_fee	number	Sourcing fee	0	no
document_fee	number	Document fee	0	no
document_fee_budgeted	number	Budgeted document fee	0	no
fuel_fee	number	Fuel fee	0	no
novated_management_fee	number	Novated management fee	0	no
lease_replacement_fee	number	Lease replacement fee	0	no
revs_fee	number	Registration and Roadworthy fee	0	no
disposal_fee	number	Disposal fee	0	no
maintenance_uplift_rate	number	Maintenance uplift rate	0	no

Residual & Interest

Field	Format	Notes	Default	Mandatory
residual_margin	number	Residual margin	NULL	no
residual_fee	number	Residual fee	NULL	no
interest_margin	number	Interest margin	NULL	no
management_fee	number	Management fee	NULL	no

Fuel Management

Field	Format	Notes	Default	Mandatory
fuel_supplier	string	Fuel supplier	NULL	no
fuel_managed_flag	string	Values: yes, no	NULL	no
fuel_on_delivery	number	Fuel on delivery	NULL	no

Policies & Terms

Field	Format	Notes	Default	Mandatory
focc_policy	string	Full coverage policy	NULL	no
early_termination_policy	string	Early termination policy	NULL	no
mla_note	string	MLA note	NULL	no

Client Classification

Field	Format	Notes	Default	Mandatory
client_class	string	Client class	NULL	no
discount_holden	string	Holden discount	NULL	no
discount_ford	string	Ford discount	NULL	no
discount_toyota	string	Toyota discount	NULL	no
discount_mitsubishi	string	Mitsubishi discount	NULL	no
discount_spare1	string	Spare discount 1	NULL	no
discount_spare2	string	Spare discount 2	NULL	no
discount_spare3	string	Spare discount 3	NULL	no
discount_spare4	string	Spare discount 4	NULL	no
discount_spare5	string	Spare discount 5	NULL	no

Fleet Management

Field	Format	Notes	Default	Mandatory
potential_fleet_size	string	Potential fleet size	0	no
payroll_cutoff	string	Payroll cutoff		no
shared_fleet_flag	string	Values: yes, no	NULL	no
shared_fleet_note	string	Shared fleet note	NULL	no
relief_vehicle_flag	string	Relief vehicle flag. Values: yes, no	yes	no
free_km_buffer	string	Free KM buffer	0	no

Fleet Features

Field	Format	Notes	Default	Mandatory
etags_managed_flag	string	Values: yes, no	NULL	no
etags_managed_note	string	E-tags managed note	NULL	no
quarterly_rates_flag	string	Values: yes, no	NULL	no
quarterly_rates_note	string	Quarterly rates note	NULL	no
novated_leases_flag	string	Values: yes, no	NULL	no
novated_leases_note	string	Novated leases note	NULL	no

Visit Tracking

Field	Format	Notes	Default	Mandatory
visit_last_date	date	Format: yyyy-mm-dd	0000-00-00	no
visit_next_date	date	Format: yyyy-mm-dd	0000-00-00	no

Client Grouping

Field	Format	Notes	Default	Mandatory
client_group_id	string	Client group ID	0	no
client_group_note	string	Client group note	NULL	no
client_group_flag	string	Values: yes, no	no	no

Billing Configuration

Field	Format	Notes	Default	Mandatory
billing_interval	string	Values: weekly, fortnightly, monthly, bi-annually, annually, period	monthly	no
billing_type_flag	string	Values: any, periodic, combined	any	no
billing_terms_id	string	Billing terms ID	0	no
booking_billing_type	string	Values: single, billing	billing	no
billing_group_email_flag	string	Values: yes, no	no	no
billing_email_attachment_type	string	Values: pdf, csv, pdf-and-csv	pdf	no
billing_by_client_order_no_flag	string	Values: yes, no	no	no
report_delivery_type	string	Values: email, post	email	no
rcti_flag	string	Values: yes, no	no	no

Contract & Payment

Field	Format	Notes	Default	Mandatory
contract_inertia_flag	string	Values: yes, no	no	no
contract_pay_cycle_from_quote_flag	string	Values: yes, no	no	no
payment_method	string	Values: direct-debit, cheque, cash, other, credit-card, eft. If blank, gb_controls sets default.	NULL	no
bank_bsb	number	Bank BSB	NULL	no
bank_account_number	number	Bank account number	NULL	no
bank_account_suffix	number	Bank account suffix	NULL	no

Billing & Finance Deferral

Field	Format	Notes	Default	Mandatory
periods_deferred	string	Periods deferred	0	no
finance_budget_term_deferred_flag	string	Values: yes, no	no	no
budgets_term_deferred_flag	string	Values: yes, no	no	no
initial_billings	string	Initial billings	0	no
periodic_start	string	Periodic start	2	no
common_day	string	Values: monday, tuesday, wednesday, thursday, friday, 1-31, eom	1	no

Notes

Field	Format	Notes	Default	Mandatory
pass_on_ics	string	Pass on ICS	NULL	no
approval_note	string	Approval note	NULL	no
infringement_note	string	Infringement note	NULL	no
fuel_card_note	string	Fuel card note	NULL	no
booking_note	string	Booking note	NULL	no
reg_label_note	string	Registration label note	NULL	no
recall_notice_note	string	Recall notice note	NULL	no
quote_internal_note	string	Quote internal note	NULL	no
quote_client_note	string	Quote client note	NULL	no
prospect_note	string	Prospect note	NULL	no
fbt_note	string	FBT note		no

Registration & Labels

Field	Format	Notes	Default	Mandatory
send_reg_label_novated	string	Values: not-applicable, driver, client-contact-1, client-contact-2, account-payable, account-manager	driver	no
send_reg_label_others	string	Values: not-applicable, driver, client-contact-1, client-contact-2, account-payable, account-manager	client-contact-1	no

FBT Configuration

Field	Format	Notes	Default	Mandatory
employer_fbt_type	string	Values: full-fbt-payable, concessional-30000-exempt, concessional-17000-exempt, rebatable, not-applicable	full-fbt-payable	no
ecm_allowed_flag	string	Values: no, yes	NULL	no
fbt_reporting_flag	string	Values: yes, no	no	no
fbt_email_novated	string	Values: yes, no	no	no
fbt_email_other	string	Values: yes, no	no	no
gross_up_rate_type	string	Values: fbttype1_grossup_factor, fbttype2_grossup_factor	fbttype1_grossupfactor	no
fixed_statutory_rate	number	Fixed statutory rate	0	no
luxury_charge_applied_flag	string	Values: yes, no	yes	no
luxury_charge_event_flag	string	Values: yes, no	no	no

Tax & Deductions

Field	Format	Notes	Default	Mandatory
itc_passed_on_flag	string	Values: yes, no	yes	no
itc_passed_on_rate	number	ITC passed on rate	1	no
return_itc_via_payroll_flag	string	Values: yes, no	no	no
ecm_flag	string	Values: yes, no	yes	no
gst_on_ecm_flag	string	Values: yes, no	yes	no
medicare_levy_flag	string	Values: yes, no	yes	no
car_allowance_impact_flag	string	Values: yes, no	no	no

Printing & Reporting

Field	Format	Notes	Default	Mandatory
print_finance_flag	string	Values: yes, no	no	no
invoice_options	string	Values: detail-only, summary-only, summary-and-detail	detail-only	no

Prospect Fields

Field	Format	Notes	Default	Mandatory
prospect_start	date	Format: yyyy-mm-dd	NULL	no
last_contact_date	date	Format: yyyy-mm-dd	NULL	no
next_contact_date	date	Format: yyyy-mm-dd	NULL	no
proposal_date	date	Format: yyyy-mm-dd	NULL	no
financial_date	date	Format: yyyy-mm-dd	NULL	no
lead_time	string	Lead time	NULL	no
prospect_priority	string	Values: blank, High, Medium, Low	NULL	no
prospect_probability	string	Values: 20%, 40%, 60%, 80%, 100%	NULL	no
potential_operating	string	Potential operating	0	no
potential_novated	string	Potential novated	0	no
potential_finance	string	Potential finance	0	no
potential_fleet_managed	string	Potential fleet managed	0	no
no_of_ftes	string	Number of FTEs	0	no
target_strike_rate	string	Target strike rate	0	no
competitors	string	Competitors		no

Events

Field	Format	Notes	Default	Mandatory
event_ecm_flag	string	Values: yes, no	no	no
event_nuds_flag	string	Values: yes, no	no	no
history_only_flag	string	Values: no, yes	no	no

Salary Packaging Cycles

Field	Format	Notes	Default	Mandatory
pay_cycle_id	string	Primary pay cycle ID	0	no
pay_cycle_id_active_flag	string	Primary pay cycle active	no	no
payroll_date	date	Primary payroll date. Format: yyyy-mm-dd	0000-00-00	no
pay_cycle_id2	string	Secondary pay cycle ID	0	no
pay_cycle_id2_active_flag	string	Secondary pay cycle active	no	no
payroll_date2	date	Secondary payroll date. Format: yyyy-mm-dd	0000-00-00	no
pay_cycle_id3	string	Tertiary pay cycle ID	0	no
pay_cycle_id3_active_flag	string	Tertiary pay cycle active	no	no
payroll_date3	date	Tertiary payroll date. Format: yyyy-mm-dd	0000-00-00	no
payroll_cutoff_days	string	Payroll cutoff days	0	no

Salary Packaging Fees

Field	Format	Notes	Default	Mandatory
packaging_fees_per_year	number	Packaging fees per year	0	no
packaging_advice_fee	number	Packaging advice fee	0	no
package_admin_fee	number	Package admin fee	0	no
salary_type	string	Values: total-package, base-only, base-plus-super, fixed-super	NULL	no
fixed_super_rate	number	Fixed super rate	0	no

Salary Packaging Configuration

Field	Format	Notes	Default	Mandatory
cost_centres_mandatory_flag	string	Values: yes, no	no	no
allow_operating_fbt_type_flag	string	Values: yes, no	yes	no
wear_tear_allowance	number	Wear and tear allowance	0	no
advance_arrears	string	Values: advance, arrears	advance	no
agreed_lessee_rate	number	Agreed lessee rate	0	no
lessee_rate_include_vmp_flag	string	Values: yes, no	no	no
purchase_stamp_duty_exempt_flag	string	Values: yes, no	no	no
sl_export_flag	string	Values: yes, no	yes	no
reg_ctp_type	string	Values: business, private	business	no

Quoting & Approval

Field	Format	Notes	Default	Mandatory
allow_quoting_flag	string	Values: yes, no	no	no
allow_quoting_within_cap_flag	string	Values: yes, no	yes	no
interim_service_flag	string	Values: yes, no	yes	no
approval_limit	number	Approval limit	0	no
send_approval_email_flag	string	Values: yes, no	yes	no

Client Defaults (Nested Array)

Nested object within main body containing client-specific defaults.

Field	Format	Notes	Default	Mandatory
delivery_fee_funded_flag	string	Values: yes, no	no	no
fuel_on_delivery_funded_flag	string	Values: yes, no	no	no
supplier_id_financier	string	Financier supplier ID	NULL	no
policy_owner_type	string	Values: insurer_internal, client, driver	NULL	no
supplier_id_insurer	string	Insurer supplier ID	NULL	no
residual_margin_rate	number	Residual margin rate	0	no
residual_margin_rate_commercial	number	Residual margin rate (commercial)	0	no
excess_km_rate	number	Excess KM rate	0	no
establishment_fee	number	Establishment fee	NULL	no
management_fee	number	Management fee	NULL	no
maintenance_program_fee	number	Maintenance program fee	0	no
novated_commission_rate	number	Novated commission rate	0	no
insurance_broker_fee_exempt_flag	string	Values: yes, no	yes	no
carbon_emission_offset_flag	string	Values: yes, no	yes	no
roadside_assistance_plan_code	string	Roadside assistance plan code	NULL	no
accident_management_fee	number	Accident management fee	0	no

Bespoke Fields (Nested Array)

Nested object for custom field values.

"bespoke_field_values": { "your_first_bespoke_field_name": "fieldValue", "your_next_bespoke_field_name": "fieldValue" }

Field	Format	Notes	Default	Mandatory
bespoke_field_values	array	Custom field key-value pairs	no