TenantLocalization

Localization and regional settings configuration for a tenant workspace, defining default timezone, language, currency, and date/time formatting preferences. This entity enables tenant-specific localization where each organization can configure their preferred regional settings that apply to all users by default (users can override in their personal preferences). It supports international multi-tenant platforms where tenants operate in different countries, use different languages, and transact in different currencies. The entity defines display formats for dates and times, default currency for financial operations, timezone for scheduling and timestamps, and language/locale for UI translations. It serves as the internationalization (i18n) and localization (l10n) layer for multi-tenant platforms, ensuring that each tenant sees data formatted according to their regional conventions and business requirements.

8 properties

Schema

Properties

Property	Type	Mode	Description	Required
tenant	Tenant	stored	Reference to the Tenant this localization configuration applies to	Required
defaultTimezone	Timezone	stored	Default timezone for this tenant (reference to Timezone entity from IANA timezone database)	Required
defaultLocale	Locale	stored	Default locale for this tenant (reference to Locale entity with BCP 47 language tag)	Required
defaultCurrency	Currency	stored	Default currency for financial operations and display (reference to Currency entity)	Required
dateFormat	string	stored	Preferred date format for displays Values: `MM/DD/YYYY, DD/MM/YYYY, YYYY-MM-DD, DD.MM.YYYY` Example: `"MM/DD/YYYY"`	Required
timeFormat	string	stored	Preferred time format Values: `12h, 24h` Example: `"12h"`	Required
firstDayOfWeek	string	stored	First day of the week for calendar displays Values: `sunday, monday` Example: `"monday"`	Optional
metadata	json	stored	Additional localization metadata (custom date patterns, translations, etc.)	Optional

Examples

Example 1

{
  "@type": "TenantLocalization",
  "tenant": {
    "@type": "Tenant",
    "slug": "acme-corp",
    "name": "ACME Corporation"
  },
  "defaultTimezone": {
    "@type": "Timezone",
    "identifier": "America/New_York",
    "displayName": "Eastern Time (US & Canada)"
  },
  "defaultLocale": {
    "@type": "Locale",
    "code": "en-US",
    "displayName": "English (United States)"
  },
  "defaultCurrency": {
    "@type": "Currency",
    "code": "USD",
    "name": "US Dollar",
    "symbol": "$"
  },
  "dateFormat": "MM/DD/YYYY",
  "timeFormat": "12h",
  "firstDayOfWeek": "sunday"
}

Example 2

{
  "@type": "TenantLocalization",
  "tenant": {
    "@type": "Tenant",
    "slug": "acme-europe",
    "name": "ACME Europe"
  },
  "defaultTimezone": {
    "@type": "Timezone",
    "identifier": "Europe/Paris",
    "displayName": "Central European Time"
  },
  "defaultLocale": {
    "@type": "Locale",
    "code": "fr-FR",
    "displayName": "French (France)"
  },
  "defaultCurrency": {
    "@type": "Currency",
    "code": "EUR",
    "name": "Euro",
    "symbol": "€"
  },
  "dateFormat": "DD/MM/YYYY",
  "timeFormat": "24h",
  "firstDayOfWeek": "monday"
}

Example 3

{
  "@type": "TenantLocalization",
  "tenant": {
    "@type": "Tenant",
    "slug": "techstart",
    "name": "TechStart Inc"
  },
  "defaultTimezone": {
    "@type": "Timezone",
    "identifier": "Europe/London",
    "displayName": "British Time"
  },
  "defaultLocale": {
    "@type": "Locale",
    "code": "en-GB",
    "displayName": "English (United Kingdom)"
  },
  "defaultCurrency": {
    "@type": "Currency",
    "code": "GBP",
    "name": "British Pound Sterling",
    "symbol": "£"
  },
  "dateFormat": "DD/MM/YYYY",
  "timeFormat": "24h",
  "firstDayOfWeek": "monday"
}