Sign in
Clients

Create a new Client

OAuth Scope

This endpoint requires the following OAuth scope manage_customers.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/company.json

Request body

namestring required

Company Name

abn_numberstring

Australian Business Number. A unique 11-digit identifier issued by the Australian Taxation Office to businesses. Required for tax compliance and validation of business identity in Australia.

addressstring

Password

billing_addressstring

Confirm Password

{"stackTrail":"components:schemas:Company:properties:parent_company_uuid","oasType":"schema","type":"unknown","description":"If provided, specifies the UUID of this Site's parent Company. If blank, this record is a Head Office rather than a Site. This field is only present on ServiceM8 Accounts with the Company Sites addon activated."}
uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

websitestring
is_individualstring
address_streetstring
address_citystring
address_statestring
address_postcodestring
address_countrystring
fax_numberstring
badgesstring
tax_rate_uuidstring uuid
billing_attentionstring
payment_termsstring

Example request

{
  "uuid": "123e4567-6225-4d61-9c7f-230b7f38ffbb",
  "edit_date": "2025-07-01 12:00:00",
  "tax_rate_uuid": "123e4567-fe37-4042-8f36-230b7fee599b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes