Skip to main content

Tenant

Represents a tenant - the top-level organizational unit in the system. Tenants contain channels and have their own configuration settings.

type Tenant {
  id: String!
  name: String!
  descriptions: [LocalizedString!]
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  restrictSalesPricingVisibility: RESTRICT_SALES_PRICING_VISIBILITY!
  allowQuoteInvalidation: ALLOW_QUOTE_INVALIDATION!
  quoteDefaultExpiryPeriodDays: Int
  channels: [Channel!]!
}

Fields​

Tenant.id ● String! non-null scalar​

Unique identifier for the tenant. Used for tenant resolution and all tenant-related operations.

Tenant.name ● String! non-null scalar​

Display name of the tenant. Used in user interfaces and for tenant identification.

Tenant.descriptions ● [LocalizedString!] list object​

Localized descriptions of the tenant in different languages. Provides multilingual support for tenant information display.

Tenant.createdAt ● DateTime! non-null scalar​

Timestamp when the tenant was created. Used for auditing and chronological ordering.

Tenant.lastModifiedAt ● DateTime! non-null scalar​

Timestamp when the tenant was last modified. Updated automatically on any tenant changes.

Tenant.restrictSalesPricingVisibility ● RESTRICT_SALES_PRICING_VISIBILITY! non-null enum​

[SETTING] Controls whether sales pricing information is restricted within this tenant. Affects visibility of detailed pricing data to users.

Tenant.allowQuoteInvalidation ● ALLOW_QUOTE_INVALIDATION! non-null enum​

[SETTING] Controls whether quotes can be manually invalidated within this tenant.

Tenant.quoteDefaultExpiryPeriodDays ● Int scalar​

[SETTING] Default number of days before quotes expire within this tenant. Used as the default expiry period when creating new quotes if not specified otherwise.

Tenant.channels ● [Channel!]! non-null object​

Resolves all channels belonging to this tenant. Provides access to the tenant's channel hierarchy and configuration.

Errors: CHANNEL_LIST_ERROR if channel retrieval fails.

Returned By​

tenant query ● tenantCreate mutation ● tenantUpdate mutation

Member Of​

AdminUserTenant object ● Channel object