BusinessDetailsDto

Business-specific details for clients, including companies and sole traders.
Includes UK Companies House registration information, addresses, tax details, and SIC codes.
This information is typically populated from Companies House API or accounting platform integrations.

Properties

Name Type Description
companyCompanyDetailsDto
tradingAsstring

Trading name if different from the registered company name

Trading name if different from the registered company name

postalAddressstring

Postal/correspondence address (may differ from registered address)

Postal/correspondence address (may differ from registered address)

invoiceAddressstring

Address to use for invoicing purposes

Address to use for invoicing purposes

dateOfTradingstring

The date when the business started trading (may differ from incorporation date)

The date when the business started trading (may differ from incorporation date)

natureOfBusinessstring

Description of what the business does

Description of what the business does

utrstring

The business Unique Taxpayer Reference (Corporation Tax UTR).
For Individual clients, the personal UTR is stored on the Contact record.

The business Unique Taxpayer Reference (Corporation Tax UTR).
For Individual clients, the personal UTR is stored on the Contact record.

vatVatDetailsDto
payeRefstring

PAYE reference number for employers (e.g. 123/AB12345)

PAYE reference number for employers (e.g. 123/AB12345)

accountsOfficeRefstring

HMRC Accounts Office reference number

HMRC Accounts Office reference number

isCharityboolean

The client is a registered, excepted or exempt charity. Settable for Private Limited Company
(charitable company), Trust (charitable trust) and Association (unincorporated charity);
a Charity (CIO) client is always a charity whatever this says, and the flag is cleared for
every other type. Effective status is client type Charity OR this flag.
Usage in templates: {{ Business.IsCharity }} (resolved to the effective status)

The client is a registered, excepted or exempt charity. Settable for Private Limited Company
(charitable company), Trust (charitable trust) and Association (unincorporated charity);
a Charity (CIO) client is always a charity whatever this says, and the flag is cleared for
every other type. Effective status is client type Charity OR this flag.
Usage in templates: {{ Business.IsCharity }} (resolved to the effective status)

charityNumberstring

Charity registration number: Charity Commission (6-7 digits, optional "-N" suffix for a
linked charity), OSCR ("SC0xxxxx") or CCNI ("NICxxxxxx"). Free text; empty for an excepted
or exempt charity that has no number.
Usage in templates: {{ Business.CharityNumber }}

Charity registration number: Charity Commission (6-7 digits, optional "-N" suffix for a
linked charity), OSCR ("SC0xxxxx") or CCNI ("NICxxxxxx"). Free text; empty for an excepted
or exempt charity that has no number.
Usage in templates: {{ Business.CharityNumber }}

JSON Example

{
  "company": {
    "number": "string",
    "status": "...",
    "incorporationDate": "2024-01-01T00:00:00Z",
    "registeredAddress": "string",
    "sicCodes": [
      "..."
    ]
  },
  "tradingAs": "string",
  "postalAddress": "string",
  "invoiceAddress": "string",
  "dateOfTrading": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas