GlideCurrencyConverter- Scoped

The GlideCurrencyConverter API provides methods to convert one currency value to another, such as converting US dollars into European euros.

You can instantiate the GlideCurrencyConverter object and define the source and destination currencies during instantiation using GlideCurrencyConverter(from, to). You can also instantiate the object without these values and define them later using the setFromCurrency() and setToCurrency() methods. These values and the amount to convert must be set before calling the convert() method to perform the currency conversion. To set the amount to convert, use the setAmount() method.

The GlideCurrencyConverter API also provides optional methods that enable you to:

• Set the date and time for which to perform the conversion, setDateTime(). By setting the date and time, the rate that is used in the conversion calculation is that for the specified date and time, instead of the default of the current date and time.
• Set the rate table to use in the conversion, setRateTable(). By default the conversion uses the fx_system_rate table however, you can define custom rate tables for your instance. For additional information on creating rate tables, see Add conversion rates using a custom rate table.

This API is provided within the sn_currency namespace.

Parent Topic:Server API reference

GlideCurrencyConverter - GlideCurrencyConverter()

Instantiates a GlideCurrencyConverter object.

This example shows how to call the method.

var conv = new sn_currency.GlideCurrencyConverter();

GlideCurrencyConverter - GlideCurrencyConverter(String from, String to)

Instantiates a GlideCurrencyConverter object and sets the source and destination country codes to use in the currency conversion.

This example shows how to call the method.

var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');

GlideCurrencyConverter - convert()

Executes the currency converter.

Call this method after calling other GlideCurrencyConverter methods that construct the currency conversion, such as setAmount(), setRateTable(), and setDate().

CurrencyExchangeValue{
  fAmount: Number,
  fCurrency: "String",
  fOriginalAmount: Number,
  fOriginalCurrency: "String",
  fRate: Number,
  fRateSysId: "String"
}

This example shows how to call the method.

var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');
conv.setAmount(100);
gs.info(conv.convert());

Output:

CurrencyExchangeValue{fOriginalAmount=100, fOriginalCurrency='EUR', fRate=1.1604, fAmount=116.04, fCurrency='USD', fRateSysId='4555525f5553445f3230323530383036'}

GlideCurrencyConverter - setAmount(String amount)

Sets the amount of currency to convert.

This example shows how to call the method.

var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');
conv.setAmount(100);

GlideCurrencyConverter - setDateTime(Object date)

Sets the currency conversion date and time.

This date and time determines the conversion rate that is used to convert the currency. If this method is not called before the GlideCurrencyConverter.convert() method, the conversion is performed using the rate for the current date/time.

The following example shows how to call this method.

var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');
conv.setAmount(100);
var gd = new GlideDateTime("2019-01-03 11:00:00");
conv.setDateTime(gd);
gs.info(conv.convert());

Output:

CurrencyExchangeValue{fOriginalAmount=100, fOriginalCurrency='EUR', fRate=1.061, fAmount=106.1, fCurrency='USD', fRateSysId='4555525f5553445f3130303030313031'}

GlideCurrencyConverter - setFromCurrency(String from)

Sets the country code of the source currency.

This example shows how to call the method.

var conv = new sn_currency.GlideCurrencyConverter().setFromCurrency('FRA');

GlideCurrencyConverter - setRateTable(String rateTable)

Defines the rate table to use in the currency conversion.

If this method is not called before the GlideCurrencyConverter.convert() method is called, the conversion is performed using the fx_system_rate table. All custom rate tables must extend the fx_conversion_rate table. For additional information on creating rate tables, see Add conversion rates using a custom rate table.

This example shows how to call the method.

var conv = new sn_currency.GlideCurrencyConverter('EUR', 'USD');
conv.setRateTable(custom_rate_table);

GlideCurrencyConverter - setToCurrency(String to)

Sets the country code of the destination currency.

This example shows how to call the method.

var conv = new sn_currency.GlideCurrencyConverter().setToCurrency('USA');