ForexInput

A forex input [ForexInput] is a company override value for historical (dated, past or future) foreign currency exchange rates between currencies enabled as a business transaction currency or user-defined reporting currency when the Multicurrency feature is enabled for the OpenAir account.

For more information about the Multicurrency feature, see Multicurrency.

Review the Usage Guidelines for the ForexInput object.

—	XML	SOAP	REST	Database table
Object	`ForexInput`	`oaForexInput`	—	`forex`
Supported Commands	`Add`, `Read`, `Modify`	`add()`, `read()`, `modify()`, `upsert()`	—	—

—

XML

SOAP

REST

Database table

Object

ForexInput

oaForexInput

—

forex

Supported Commands

Add, Read, Modify

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

—

The ForexInput object has the following properties:

XML / SOAP	Database	Description
`base`	`symbol`	The symbol for the base currency used for the foreign exchange rate. Must be one of the user-defined reporting currencies defined for the OpenAir account. Defaults to the default currency for the company's OpenAir account if not set when adding or modifying an object.
`created`	`created`	[Read-only] Date the record was created. See Date Fields.
`enddate`	Last in a range of `forex_date` values	The last in the date range when the foreign exchange rate applies. See Date Fields. Must be empty if `past` or `future` is set.
`future`	Determines the value for `jkey`: `FUTURE<symbol>` where `<symbol>` is the uppercase symbol for the base currency.	Set to `1` if the conversion rate is for dates after the last date in the exchange cross rate table. If used, `startdate` and `enddate` must be empty.
`past`	Determines the value for `jkey`: `PAST<symbol>` where `<symbol>` is the uppercase symbol for the base currency.	Set to `1` if the conversion rate is for dates prior to the first date in the exchange cross rate table. If used, `startdate` and `enddate` must be empty.
`rate`	`custom_<currency_symbol>` where `<currency_symbol>` is the lowercase symbol for the counter currency.	The foreign exchange rate indicating how much of the counter currency (or quote currency) is needed to purchase one unit of the base currency.
`startdate`	First in a range of `forex_date` values	The first in the date range when the foreign exchange rate applies. See Date Fields. Must be empty if `past` or `future` is set.
`symbol`	Determines the name of the custom field `custom_<currency_symbol>` where `<currency_symbol>` is the lowercase symbol for the counter currency.	The symbol for the counter currency (or quote currency). Must be for one of the currencies enabled as a business transaction currency or one of the user-defined reporting currencies for the OpenAir account.
`updated`	`updated`	[Read-only] Date the record was last modified. See Date Fields.

XML / SOAP

Database

Description

base

symbol

The symbol for the base currency used for the foreign exchange rate.

Must be one of the user-defined reporting currencies defined for the OpenAir account.

Defaults to the default currency for the company's OpenAir account if not set when adding or modifying an object.

created

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

enddate

Last in a range of forex_date values

The last in the date range when the foreign exchange rate applies. See Date Fields.

Must be empty if past or future is set.

future

Determines the value for jkey: FUTURE<symbol> where <symbol> is the uppercase symbol for the base currency.

Set to 1 if the conversion rate is for dates after the last date in the exchange cross rate table. If used, startdate and enddate must be empty.

past

Determines the value for jkey: PAST<symbol> where <symbol> is the uppercase symbol for the base currency.

Set to 1 if the conversion rate is for dates prior to the first date in the exchange cross rate table. If used, startdate and enddate must be empty.

rate

custom_<currency_symbol> where <currency_symbol> is the lowercase symbol for the counter currency.

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

startdate

First in a range of forex_date values

The first in the date range when the foreign exchange rate applies. See Date Fields.

Must be empty if past or future is set.

symbol

Determines the name of the custom field custom_<currency_symbol> where <currency_symbol> is the lowercase symbol for the counter currency.

The symbol for the counter currency (or quote currency). Must be for one of the currencies enabled as a business transaction currency or one of the user-defined reporting currencies for the OpenAir account.

updated

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

Usage Guidelines

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. This is the equivalent of editing exchange cross rates using the Edit Exchange Cross Rates in the OpenAir UI.

The base currency must be one of the user-defined reporting currencies, if set. It is not possible to set historical foreign currency exchange rates with a base currency is set to any other currency – the API returns error code 837 with the following error message: "Invalid base currency specified. It must be one of user-defined currencies.". For more information about user-defined reporting currencies, see User-Defined Reporting Currencies.

You can set historical foreign exchange rates against the default currency for your company's OpenAir account as base currency. To do so, leave the base property value empty.
symbol must be the symbol for one of the currencies your company uses for business transactions as defined in Administration > Global Settings > Organization > Currencies > Multi-currency, or one of the user-defined reporting currencies.
startdate and enddate, if set, must be within 10 years from the current date at the time of the operation. The date range defined by startdate and enddate must not span longer than 10 years.

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 OpenAir 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 OpenAir 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 OpenAir UI.