EXCHANGE - Convert a value between two currencies (Reports & Settings Report Generator function)

From Catalyst
Revision as of 13:03, 22 September 2016 by ThrashBot (talk | contribs) (Updated from revision control)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Syntax

$EXCHANGE{amount, currency1, currency2, date}

Description

This function converts an amount from currency1 to currency2 using the exchange rates in effect on the date specified.

If either of the two currencies does not exist, or if rates between the two currencies do not exist on the date specified, then the value returned will be zero.


Parameters

amount
A numeric parameter that can not be omitted.
The amount to convert.
currency1
A text parameter that can be omitted.
The source currency: the currency to convert the amount from. If omitted then the System Base Currency is assumed.
currency2
A text parameter that can be omitted.
The destination currency: the currency to convert the amount to. If omitted then the System Base Currency is assumed.
date
A numeric parameter that can be omitted.
The exchange rates in effect on this date are used for the conversion. If omitted then the current User Date is used.

Returns

A numeric value. The converted amount, rounded to the nearest sub-unit of the destination currency.

Retrieved from "https://www.catalyst-uk-support.com/kb/index.php?title=EXCHANGE_-_Convert_a_value_between_two_currencies_(Reports_%26_Settings_Report_Generator_function)&oldid=26129"