Currency

A currency exchange rate override [Currency] is a custom exchange rate against the base currency, which overrides the market exchange rate for your company's account.

Review the Usage Guidelines for the Currency object.

—	XML	SOAP	REST	Database table
Object	`Currency`	`oaCurrency`	—	`currency`
Supported Commands	`Add`, `Read`, `Modify`	`add()`, `read()`, `modify()`, `upsert()`	—	—

—

XML

SOAP

REST

Database table

Object

Currency

oaCurrency

—

currency

Supported Commands

Add, Read, Modify

add(), read(), modify(), upsert()

—

The Currency object has the following properties:

XML / SOAP	Database	Description
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`rate`	`rate`	The custom foreign exchange rate indicating how much of the counter currency (or quote currency) is needed to purchase one unit of the base currency.
`symbol`	`symbol`	[Required] The symbol for the counter currency (or quote currency). Must be the three-letter code for one of the standard currencies supported by SuiteProjects Pro.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.

XML / SOAP

Database

Description

created

[Read-only] Time the record was created. See Date Fields.

rate

The custom foreign exchange rate indicating how much of the counter currency (or quote currency) is needed to purchase one unit of the base currency.

symbol

[Required] The symbol for the counter currency (or quote currency). Must be the three-letter code for one of the standard currencies supported by SuiteProjects Pro.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

Usage Guidelines

Use the Currency object to set or read custom exchange rates. This is the equivalent of reading or setting custom exchange rates in Administration > Global Settings > Organization > Currencies > Set Exchange Rate when using the SuiteProjects Pro UI.

The exchange rates in the Currency object and in the currency table are quoted against the default currency for the account. The default currency for the company's SuiteProjects Pro account is defined by the base_currency property for the Company object.

Note:

There are three object types you can use in the XML API and SOAP API to interact with foreign currency exchange information:

Use the Currency object to set or read custom exchange rates. This is the equivalent of reading or setting custom exchange rates in Administration > Global Settings > Organization > Currencies > Set Exchange Rate when using the SuiteProjects Pro UI. The exchange rates in the Currency object and in the currency table are quoted against the default currency for the account. The default currency for the company's SuiteProjects Pro account is defined by the base_currency property for the Company object.
Use the Currencyrate to read current or historical exchange rates used for the account.
Use the ForexInput object to add or modify entries in the exchange cross rate table when the Multicurrency feature is enabled for your company's account. Make sure you review the Usage Guidelines for the ForexInput object. This is the equivalent of editing exchange cross rates using the Edit Exchange Cross Rates in the SuiteProjects Pro UI.