API Docs / Schemas / TenantCisDetailsDto

TenantCisDetailsDto

The tenant's own CIS identity as a subcontractor: what it shares with contractors over a connection and what
goes on its invoices. Empty (needsConfig) until the tenant fills it in.

Properties

Name Type Description
type*enum

Sole trader, partnership, company or trust

SoleTrader Partnership Company Trust

Sole trader, partnership, company or trust

SoleTrader Partnership Company Trust

titlestring

The person's title

The person's title

firstNamestring

The person's first name

The person's first name

secondNamestring

The person's second name

The person's second name

lastNamestring

The person's last name

The person's last name

tradingNamestring

The trading name

The trading name

utrstring

The Unique Taxpayer Reference

The Unique Taxpayer Reference

niNumberstring

The National Insurance number

The National Insurance number

companyNumberstring

The company registration number

The company registration number

partnershipNamestring

The partnership's name

The partnership's name

partnershipUtrstring

The partnership's UTR

The partnership's UTR

needsConfig*boolean

True until a UTR, company number or partnership UTR is set: the details cannot be shared yet

True until a UTR, company number or partnership UTR is set: the details cannot be shared yet

isSaved*boolean

Whether the tenant has saved any details yet (false: the defaults, never edited)

Whether the tenant has saved any details yet (false: the defaults, never edited)

JSON Example

{
  "type": "SoleTrader",
  "title": "string",
  "firstName": "string",
  "secondName": "string",
  "lastName": "string",
  "needsConfig": false,
  "isSaved": false
}

Used By Operations