TenantSetting

A setting of the organization.

type TenantSetting {
  category: SettingCategory!
  createdAt: DateTime!
  dataType: SettingDataType!
  description: String
  enteredBy: String!
  id: ID!
  isActive: Boolean!
  isDefault: Boolean!
  key: String!
  organizationId: String!
  updatedAt: DateTime!
  updatedBy: String!
  validationRule: String
  value: JSON
}

Fields

TenantSetting.category ● SettingCategory! non-null enum

The group the setting is in.

TenantSetting.createdAt ● DateTime! non-null scalar

When the record was created.

TenantSetting.dataType ● SettingDataType! non-null enum

The data type of the value.

TenantSetting.description ● String scalar

What the setting does.

TenantSetting.enteredBy ● String! non-null scalar

The ID of the user who created the record.

TenantSetting.id ● ID! non-null scalar

The unique ID of this record.

TenantSetting.isActive ● Boolean! non-null scalar

Whether the record is active.

TenantSetting.isDefault ● Boolean! non-null scalar

Whether this is the default.

TenantSetting.key ● String! non-null scalar

The key of the setting.

TenantSetting.organizationId ● String! non-null scalar

The ID of the organization the record belongs to.

TenantSetting.updatedAt ● DateTime! non-null scalar

When the record was last changed.

TenantSetting.updatedBy ● String! non-null scalar

The ID of the user who last changed the record.

TenantSetting.validationRule ● String scalar

A rule the value must follow.

TenantSetting.value ● JSON scalar

The value.

Returned By

bulkUpdateTenantSettings mutation ● createTenantSetting mutation ● deleteTenantSetting mutation ● tenantSetting query ● tenantSettingByKey query ● tenantSettingsByCategory query ● updateAccountingSettings mutation ● updateAPISettings mutation ● updateAppearanceSettings mutation ● updateBackupSettings mutation ● updateCompanySettings mutation ● updateDocumentSettings mutation ● updateEmailSettings mutation ● updateInventorySettings mutation ● updateNotificationSettings mutation ● updatePurchaseSettings mutation ● updateSalesSettings mutation ● updateSecuritySettings mutation ● updateSystemSettings mutation ● updateTenantSetting mutation ● updateUserSettings mutation ● updateWebhookSettings mutation ● updateWorkflowSettings mutation

Member Of

PaginatedSettingsResponse object ● SettingsGroup object