API Docs / Schemas / TenantDto

TenantDto

Response DTO for tenant details that excludes internal database IDs.
Used in API responses to prevent exposing internal identifiers.

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

createdDatestring

When the tenant was created

When the tenant was created

updatedDatestring

When the tenant was last updated

When the tenant was last updated

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

JSON Example

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

Used By Operations