workbook.createCurrency(options)

Method Description

Creates a currency.

Returns

workbook.Currency

Supported Script Types

Server scripts

Governance

None

Module

N/workbook Module

Sibling Module Members

N/workbook Module Members

Since

2021.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
`options.amount`	number	required	The amount of the currency.
`options.id`	string	required	The ID of the currency (for example, USD, EUR, GBP, and so on).

Parameter

Type

Required / Optional

Description

options.amount

number

required

The amount of the currency.

options.id

string

required

The ID of the currency (for example, USD, EUR, GBP, and so on).

Error Code	Thrown If
INVALID_CURRENCY	The provided options.id is not valid.

Error Code

Thrown If

INVALID_CURRENCY

The provided options.id is not valid.

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/workbook Module Script Samples. Also see Full scripts in the Tutorial: Creating a Workbook Using the Workbook API topic.

            // Add additional code
...
var myCurrency = workbook.createCurrency({
    amount: 1,
    id: "USD"
});
...
// Add additional code