format()

Updated: 2025-03-25

The format() function is commonly used in templates to format numbers, dates and other information. It is the first function to reach for when you need to display data in the correct format. Simply applying the format() function without specifying additional parameters can quickly change the output.

The format() function respects regional settings and will display currency and dates in the language of the template. 

Currency

Apply format() to any numerical field code to display it as currency. 

• TaxCycle does not add the number sign before currency. If you want the number sign in your template, add it in the plain text next to the field code.
• If you are creating a formula by adding or subtracting field codes, add the format() around the full formula to display the result as currency.
• To change the decimals, round to the place value using "C0" for no decimals, "C" or "C2" for two decimals. This will round the number up or down. See also round() and abs().

Dates

By default, TaxCycle displays the full date and time for any date field. Apply format() and related parameters to adjust the display of the date.

• After the field code, add a comma, then the date of "January 2, 2003" to indicate the format you prefer.
• You can also use traditional date format masks. See the table on the Microsoft Custom Date and Time Format Strings page for a list of supported format strings.

Phone number

Apply format() to add the parentheses and dash to a phone number field.

Postal code

Apply format() to add the space to a postal code field.

Social Insurance and Business Numbers

Apply format() add spaces to a social insurance number. Add Field to the end of a business number to display the account type. This can be combined with the mask() function.

Text 

Apply format() and the "text" parameter to display the text version of a dropdown field. See also abbreviate() and Example: T3 Trust Type Dropdown Fields in Templates.

Code

Apply format() and the "code" parameter to display the code from dropdown field. See also Example: T3 Trust Type Dropdown Fields in Templates.