TenantInfo
Information about a tenant that a user belongs to, including statistics and role information
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The tenant's unique code |
The tenant's unique code | ||
| name | string | The tenant's name |
The tenant's name | ||
| joinedDate | string | When the user was added to this tenant |
When the user was added to this tenant | ||
| accountingConnection | CodeAndNameDto | |
| directDebitConnection | CodeAndNameDto | |
| amlConnection | CodeAndNameDto | |
| documentStorageConnection | CodeAndNameDto | |
| activeClientCount | integer | Count of clients with Active status |
Count of clients with Active status | ||
| inactiveClientCount | integer | Count of clients with Inactive status |
Count of clients with Inactive status | ||
| prospectClientCount | integer | Count of clients with Prospect status |
Count of clients with Prospect status | ||
| lostProspectClientCount | integer | Count of clients with LostProspect status |
Count of clients with LostProspect status | ||
| 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 | ||
| canAccessBetaFeatures | boolean | Whether the tenant can access beta features |
Whether the tenant can access beta features | ||
| isDisabled | boolean | Whether the tenant is disabled |
Whether the tenant is disabled | ||
| isMissingRequiredBillingInfo | boolean | Whether the tenant is on a paid plan but hasn't completed billing/DD setup |
Whether the tenant is on a paid plan but hasn't completed billing/DD setup | ||
| isSubscriptionCancelled | boolean | Whether the tenant has cancelled their subscription |
Whether the tenant has cancelled their subscription | ||
| role | RoleInfo | |
JSON Example
{
"code": "string",
"name": "string",
"joinedDate": "2024-01-01T00:00:00Z",
"accountingConnection": {
"code": "string",
"name": "string"
},
"directDebitConnection": {
"code": "string",
"name": "string"
}
}