CurrencyValue
Returns the currency amount of a currency value. A currency value is a combination of the currency amount and the currency code, such as 3 USD.
- Use this function to return the currency amount portion of a currency value.
- Use the CurrencyCode function to return the currency code portion of a currency value.
Syntax
CurrencyValue(currencyValue)
Enabled For
For a description of the business object categories, see Notes on "Enabled For".
Business object category | Yes/No |
|---|---|
Business Rules: Before-Save Rules | Yes |
Business Rules: Calculation Rules (After Save, with or without Also Recalculate on Load) | Yes |
Business Rules: Calculation Rules (Before Save or Always, without Also Recalculate On Load) | Yes |
Business Rules: Calculation Rules (Before Save or Always, with Recalculate On Load) | Yes |
Business Rules: Editing Rules | Yes |
Business Rules: Initialization Rules | Yes |
Business Rules: Read Only Rules | Yes |
Business Rules: Required Rules | Yes |
Business Rules: Validation Rules | Yes |
Client Expressions | Yes |
Object Permissions | No |
Services | Yes |
LDAP | Yes |
Mobile | Yes |
Quick Actions (except UI Quick Actions and excel export) | Yes |
UI Quick Actions | Yes |
Reports | Yes |
Search/Dashboard without field references | Yes |
Search/Dashboard with field references | No |
Parameter
Parameter | Description |
|---|---|
currencyValue | The currency value (a combination of the currency amount and the currency code, such as 3 USD) from which to extract the currency amount. |
Return Value
Number value. Returns the currency amount of the currency value that was input.
Examples
$(CurrencyValue(44.2HKD)
The example above returns "44.2", which is the currency amount of the input.
$(CurrencyValue(Component_Cost)
If Component_Cost is the name of a field that contains a currency value, this example returns the currency amount of that field. If the Component_Cost field contains "24 USD", this example returns "24".