Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Firm

Create firm

Creates a firm for the current authenticated client and registers an existing user as a staff member and firm owner.

post/firm

Request body

productIdstring nullable

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

addOnIdsstring[] nullable

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

namestring nullable

The name of the firm.

emailstring nullable

The email of the firm.

Only supported in AU.

abnstring nullable

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.

acnstring nullable

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.

isInternalboolean

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

Example request

{
  "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",
    "country": "United States"
  },
  "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",
    "country": "United States"
  },
  "dxAddress": {
    "number": "376",
    "exchange": "DX",
    "state": "NSW"
  },
  "phone": {
    "areaCode": "555",
    "number": "1234567"
  },
  "fax": {
    "areaCode": "555",
    "number": "1234567"
  },
  "staff": {
    "userId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
    "title": "Mr",
    "firstName": "John",
    "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",
    "colorFill": "#797d85",
    "colorStroke": "#64666a"
  }
}

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable