API Docs / Schemas / CreateTenantRequest

CreateTenantRequest

A new tenant, owned by the caller. Its email address and phone number start as the caller's.

Properties

Name Type Description
name*string

The tenant's name

The tenant's name

isVatRegistered*boolean

Whether the tenant is VAT registered

Whether the tenant is VAT registered

vatRegistrationNumberstring

The VAT registration number

The VAT registration number

modules*array of enum

The modules the tenant uses: CisContractor, CisSubcontractor or both

CisContractor CisSubcontractor

The modules the tenant uses: CisContractor, CisSubcontractor or both

CisContractor CisSubcontractor

practicestring

One of the caller's practices (managed in CIS Manager) to create the tenant in: its members reach it, and a
contractor tenant files with the practice's default HMRC credentials. Leave out for a tenant in no practice

One of the caller's practices (managed in CIS Manager) to create the tenant in: its members reach it, and a
contractor tenant files with the practice's default HMRC credentials. Leave out for a tenant in no practice

newPracticeNamestring

The name of a new practice to create the tenant in, the caller its first member: an accountant setting up a
client. Not with practice

The name of a new practice to create the tenant in, the caller its first member: an accountant setting up a
client. Not with practice

JSON Example

{
  "name": "string",
  "isVatRegistered": false,
  "vatRegistrationNumber": "string",
  "modules": [
    "CisContractor"
  ],
  "practice": "00000000-0000-0000-0000-000000000000"
}

Used By Operations