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 supports English (
-
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:
| Locale | Language | Currency | Time format | Weight | Distance |
|---|---|---|---|---|---|
en | English (GB) | Company default | 12-hour | kg | metric |
en_GB | English (GB) | GBP | 12-hour | kg | metric |
en_US | English (US) | USD | 12-hour | lb | imperial |
de | German | Company default | 24-hour | kg | metric |
de_DE | German | EUR | 24-hour | kg | metric |
de_CH | German | CHF | 24-hour | kg | metric |
es | Spanish | Company default | 24-hour | kg | metric |
es_ES | Spanish | EUR | 24-hour | kg | metric |
en_SE | English | SEK | 12-hour | kg | metric |
pl | Polish | Company default | 24-hour | kg | metric |
ja | Japanese | Company default | 24-hour | kg | metric |
zh-CN | Chinese | CNY | 24-hour | kg | metric |
nl | Dutch | Company default | 24-hour | kg | metric |

