API Docs / Schemas / TenantInfo

TenantInfo

Information about a tenant that a user belongs to, including statistics and role information

Properties

Name Type Description
codestring

The tenant's unique code

The tenant's unique code

namestring

The tenant's name

The tenant's name

joinedDatestring

When the user was added to this tenant

When the user was added to this tenant

accountingConnectionCodeAndNameDto
directDebitConnectionCodeAndNameDto
activeClientCountinteger

Count of clients with Active status

Count of clients with Active status

inactiveClientCountinteger

Count of clients with Inactive status

Count of clients with Inactive status

prospectClientCountinteger

Count of clients with Prospect status

Count of clients with Prospect status

lostProspectClientCountinteger

Count of clients with LostProspect status

Count of clients with LostProspect status

servicesCountinteger

Count of services in the tenant

Count of services in the tenant

workFlowsCountinteger

Count of workflows in the tenant

Count of workflows in the tenant

usersCountinteger

Count of users in the tenant

Count of users in the tenant

roleRoleInfo

JSON Example

{
  "code": "string",
  "name": "string",
  "joinedDate": "2024-01-01T00:00:00Z",
  "accountingConnection": {
    "code": "string",
    "name": "string"
  },
  "directDebitConnection": {
    "code": "string",
    "name": "string"
  }
}

Contained in Schemas