Create & Update Client Endpoints: PatchClient — Body (JSON): Part 1

API endpoints for creating and patching clients and client groups

Body (JSON)

Key	Format	Notes	Default Value	Mandatory
[
client_code	string	Client Code must be unique. Maximum 10 characters.		no
user_id	number	Enter the user_id for the "A/C Manager" field.		no
useridsales	number	Enter the user_id for the "Sales" field.		no
name	string	Your clients name. Although this field is not mandatory it is strongly recommended as this is used on countless reports, invoices, quote templates etc.		no
clientidexternal	string	Enter a value here as required.	0	no
client_code	string	Enter a value here as required.		no

| inclusionclientexclusions | array | Refer to Clients:Quote defaults for more details on this feature.

{ "inclusion_id": "1234567890123456000", "inclusion_id": "1234567890123456001"}

| | no |
| clientidparent | string | Enter a value here as required. | 0 | no |
| channelid | string | Enter a value here as required. | 0 | no || clienttype | string | Enter one of the following values: 'fleet','prospect','sundry','inactive','lead'. | NULL | no |
| clientindustryid | string | Enter a value here as required. | 0 | no |
| clientcreditratingsid | string | Enter a value here as required. | NULL | no || siccode | string | Enter a value here as required. | | no |
| financialyearend | string | Enter one of the following values: 'January','February','March','April','May','June','July','August','September','October','November','December'. | June | no |
| companytaxrate | number | Enter a value here as required. | 0 | no |
| address1 | string | Enter a value here as required. | NULL | no |
| address2 | string | Enter a value here as required. | NULL | no |
| area | string | Enter a value here as required. | NULL | no |
| state | string | Enter one of the following values: 'VIC','NSW','ACT','QLD','WA','SA','TAS','NT','NZ'. | NULL | no |
| pcode | string | Enter a value here as required. | NULL | no |
| countryid | string | Enter a value here as required. | NULL | no || phone | string | Enter a value here as required. | NULL | no || mobile | string | Enter a value here as required. | NULL | no || fax | string | Enter a value here as required. | NULL | no || abn | string | Enter a value here as required. | NULL | no || acn | string | Enter a value here as required. | NULL | no || arbn | string | Enter a value here as required. | NULL | no || corporatetypeid | string | Enter a value here as required. | 0 | no || businessstartdate | date | Enter a date as required using date format: yyyy-mm-dd | 0000-00-00 | no || contact1name | string | Enter a value here as required. | NULL | no |
| contact1jobtitle | string | Enter a value here as required. | | no |
| contact1phone | string | Enter a value here as required. | NULL | no || contact1email | string | Enter a value here as required. | NULL | no |
| contact1note | string | Enter a value here as required. | NULL | no || contact2name | string | Enter a value here as required. | NULL | no |
| contact2jobtitle | string | Enter a value here as required. | | no |
| contact3phone | string | Enter a value here as required. | NULL | no || contact2phone | string | Enter a value here as required. | NULL | no |
| contact3email | string | Enter a value here as required. | NULL | no || contact2email | string | Enter a value here as required. | NULL | no |
| contact3note | string | Enter a value here as required. | NULL | no || contact2note | string | Enter a value here as required. | NULL | no |
| contact3name | string | Enter a value here as required. | NULL | no || contact3jobtitle | string | Enter a value here as required. | | no || contact4name | string | Enter a value here as required. | NULL | no |
| contact4jobtitle | string | Enter a value here as required. | | no |
| contact4phone | string | Enter a value here as required. | NULL | no || contact4email | string | Enter a value here as required. | NULL | no |
| contact4note | string | Enter a value here as required. | NULL | no || contact5note | string | Enter a value here as required. | | no |
| contact5email | string | Enter a value here as required. | NULL | no || contact5phone | string | Enter a value here as required. | | no |
| contact5jobtitle | string | Enter a value here as required. | | no |
| contact5name | string | Enter a value here as required. | | no || guarantor1name | string | Enter a value here as required. | | no |
| guarantor1phone | string | Enter a value here as required. | | no || guarantor2name | string | Enter a value here as required. | | no |
| guarantor2phone | string | Enter a value here as required. | | no || guarantor3name | string | Enter a value here as required. | | no |
| guarantor3phone | string | Enter a value here as required. | | no || payrollcutoff | string | Enter a value here as required. | | no || potentialfleetsize | string | Enter a value here as required. | 0 | no || postaladdress1 | string | Enter a value here as required. | NULL | no |
| postaladdress2 | string | Enter a value here as required. | NULL | no || postalarea | string | Enter a value here as required. | NULL | no |
| postalstate | string | Enter one of the following values: 'VIC','NSW','ACT','QLD','WA','SA','TAS','NT','NZ'. | NULL | no || postalpcode | string | Enter a value here as required. | NULL | no |
| postalcountryid | string | Enter a value here as required. | NULL | no |
| insurer | string | Enter a value here as required. | NULL | no |
| supplieridinsurer | string | Enter a value here as required. | NULL | no |
| supplieridbroker | string | Enter a value here as required. | NULL | no |
| policynumber | string | Enter a value here as required. | | no || duedate | date | Enter a date as required using date format: yyyy-mm-dd | NULL | no |
| supplieridrepairer | string | Enter a value here as required. | 0 | no |
| clientagreementtypeid | string | Enter a value here as required. | 0 | no || mlanonstandardflag | string | Enter one of the following values: 'yes','no'. | no | no |
| mladate | date | Enter a date as required using date format: yyyy-mm-dd | NULL | no || facilitytypeid | string | Enter a value here as required. | NULL | no || financeaccepteddate | date | Enter a date as required using date format: yyyy-mm-dd | NULL | no || financelimit | number | Enter a value here as required. | NULL | no |
| financereviewdate | date | Enter a date as required using date format: yyyy-mm-dd | NULL | no |
| deliveryfee | number | Enter a value here as required. | NULL | no || establishmentfee | number | Enter a value here as required. | NULL | no |
| sourcingfee | number | Enter a value here as required. | 0 | no || documentfee | number | Enter a value here as required. | 0 | no |
| documentfeebudgeted | number | Enter a value here as required. | 0 | no |
| fuelfee | number | Enter a value here as required. | 0 | no || novatedmanagementfee | number | Enter a value here as required. | 0 | no || leasereplacementfee | number | Enter a value here as required. | 0 | no || revsfee | number | Enter a value here as required. | 0 | no |
| residualmargin | number | Enter a value here as required. | NULL | no || residualfee | number | Enter a value here as required. | NULL | no |
| interestmargin | number | Enter a value here as required. | NULL | no || managementfee | number | Enter a value here as required. | NULL | no |
| disposalfee | number | Enter a value here as required. | 0 | no || fuelondelivery | number | Enter a value here as required. | NULL | no || maintenanceupliftrate | number | Enter a value here as required. | 0 | no || fuelsupplier | string | Enter a value here as required. | NULL | no |
| fuelmanagedflag | string | Enter one of the following values: 'yes','no'. | NULL | no |
| foccarpolicy | string | Enter a value here as required. | NULL | no |
| earlyterminationspolicy | string | Enter a value here as required. | NULL | no |
| mlanote | string | Enter a value here as required. | NULL | no || clientclass | string | Enter a value here as required. | NULL | no |
| discountholden | string | Enter a value here as required. | NULL | no || discountford | string | Enter a value here as required. | NULL | no |
| discounttoyota | string | Enter a value here as required. | NULL | no || discountmitsubishi | string | Enter a value here as required. | NULL | no |
| discountspare1 | string | Enter a value here as required. | NULL | no || discountspare2 | string | Enter a value here as required. | NULL | no |
| discountspare3 | string | Enter a value here as required. | NULL | no || discountspare4 | string | Enter a value here as required. | NULL | no |
| discountspare5 | string | Enter a value here as required. | NULL | no || passonitcs | string | Enter a value here as required. | NULL | no || contactnote | string | Enter a value here as required. | NULL | no |
| sharedfleetflag | string | Enter one of the following values: 'yes','no'. | NULL | no |
| sharedfleetnote | string | Enter a value here as required. | NULL | no |
| etagsmanagedflag | string | Enter one of the following values: 'yes','no'. | NULL | no |
| etagsmanagednote | string | Enter a value here as required. | NULL | no |
| quarterlyratesflag | string | Enter one of the following values: 'yes','no'. | NULL | no |
| quarterlyratesnote | string | Enter a value here as required. | NULL | no |
| novatedleasesflag | string | Enter one of the following values: 'yes','no'. | NULL | no |
| novatedleasesnote | string | Enter a value here as required. | NULL | no |
| visitlastdate | date | Enter a date as required using date format: yyyy-mm-dd | 0000-00-00 | no |
| visitnextdate | date | Enter a date as required using date format: yyyy-mm-dd | 0000-00-00 | no |
| clientgroupid | string | Enter a value here as required. | 0 | no |
| clientgroupnote | string | Enter a value here as required. | NULL | no |
| billinginterval | string | Enter one of the following values: 'weekly','fortnightly','monthly','bi-annually','annually','period'. | monthly | no || contractpaycyclefromquoteflag | string | Enter one of the following values: 'yes','no'. | no | no |
| periodsdeferred | string | Enter a value here as required. | 0 | no || financebudgettermdeferredflag | string | Enter one of the following values: 'yes','no'. | no | no || budgetstermdeferredflag | string | Enter one of the following values: 'yes','no'. | no | no |
| initialbillings | string | Enter a value here as required. | 0 | no || periodicstart | string | Enter a value here as required. | 2 | no |
| commonday | string | Enter one of the following values: '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','29','30','31','eom'. | 1 | no || reportdeliverytype | string | Enter one of the following values: 'email','post'. | email | no || billingtypeflag | string | Enter one of the following values: 'any','periodic','combined'. | any | no || billingtermsid | string | Enter a value here as required. | 0 | no || bookingbillingtype | string | Enter one of the following values: 'single','billing'. | billing | no || billinggroupemailflag | string | Enter one of the following values: 'yes','no'. | no | no |
| billingemailattachmenttype | string | Enter one of the following values: 'pdf','csv','pdf-and-csv'. | pdf | no || billingbyclientordernoflag | string | Enter one of the following values: 'yes','no'. | no | no |
| rctiflag | string | Enter one of the following values: 'yes','no'. | no | no || paymentmethod | string | Enter one of the following values: 'direct-debit','cheque','cash','other','credit-card','eft'. | NULL | no |
| contractinertiaflag | string | Enter one of the following values: 'yes','no'. | no | no |
| bankbsb | number | Enter a value here as required. | NULL | no || bankaccountnumber | number | Enter a value here as required. | NULL | no || bankaccountsuffix | number | Enter a value here as required. | NULL | no || approvalnote | string | Enter a value here as required. | NULL | no |
| infringementnote | string | Enter a value here as required. | NULL | no || fuelcardnote | string | Enter a value here as required. | NULL | no || bookingnote | string | Enter a value here as required. | NULL | no |
| reglabelnote | string | Enter a value here as required. | NULL | no |
| sendreglabelnovated | string | Enter one of the following values: 'not-applicable','driver','client-contact-1','client-contact-2','account-payable','account-manager'. | driver | no || sendreglabelothers | string | Enter one of the following values: 'not-applicable','driver','client-contact-1','client-contact-2','account-payable','account-manager'. | client-contact-1 | no |
| recallnoticenote | string | Enter a value here as required. | NULL | no |
| quoteinternalnote | string | Enter a value here as required. | NULL | no |
| quoteclientnote | string | Enter a value here as required. | NULL | no |
| employerfbttype | string | Enter one of the following values: 'full-fbt-payable','concessional-30000-exempt','concessional-17000-exempt','rebatable','not-applicable'. | full-fbt-payable | no |
| ecmallowedflag | string | Enter one of the following values: 'no','yes'. | NULL | no |
| fbtreportingflag | string | Enter one of the following values: 'yes','no'. | no | no |
| fbtemailnovated | string | Enter one of the following values: 'yes','no'. | no | no |
| fbtemailother | string | Enter one of the following values: 'yes','no'. | no | no |
| fbtnote | string | Enter a value here as required. | | no || eventecmflag | string | Enter one of the following values: 'yes','no'. | no | no || eventnudsflag | string | Enter one of the following values: 'yes','no'. | no | no || historyonlyflag | string | Enter one of the following values: 'no','yes'. | no | no || prospectstart | date | Enter a date as required using date format: yyyy-mm-dd | NULL | no |
| lastcontactdate | date | Enter a date as required using date format: yyyy-mm-dd | NULL | no |
| nextcontactdate | date | Enter a date as required using date format: yyyy-mm-dd | NULL | no |
| proposaldate | date | Enter a date as required using date format: yyyy-mm-dd | NULL | no || financialsdate | date | Enter a date as required using date format: yyyy-mm-dd | NULL | no |
| leadtime | string | Enter a value here as required. | NULL | no || prospectpriority | string | Enter one of the following values: '','High','Medium','Low'. | NULL | no |
| prospectprobability | string | Enter one of the following values: '20%','40%','60%','80%','100%'. | NULL | no || potentialoperating | string | Enter a value here as required. | 0 | no |
| potentialnovated | string | Enter a value here as required. | 0 | no || potentialfinance | string | Enter a value here as required. | 0 | no |
| potentialfleetmanaged | string | Enter a value here as required. | 0 | no |
| noofftes | string | Enter a value here as required. | 0 | no |
| targetstrikerate | string | Enter a value here as required. | 0 | no |
| competitors | string | Enter a value here as required. | | no |
| prospectnote | string | Enter a value here as required. | NULL | no || grossupratetype | string | Enter one of the following values: 'fbttype1grossupfactor','fbttype2grossupfactor'. | fbttype1grossupfactor | no |
| fixedstatutoryrate | number | Enter a value here as required. | 0 | no |
| luxurychargeappliedflag | string | Enter one of the following values: 'yes','no'. | yes | no || luxurychargeeventflag | string | Enter one of the following values: 'yes','no'. | no | no |
| itcpassedonflag | string | Enter one of the following values: 'yes','no'. | yes | no || itcpassedonrate | number | Enter a value here as required. | 1 | no |
| returnitcviapayrollflag | string | Enter one of the following values: 'yes','no'. | no | no |
| ecmflag | string | Enter one of the following values: 'yes','no'. | yes | no || gstonecmflag | string | Enter one of the following values: 'yes','no'. | yes | no |
| medicarelevyflag | string | Enter one of the following values: 'yes','no'. | yes | no |
| printfinanceflag | string | Enter one of the following values: 'yes','no'. | no | no |
| carallowanceimpactflag | string | Enter one of the following values: 'yes','no'. | no | no || paycycleid | string | Enter a value here as required. | 0 | no || paycycleidactiveflag | string | Enter a value here as required. | no | no || payrolldate | date | Enter a date as required using date format: yyyy-mm-dd | 0000-00-00 | no |
| paycycleid2 | string | Enter a value here as required. | 0 | no |
| paycycleid2activeflag | string | Enter a value here as required. | no | no |
| payrolldate2 | date | Enter a date as required using date format: yyyy-mm-dd | 0000-00-00 | no || paycycleid3 | string | Enter a value here as required. | 0 | no || paycycleid3activeflag | string | Enter a value here as required. | no | no || payrolldate3 | date | Enter a date as required using date format: yyyy-mm-dd | 0000-00-00 | no |
| payrollcutoffdays | string | Enter a value here as required. | 0 | no || packagingfeesperyear | number | Enter a value here as required. | 0 | no |
| packagingadvicefee | number | Enter a value here as required. | 0 | no |
| packageadminfee | number | Enter a value here as required. | 0 | no |
| salarytype | string | Enter one of the following values: 'total-package','base-only','base-plus-super','fixed-super'. | NULL | no || fixedsuper_rate | number | Enter a value here as required. | 0 | no |