v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB

Companies

Update Company

Update an existing Company attributes using a given :id.

patch/companies/{id}

Path parameters

idstring required

Company ID

Request body

namestring required

Company name

legal_namestring required

Company legal name

tax_numberstring required

ABN / Tax number

business_emailstring email

The business email address associated with the user or business.Must be a valid email format (e.g., user@business.com). This email is used forofficial communication and account-related notifications. Disposable orpersonal email addresses are not recommended.

charge_taxboolean nullable

Charge GST or not? allowed values are true or false

address_line1string

Address line 1

address_line2string

Address line 2

citystring

City

statestring

State

zipstring

Zip

countrystring required

3 digit country code (eg. AUS)

phonestring

Company phone number

user_idstring required

User ID to associate with the company

Example request

{
  "name": "ABC",
  "legal_name": "ABC Pty Ltd",
  "tax_number": "123456789",
  "business_email": "test@email.com",
  "address_line1": "Collins",
  "city": "Melbourne",
  "state": "VIC",
  "zip": "3000",
  "country": "AUS",
  "user_id": "buyer-70729325"
}

Response

Example response

{
  "companies": {
    "legal_name": "Samuel's Gardening Pty Ltd",
    "name": "Samuel's Gardening",
    "business_email": "samuel@email.com",
    "id": "7b85aa9c-fc54-4449-afef-f52fc2b94cd3",
    "related": {
      "address": "cae0ada1-8e31-4bfc-aa24-5331f888cb12",
      "users": "b278dbd0-48da-4824-8ab7-f82008682df2"
    },
    "self": {
      "self": "/companies"
    }
  }
}