Tenants
The tenants (organisations) the authenticated user is a member of: the {tenant} code used in every other route, the tenant's modules, contact and VAT details, and its dashboard counts. A tenant the caller is not a member of is not found. Also creating a tenant, replacing its details (a changed email address is re-verified), its logo, its own CIS details as a subcontractor, the data-config export and import, and the caller's tenant summaries.
-
GET List TenantsLists the tenants the authenticated user is a member of./tenants
-
POST Create TenantCreates a tenant owned by the caller, with the given name, VAT status and modules; its email address and phone number start as the caller's. A contrac.../tenants
-
GET Get TenantReturns a tenant the authenticated user is a member of, or (for a support agent) a tenant that has enabled support access; isSupportAccess says which./tenants/{tenant}
-
PUT Update TenantReplaces the tenant's details and modules. A changed email address un-verifies the tenant and sends a verification email to the new address./tenants/{tenant}
-
GET List Tenant SummariesThe caller's tenants with their customer and supplier counts and the CIS returns of the current and last tax periods, as the overview page shows them./tenants/summaries
-
POST Send Tenant Email VerificationSends (again) the email that verifies the tenant's email address; 202. 400 when the tenant has no email address./tenants/{tenant}/email-verification
-
GET Get Tenant LogoThe tenant's logo image; 404 when none is uploaded./tenants/{tenant}/logo
-
PUT Update Tenant LogoReplaces the tenant's logo (multipart/form-data, field 'file'; jpg, png, gif, bmp or svg up to 2 MB)./tenants/{tenant}/logo
-
GET Export Tenant DataThe tenant's contacts as a data-config JSON file, which the import takes back (for copying contacts between tenants)./tenants/{tenant}/export
-
POST Import Tenant DataCreates the contacts in a data-config JSON file (multipart/form-data, field 'file'), skipping codes that already exist unless skipExisting=false. A fi.../tenants/{tenant}/import
-
GET Get Tenant CIS DetailsThe tenant's own CIS identity as a subcontractor (subcontractor module): what it shares with contractors over a connection. Empty, with needsConfig, u.../tenants/{tenant}/settings/cis-details
-
PUT Update Tenant CIS DetailsReplaces the tenant's CIS details. The UTR, NI number and company number are validated for their format (400)./tenants/{tenant}/settings/cis-details