POST
/
firm
Create firm
curl --request POST \
  --url https://api.smokeball.com/firm \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "productId": "SMK001",
  "addOnIds": [
    "ADD01",
    "ADD003"
  ],
  "name": "Brown LLC",
  "email": "john.smith@law.com",
  "abn": "1234567890",
  "acn": "1234567890",
  "streetAddress": {
    "buildingLevel": "Level 1",
    "unitNumber": "10",
    "unitType": "Suite",
    "streetNumber": "100",
    "streetName": "Broad",
    "streetType": "Street",
    "addressLine1": "Level 1/10",
    "addressLine2": "100 Broad Street",
    "city": "Chicago",
    "state": "IL",
    "zipCode": "60606",
    "county": "",
    "locality": "",
    "country": "United States",
    "careOf": "",
    "poBoxType": "",
    "poBoxNumber": ""
  },
  "mailingAddress": {
    "buildingLevel": "Level 1",
    "unitNumber": "10",
    "unitType": "Suite",
    "streetNumber": "100",
    "streetName": "Broad",
    "streetType": "Street",
    "addressLine1": "Level 1/10",
    "addressLine2": "100 Broad Street",
    "city": "Chicago",
    "state": "IL",
    "zipCode": "60606",
    "county": "",
    "locality": "",
    "country": "United States",
    "careOf": "",
    "poBoxType": "",
    "poBoxNumber": ""
  },
  "dxAddress": {
    "number": "376",
    "exchange": "DX",
    "state": "NSW"
  },
  "phone": {
    "areaCode": "555",
    "number": "1234567"
  },
  "fax": {
    "areaCode": "555",
    "number": "1234567"
  },
  "isInternal": false,
  "staff": {
    "userId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "title": "Mr",
    "firstName": "John",
    "middleName": "",
    "lastName": "Smith",
    "initials": "JS",
    "phone": {
      "areaCode": "555",
      "number": "1234567"
    },
    "cell": {
      "areaCode": "555",
      "number": "1234567"
    },
    "email": "john.smith@brown.com",
    "role": "Bookkeeper",
    "avatar": "https://example-avatar-url.com/image",
    "former": false,
    "colorFill": "#797d85",
    "colorStroke": "#64666a"
  },
  "subscription": {
    "productSuite": "<string>",
    "promotionId": "<string>",
    "interval": "<string>"
  }
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Body

​
productId
string | null

The product/tier the firm is subscribed to. Must be set when creating the firm and is optional when updating the firm.

The supported products are listed in order below, the identifier (in brackets) must be used.

  • Bill (SMK001)

  • Boost (SMK004)

  • Grow (SMK002)

  • Prosper + (SMK003)

Possible values: SMK001, SMK004, SMK002, SMK003

Example:

"SMK001"

​
addOnIds
string[] | null

The optional add-ons the firm is subscribed to. Must be specified with an accompanying productId.

The supported add-ons are listed below, the identifier (listed in brackets) must be used.

  • Intake (ADD001)

  • AutoTime (ADD003)

  • FamilyPro (ADD004)

  • Api (ADD005)

  • Workflows (ADD006)

  • PowerBI (ADD007)

  • Archie (ADD008)

  • SSO (ADD010)

Possible values: ADD01, ADD003, ADD004, ADD005, ADD006, ADD007, ADD008, ADD010

Example:
["ADD01", "ADD003"]
​
name
string | null

The name of the firm.

Example:

"Brown LLC"

​
email
string | null

The email of the firm.

Only supported in AU.

Example:

"john.smith@law.com"

​
abn
string | null

Represents a different field depending on the region.

  • For AU: Australian Business Number (ABN) of the firm.

  • For UK: Value-added Tax Number (VAT) of the firm.

Only supported in AU and UK.

Example:

"1234567890"

​
acn
string | null

Represents a different field depending on the region.

  • For AU: Australian Company Number (ACN) of the firm.

  • For UK: Company Registration Number (CRN) of the firm.

Only supported in AU and UK.

Example:

"1234567890"

​
streetAddress
object

Street address of the firm.

​
mailingAddress
object

Mailing address of the firm.

​
dxAddress
object

DX address of the firm.

Only supported in AU.

​
phone
object

Phone number of the firm.

​
fax
object

Fax number of the firm.

​
isInternal
boolean

Whether firm is being created for internal use. Internal firms will not be subscribed for payment processing and will not be charged.

Example:

false

​
staff
object

The staff member that will be created with the firm. This staff member will become the firm owner.

​
subscription
object

Optional subscription details that will be used when creating the firm. The subscription details for the firm.

Response

When request is accepted. Returns a hypermedia 'Link' object of the firm to be created.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET