v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Firm

Get firm

Retrieves the details of the firm associated with the authenticated client.

get/firm

Response

When request is successful. Returns a 'Firm' object.

hrefstring nullable

relationstring nullable

methodstring nullable

idstring nullable

Unique identifier of the firm.

versionIdstring nullable

Version id of the record.

ownerstring nullable

The owner/white-label partner used by the firm.

Possible values: Smokeball, PracticeEvolve, TriConvey.

namestring nullable

The name of the firm.

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)
PracticeEvolve (ADD011)
CustomReporting (ADD012)

Possible values: ADD001, ADD003, ADD004, ADD005, ADD006, ADD007, ADD008, ADD010, ADD011, ADD012

emailstring nullable

The email of the firm.

Only supported in AUS.

abnstring nullable

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

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

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

Only supported in AU and UK.

logostring nullable

Logo of the firm.

createdDatestring date-time nullable

The date when the firm was created in UTC.

Example response

{
  "id": "f4ff1eff-b7fe-4d46-4e46-01d985838d76",
  "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "owner": "Smokeball",
  "name": "Brown LLC",
  "productId": "SMK001",
  "addOnIds": [
    "ADD001",
    "ADD003"
  ],
  "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": "Berkshire",
    "locality": "Windsor",
    "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",
    "county": "Berkshire",
    "locality": "Windsor",
    "country": "United States"
  },
  "dxAddress": {
    "number": "376",
    "exchange": "DX",
    "state": "NSW"
  },
  "phone": {
    "areaCode": "555",
    "number": "1234567"
  },
  "fax": {
    "areaCode": "555",
    "number": "1234567"
  },
  "logo": "https://example-logo-url.com/image",
  "stylingDetails": {
    "primaryColorHexCode": "#FF000000",
    "secondaryColorHexCode": "#FF000000",
    "fontFamilyName": "Open Sans"
  },
  "licenceNumbers": [
    {
      "state": "IL"
    }
  ],
  "createdDate": "2024-01-15T10:30:00Z"
}