Setting the locale for users

The locale field controls how Perk displays to a given user. Localization currently covers the language, currency, and 12-hour or 24-hour time format. Each locale value is tied to a country or territory, and comes with its currency and language.

Perk uses the locale field only on user creation. Once a user signs into Perk, they can update any of these individual values in their user profile.

Perk's SCIM integration processes the locale field as follows:

  • Perk uses the first part of a given value as the language. Perk splits the value on the - or _ character, whichever is present.

    • Perk supports English (en), Spanish (es), German (de), French (fr), and Italian (it). Any other language value defaults to English.
    • Perk also uses this value to set the time format. English-speaking locales, where the first part equals en, use the 12-hour format, and all others use the 24-hour format.
  • Perk uses the second part to determine the country, which sets the currency. You can use the values from the ISO 3166-1 alpha-2 country codes. Perk displays pricing in the national currency of that country.

    • This doesn't affect how the company is invoiced, only how prices appear to the booker.
    • If no second part is provided, Perk uses the value from Company language and region settings as the default.

The country also sets several other locale settings:

  • Weight units are set to kilograms (kg) everywhere, except the USA, where they're set to pounds (lb).
  • Distance units are set to metric everywhere, except the USA, where they're set to imperial.
  • The week start day is set to Monday everywhere, except the USA, where it's set to Sunday.

The field isn't case sensitive.

Here are some examples of usage:

LocaleLanguageCurrencyTime formatWeightDistance
enEnglish (GB)Company default12-hourkgmetric
en_GBEnglish (GB)GBP12-hourkgmetric
en_USEnglish (US)USD12-hourlbimperial
deGermanCompany default24-hourkgmetric
de_DEGermanEUR24-hourkgmetric
de_CHGermanCHF24-hourkgmetric
esSpanishCompany default24-hourkgmetric
es_ESSpanishEUR24-hourkgmetric
en_SEEnglishSEK12-hourkgmetric
plPolishCompany default24-hourkgmetric
jaJapaneseCompany default24-hourkgmetric
zh-CNChineseCNY24-hourkgmetric
nlDutchCompany default24-hourkgmetric