a!currency() Function

Localizes a currency value based on the given ISO currency code.

Parameters

a!currency( isoCode, value, decimalPlaces, showSeparators, format, indicatorAlignment )

Returns

Text

Using the function

The following sections cover important details about the a!currency() function.

Using the isoCode parameter

The isoCode parameter is required and only accepts one valid ISO code, like "USD" or "EUR".

To display the generic currency symbol (¤), use "XXX" for the isoCode parameter.

Using the value parameter

If no value is passed, the function returns the currency code or symbol of the entered ISO code.

Using the decimalPlaces parameter

If no decimalPlaces value is passed, the function uses the format of the entered ISO code. Most currencies have two decimal places after the decimal separator but some have three, four, or zero.

The decimalPlaces parameter also accepts negative values up to -17. Entering a negative value zeroes out the entered number of places on the integer side of the decimal point. For example, if your value is 12345 and you enter -4 for the parameter value, the function returns 10000. If you enter -3, the function returns 12000. A value of -5 in this example returns 0.

Using the showSeparators parameter

The showSeparators parameter determines whether the function uses digit separators. How those digit separators appear is determined by the user's locale settings. For example, if the user's locale is set to English (US), digit separators appear as commas (,). If the user's locale is set to Spanish, digit separators appear as periods (.).

If no showSeparators value is passed, the function shows separators by default.

If you need to format a currency value using apostrophes (') as the digit separators, use the a!swissFranc() function.

Using the format parameter

The format parameter determines how the currency indicator displays, for example "CODE" (USD) or "SYMBOL" ($).

If no format value is passed, the function uses "LOCALE" by default. The "LOCALE" setting uses the logged-in user's locale setting to determine whether to use a symbol or the ISO code for the currency indicator.

Using the indicatorAlignment parameter

The indicatorAlignment parameter determines where the currency indicator displays in relation to the value, for example, at the "START" or "END" of the value.

If no indicatorAlignment value is passed, the function uses "LOCALE" by default. The "LOCALE" setting uses the logged-in user's locale setting to determine where to place the currency indicator.

Examples

The following examples demonstrate the a!currency() function.

To experiment with examples, copy and paste the expression into an expression rule and click TEST RULE to see the output.

Locale differences

Default behavior

1
2
3
4
a!currency(
  isoCode: "USD",
  value: 1234.56
)

If user's locale is set to English (United States), returns $1,234.56.

If user's locale is set to Español, returns 1.234,56 US$.

If user's locale set to Français (Canada), returns 1 234,56 $ US.

Override defaults

1
2
3
4
5
6
7
a!currency(
  isoCode: "USD",
  value: 1234.56,
  showSeparators: false,
  format: "CODE",
  indicatorAlignment: "START"
)

If user's locale is set to English (United States), returns USD 1234.56.

If user's locale is set to Español, returns USD 1234,56.

If user's locale set to Français (Canada), returns USD 1234,56.

Decimal places

Decimal rounding

1
2
3
4
a!currency(
  isoCode: "USD",
  value: 1234.5678
)

Returns $1,234.57. To maintain the precise value, change the decimalPlaces parameter to 4.

Negative decimalPlaces value

1
2
3
4
5
a!currency(
  isoCode: "USD",
  value: 1234.5678,
  decimalPlaces: -3
)

Returns $1,000.

Formatting

1
2
3
4
5
a!currency(
  isoCode: "USD",
  value: 1234.56,
  format: "SYMBOL"
)

Returns $1,234.56.

Changing the format value to "CODE" returns USD 1,234.56.

Indicator alignment

1
2
3
4
5
a!currency(
  isoCode: "USD",
  value: 1234.56,
  indicatorAlignment: "START"
)

Returns $1,234.56.

Changing the indicatorAlignment value to "END" returns 1,234.56 $.

Feature compatibility

Old versions

There are older versions of this function . You can identify older versions by looking at the name to see if there is a version suffix. If you are using an old version, be sure to refer to the corresponding documentation from the list below.

To use the latest version of the function, replace the function with a version suffix with a new function reference.

To learn more about how Appian handles this kind of versioning, see the Function and Component Versions page.

Feedback