TenantDto

A tenant: a CIS Manager organisation the caller is a member of. What the application needs on every request about
the organisation being worked in: identity, contact details, VAT and module settings, and the entity counts its
dashboard shows.

Properties

Name	Type	Description
code*	string	Tenant code: the value of the {tenant} route parameter
Tenant code: the value of the {tenant} route parameter
name*	string	Tenant name (the contractor's or subcontractor's trading name as registered with HMRC)
Tenant name (the contractor's or subcontractor's trading name as registered with HMRC)
modules*	array of enum	The modules enabled for the tenant CisContractor CisSubcontractor
The modules enabled for the tenant CisContractor CisSubcontractor
emailAddress	string	Contact email address
Contact email address
isEmailVerified*	boolean	Whether the contact email address has been verified
Whether the contact email address has been verified
phoneNumber	string	Contact telephone number
Contact telephone number
address*	TenantAddressDto	Postal address
Postal address
isVatRegistered*	boolean	Whether the tenant is VAT registered
Whether the tenant is VAT registered
vatRegistrationNumber	string	VAT registration number
VAT registration number
shareDetailsDefault*	boolean	Whether new contacts default to sharing their details with the counterparty
Whether new contacts default to sharing their details with the counterparty
isSupportAccessEnabled*	boolean	Whether the tenant has allowed CIS Manager support staff to access its data
Whether the tenant has allowed CIS Manager support staff to access its data
isSupportAccess*	boolean	Whether the caller reached this tenant through support access (a support agent, with the tenant's permission) rather than membership. Support access is not a membership: such a tenant is absent from the caller's tenant list and from `GET /me`.
Whether the caller reached this tenant through support access (a support agent, with the tenant's permission) rather than membership. Support access is not a membership: such a tenant is absent from the caller's tenant list and from `GET /me`.
logoUrl	string	URL of the tenant's logo, if one has been uploaded
URL of the tenant's logo, if one has been uploaded
counts*	TenantCountsDto	Entity counts, as shown on the tenant's dashboard
Entity counts, as shown on the tenant's dashboard
createdDate*	string	When the tenant was created
When the tenant was created
updatedDate	string	When the tenant was last updated
When the tenant was last updated

JSON Example

{
  "code": "string",
  "name": "string",
  "modules": [
    "CisContractor"
  ],
  "emailAddress": "string",
  "isEmailVerified": false,
  "address": {
    "line1": "string",
    "line2": "string",
    "line3": "string"
  },
  "isVatRegistered": false,
  "shareDetailsDefault": false,
  "isSupportAccessEnabled": false,
  "isSupportAccess": false,
  "counts": {
    "contacts": 0,
    "customers": 0,
    "suppliers": 0,
    "subcontractors": 0,
    "unverifiedSubcontractors": 0,
    "purchaseInvoices": 0,
    "purchasePayments": 0,
    "salesInvoices": 0,
    "salesPayments": 0,
    "returns": 0,
    "acceptedReturns": 0
  },
  "createdDate": "2024-01-01T00:00:00Z"
}

Used By Operations

Contained in Schemas

TenantDtoPagedResult