TenantDto

An organisation (tenant) and its configuration

Properties

Name	Type	Description
code*	string	The URL-friendly unique identifier for the tenant (used in API paths)
The URL-friendly unique identifier for the tenant (used in API paths)
name*	string	The human-readable name of the tenant
The human-readable name of the tenant
status	enum	LapsedTrialist LapsedCustomer ActiveTrialist PendingConversion PayingCustomer Freemium
LapsedTrialist LapsedCustomer ActiveTrialist PendingConversion PayingCustomer Freemium
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
accountingConnection	CodeAndNameDto
directDebitConnection	CodeAndNameDto
amlConnection	CodeAndNameDto
documentStorageConnection	CodeAndNameDto
proposalConnection	CodeAndNameDto
autoCreateClientFolders	boolean	Whether Sodium automatically creates subfolders for each client under the document storage base folder. Only applicable when an external document storage provider is connected. When false, users must manually map each client to a pre-existing folder.
Whether Sodium automatically creates subfolders for each client under the document storage base folder. Only applicable when an external document storage provider is connected. When false, users must manually map each client to a pre-existing folder.
activeClientCount	integer	Count of clients with Active status. Null when the requesting user's role has no view access to Clients.
Count of clients with Active status. Null when the requesting user's role has no view access to Clients.
inactiveClientCount	integer	Count of clients with Inactive status. Null when the requesting user's role has no view access to Clients.
Count of clients with Inactive status. Null when the requesting user's role has no view access to Clients.
prospectClientCount	integer	Count of clients with Prospect status. Null when the requesting user's role has no view access to Clients.
Count of clients with Prospect status. Null when the requesting user's role has no view access to Clients.
lostProspectClientCount	integer	Count of clients with LostProspect status. Null when the requesting user's role has no view access to Clients.
Count of clients with LostProspect status. Null when the requesting user's role has no view access to Clients.
servicesCount	integer	Count of services in the tenant
Count of services in the tenant
workFlowsCount	integer	Count of workflows in the tenant
Count of workflows in the tenant
usersCount	integer	Count of users in the tenant
Count of users in the tenant
kanbanBoardServiceCount	integer	Count of services with kanban boards enabled
Count of services with kanban boards enabled
kanbanBoardPipelineCount	integer	Count of pipelines with kanban boards enabled
Count of pipelines with kanban boards enabled
salesPipelineEnabled	boolean	Whether the Sales Pipeline feature is enabled for this tenant. Gates the pipeline UI.
Whether the Sales Pipeline feature is enabled for this tenant. Gates the pipeline UI.
proposalsSentThisMonth	integer	Number of unique proposals sent this calendar month
Number of unique proposals sent this calendar month
isSupportAccessEnabled	boolean	Whether or not support access is enabled, allowing support agents to access the tenant's data for troubleshooting.
Whether or not support access is enabled, allowing support agents to access the tenant's data for troubleshooting.
canAccessBetaFeatures	boolean	Whether this tenant can access beta features
Whether this tenant can access beta features
isDisabled	boolean	Whether this tenant is disabled
Whether this tenant is disabled
disabledReason	string	The reason the tenant was disabled, if applicable
The reason the tenant was disabled, if applicable
isTasksDisabled	boolean	Whether task materialization is disabled for this tenant
Whether task materialization is disabled for this tenant
isMissingRequiredBillingInfo	boolean	Whether this tenant is on a paid plan but hasn't completed billing/DD setup
Whether this tenant is on a paid plan but hasn't completed billing/DD setup
isSubscriptionCancelled	boolean	Whether this tenant has cancelled their subscription. Cancelled tenants retain access until their current subscription ends.
Whether this tenant has cancelled their subscription. Cancelled tenants retain access until their current subscription ends.
lastUserLogin	string	The most recent login timestamp across all users in this tenant
The most recent login timestamp across all users in this tenant
expiredDate	string	When the tenant's subscription expired: the EndDate of the most recently ended subscription. Null for tenants that have never had a subscription end. Primarily relevant for lapsed trialists and customers.
When the tenant's subscription expired: the EndDate of the most recently ended subscription. Null for tenants that have never had a subscription end. Primarily relevant for lapsed trialists and customers.
trialEndDate	string	The EndDate of the tenant's current, in-progress free trial - a future date while the trial is running, otherwise null. Drives the "days left" countdown for active trialists. Distinct from ExpiredDate, which reflects the last subscription that already ended.
The EndDate of the tenant's current, in-progress free trial - a future date while the trial is running, otherwise null. Drives the "days left" countdown for active trialists. Distinct from ExpiredDate, which reflects the last subscription that already ended.
convertedDate	string	When the tenant first moved off trial onto a real tier: the earliest StartDate among non-trial subscriptions (paid or freemium). Null while still trialling, or lapsed without ever converting.
When the tenant first moved off trial onto a real tier: the earliest StartDate among non-trial subscriptions (paid or freemium). Null while still trialling, or lapsed without ever converting.
pendingSubscriptionStartDate	string	StartDate of the earliest non-trial subscription lined up to start in the future (e.g. a package chosen during a trial). Null when nothing is scheduled.
StartDate of the earliest non-trial subscription lined up to start in the future (e.g. a package chosen during a trial). Null when nothing is scheduled.
pendingSubscriptionPackageName	string	Name of the package on the pending subscription (the one PendingSubscriptionStartDate refers to)
Name of the package on the pending subscription (the one PendingSubscriptionStartDate refers to)
logoUrl	string	The URL of the tenant's logo image
The URL of the tenant's logo image
currentUserRoleName	string	The requesting user's role within this tenant - the SystemRole name ("Admin", "StandardUser", "Viewer") for system roles, or the custom role's name. Only populated by the user-facing tenant list (GET /tenants); null on admin endpoints, which are not scoped to a single user's membership.
The requesting user's role within this tenant - the SystemRole name ("Admin", "StandardUser", "Viewer") for system roles, or the custom role's name. Only populated by the user-facing tenant list (GET /tenants); null on admin endpoints, which are not scoped to a single user's membership.

JSON Example

{
  "code": "string",
  "name": "string",
  "status": "LapsedTrialist",
  "createdDate": "2024-01-01T00:00:00Z",
  "updatedDate": "2024-01-01T00:00:00Z"
}

TenantDto

Properties

JSON Example

Used By Operations