Formatting
Format variables the way you want them to look
To format numbers, use the
$number format function: 
Variable Name: the name of your variable that will contain the value to be formatted.
Format String: the text code that tells Documint how to would like to format the value
Used for applying custom formatting to numbers.
{{$number value format_string [locale]}}Name | Description | Type | Required |
|---|---|---|---|
value | Name of variable to be formatted | Number | |
format_string | String | ||
locale | String | ||
default= | Default value to display when value is blank. Default='' | String Number |
Formatted number
// given qty_sold is 1250
{{$number qty_sold "0,0"}} // 1,250
// given qty_sold is blank
{{$number qty_sold "0,0" default="0"}} // 0
Value | Format String | Result |
|---|---|---|
10000
| "0,0.0000" | 10,000.0000 |
10000.23 | "0,0" | 10,000 |
10000.23 | "+0,0" | +10,000 |
-10000 | "0,0.0" | -10,000.0 |
10000.1234 | '0.000' | 10000.123 |
100.1234 | "00000" | 00100 |
1000.1234 | "000000,0" | 001,000 |
10 | "000.00" | 010.00 |
10000.1234 | "0[.]00000" | 10000.12340 |
-10000 | "(0,0.0000)" | (10,000.0000) |
-0.23 | ".00" | -.23 |
-0.23 | "(.00)" | (.23) |
0.23 | "0.00000" | 0.23000 |
0.23 | "0.0[0000]" | 0.23 |
1230974 | "0.0a" | 1.2m |
1460 | "0 a" | 1 k |
-104000 | "0a" | -104k |
1 | "0o" | 1st |
100 | "0o" | 100th |
Formats
Locales
Example:
// given grand_total is 1800
{{$number grand_total "$0,0.00"}} // $1,800.00
Number | Format String | String |
1000.234 | '$0,0.00' | $1,000.23 |
1000.2 | '0,0[.]00 $' | 1,000.20 $ |
1001 | '$ 0,0[.]00' | $ 1,001 |
-1000.234 | '($0,0)' | ($1,000) |
-1000.234 | '$0.00' | -$1000.23 |
1230974 | '($ 0.00 a)' | $ 1.23 m |
You can set the locale using the locale code as the third argument.
// grand_total = 15000
{{$number grand_total "$0,0.00" "en-gb"}}
// Result: £15,000.00
Name | Code | Example |
United States | [default] | $1,000.00 |
Bulgarian | bg | лв1 000,00 |
Chinese (Simplified) | chs | ¥1,000.00 |
Czech | cs | Kč1 000,00 |
Danish (Denmark) | da-dk | DKK1.000,00
|
German (Switzerland) | de-ch | CHF1 000,00 |
German | de | €1 000,00 |
English (Australia) | en-au | $1,000.00 |
English (UK) | en-gb | £1,000.00 |
English (South Africa) | en-za | R1 000,00 |
Spanish (Spain) | es-es | €1.000,00 |
Spanish | es | $1.000,00 |
Estonian | et | €1 000,00 |
Finnish | fi | €1 000,00 |
French (Canada) | fr-ca | $1 000,00 |
French (Switzerland) | fr-ch | CHF1'000.00 |
French | fr | €1 000,00 |
Hungarian | hu | Ft1 000,00 |
Italian | it | €1.000,00 |
Japanese | ja | ¥1,000.00 |
Latvian | lv | €1 000,00 |
Dutch (Belgium) | nl-be | € 1 000,00 |
Dutch (Netherlands) | nl-nl | € 1.000,00 |
Norwegian | no | kr1 000,00 |
Polish | pl | PLN1 000,00 |
Portuguese (Brazil) | pt-br | R$1.000,00 |
Portuguese | pt-pt | €1 000,00 |
Russian (Ukraine) | ru-ua | ₴1 000,00 |
Russian | ru | руб.1 000,00 |
Slovak | sk | €1 000,00 |
Slovenian | sl | €1.000,00 |
Thai | th | ฿1,000.00 |
Turkish | tr | ₺1.000,00 |
Ukrainian (Ukraine) | uk-ua | ₴1 000,00 |
Vietnam | vi | ₫1.000,00 |
// grand_total = 15000
{{$number grand_total "0,0.0$" s="$U" t="," d="." }}
// Result: 15,000.00$U
Name | Code | Default Value |
Currency Symbol | s | $ |
Thousands Separator | t | , |
Decimal | d | . |
Thousands Abbreviation | th | k |
Millions Abbreviation | mi | m |
Billions Abbreviation | bi | b |
Trillions Abbreviation | tr | t |
Number | Format String | String |
1 | '0%' | 100% |
0.974878234 | '0.000%' | 97.488% |
-0.43 | '0 %' | -43 % |
0.43 | '(0.000 %)' | 43.000 % |
Number | Format String | String |
25 | '00:00:00' | 0:00:25 |
238 | '00:00:00' | 0:03:58 |
63846 | '00:00:00' | 17:44:06 |
To format dates, use the
$date format function:
Example
// given invoice_date is "2021-05-18T20:05:07Z"
{{$date invoice_date "MM/DD/YYYY h:mm a"}} // 05/18/2021 8:05 pm
Formats
Timezones
Description | Token | Output |
Month | M | 1 2 ... 11 12 |
| Mo | 1st 2nd ... 11th 12th |
| MM | 01 02 ... 11 12 |
| MMM | Jan Feb ... Nov Dec |
| MMMM | January February ... November December |
Quarter | Q | 1 2 3 4 |
| Qo | 1st 2nd 3rd 4th |
Day of Month | D | 1 2 ... 30 31 |
| Do | 1st 2nd ... 30th 31st |
| DD | 01 02 ... 30 31 |
Day of Year | DDD | 1 2 ... 364 365 |
| DDDo | 1st 2nd ... 364th 365th |
| DDDD | 001 002 ... 364 365 |
Day of Week | d | 0 1 ... 5 6 |
| do | 0th 1st ... 5th 6th |
| dd | Su Mo ... Fr Sa |
| ddd | Sun Mon ... Fri Sat |
| dddd | Sunday Monday ... Friday Saturday |
Day of Week (Locale) | e | 0 1 ... 5 6 |
Day of Week (ISO) | E | 1 2 ... 6 7 |
Week of Year | w | 1 2 ... 52 53 |
| wo | 1st 2nd ... 52nd 53rd |
| ww | 01 02 ... 52 53 |
Week of Year (ISO) | W | 1 2 ... 52 53 |
| Wo | 1st 2nd ... 52nd 53rd |
| WW | 01 02 ... 52 53 |
Year | YY | 70 71 ... 29 30 |
| YYYY | 1970 1971 ... 2029 2030 |
| YYYYYY | -001970 -001971 ... +001907 +001971
Note: Expanded Years (Covering the full time value range of approximately 273,790 years forward or backward from 01 January, 1970) |
| Y | 1970 1971 ... 9999 +10000 +10001
Note: This complies with the ISO 8601 standard for dates past the year 9999 |
Era Year | y | 1 2 ... 2020 ... |
Era | N, NN, NNN | BC AD
Note: Abbr era name |
| NNNN | Before Christ, Anno Domini
Note: Full era name |
| NNNNN | BC AD
Note: Narrow era name |
Week Year | gg | 70 71 ... 29 30 |
| gggg | 1970 1971 ... 2029 2030 |
Week Year (ISO) | GG | 70 71 ... 29 30 |
| GGGG | 1970 1971 ... 2029 2030 |
AM/PM | A | AM PM |
| a | am pm |
Hour | H | 0 1 ... 22 23 |
| HH | 00 01 ... 22 23 |
| h | 1 2 ... 11 12 |
| hh | 01 02 ... 11 12 |
| k | 1 2 ... 23 24 |
| kk | 01 02 ... 23 24 |
Minute | m | 0 1 ... 58 59 |
| mm | 00 01 ... 58 59 |
Second | s | 0 1 ... 58 59 |
| ss | 00 01 ... 58 59 |
Fractional Second | S | 0 1 ... 8 9 |
| SS | 00 01 ... 98 99 |
| SSS | 000 001 ... 998 999 |
| SSSS ... SSSSSSSSS | 000[0..] 001[0..] ... 998[0..] 999[0..] |
Time Zone | z or zz | EST CST ... MST PST
Note: as of 1.6.0, the z/zz format tokens have been deprecated from plain moment objects. Read more about it here. However, they *do* work if you are using a specific time zone with the moment-timezone addon. |
| Z | -07:00 -06:00 ... +06:00 +07:00 |
| ZZ | -0700 -0600 ... +0600 +0700 |
Unix Timestamp | X | 1360013296 |
Unix Millisecond Timestamp | x | 1360013296123 |
Specify the timezone by adding
tz="<timezone name>" to the date formatter like so:{{$date date_created "MM/DD/YYYY h:mm a" tz="America/New_York"}}
Timezone Names | | |
|