exportActiveCurrencies
This API only supports user Concept: Access Rules in API v22 and above.
Category | Metadata retrieval |
Description | Returns metadata for the complete list of all currencies which have been configured in the system. |
Permissions Required To Invoke | None (must be valid credentials for the instance) |
Parameters Required On Request | Credentials |
This method's request contains only a credentials tag to identify and authorize the calling user. Once verified, the method returns an XML document describing the complete set of all currencies which have been configured in the system. A currency has been "configured" once it has been added to the currency list in Currency Administration, even if it does not yet have an exchange rate. Instances which do not have the Multiple Currencies feature enabled return only a single currency in this list.
Request Format
<?xml version='1.0' encoding='UTF-8'?> <call method="exportActiveCurrencies" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd"/> </call>
credentials element | |||
Tag Name | credentials | ||
Description | All API calls must contain a single credentials element to identify the user invoking the API. The API call is then performed as this user (any audit trail or history of actions in the system will show that this user performed the action), and therefore the user must have the required permissions to perform the action in order for the API call to succeed. | ||
Attributes of the Element | |||
Attribute Name | Required ? | Value | Example |
login | Y | The login name of the user invoking the API method. This user must have the required permissions to invoke the method. | sampleuser@company.com |
password | Y | The password of the user invoking the API method. | my_password |
locale | N | Specify the locale to be used to interpret incoming numbers and dates, and to format outgoing numbers and dates (using the proper thousands separator, month names, and date formatting). The locale is also used to specify the language in which any system messages in the response should appear. If not specified, en_US (American English) is used. | fr_FR |
instanceCode | N | If the user specified in the credentials has access to more than one instance of Adaptive Planning , this attribute can be used to specify that the user is intending to access an instance other than their default instance. If not specified, the user's default instance will be used. To determine the available instance codes, use the exportInstances API. | MYINSTANCE1 |
Contents of the Element | |||
(none) | |||
Response Format
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <currencies seqNo="42"> <currency id="2" code="EUR" precision="4" isReportingCurrency="0" userDefined="0" description="Euro Member Countries, Euro" /> <currency id="3" code="EUR1" precision="4" isReportingCurrency="0" userDefined="1" description="User-defined Euro 1" /> <currency id="1" code="USD" precision="2" isReportingCurrency="1" userDefined="0" description="United States of America, Dollars" /> </currencies> </output> </response>
response element | |||
Tag Name | response | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
success | Y | Either true or false, indicating whether the API call was successful or not. Even successful calls may contain warning messages in their response. | true |
obsolete | N | If present on the response tag and set to true, this attribute indicates that the version of the method or API which is being invoked has become obsolete and is officially deprecated. While it continues to function at this time, it may cease functioning in a short while. Typically, this attribute is not present. | false |
Contents of the Element | |||
A single optional messages element, and exactly one required output element. | |||
output element | |
Tag Name | output |
Attributes of the Element | |
(none) | |
Contents of the Element | |
A single required currencies element. This output wrapper is standard on all API responses and encloses the valid output of any successful API call. | |
currencies element | |||
Tag Name | currencies | ||
Description | Container for one or more currency elements. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
seqNo Added in API v17 but reserved for future use. | |||
Contents of the Element | |||
One or more currency elements. | |||
currency element | |||
Tag Name | currency | ||
Description | Represents a single currency being returned in the response to an exportActiveCurrencies API call. For versions previous to API v17, it will not show the user Defined attribute, or the user defined currencies. | ||
Attributes of the Element | |||
Attribute Name | Required? | Value | Example |
id | Y | The internal system ID number for the currency. This number can be used to uniquely identify the currency, but is not used in any other API calls. | 1 |
code | Y | The three-letter code for the currency, as specified in the ISO 4217 standard. | usd |
precision | Y | The typical decimal precision (number of digits after the decimal place) to be used when displaying amounts in this currency. This precision is only used for accounts which have a display type of Currency and have their decimal precision set to "Use currency's precision." | 2 |
isReportingCurrency | Y | Whether the currency was selected by an admin as available for use in "arbitrary report conversions". True=1, False=0. | 1 |
userDefined Available in API v17+ | Y | Whether the currency was created by the user or not. True=1, False=0. | 0 |
description | Y | Basic description of the currency, consisting of the currency's country and its name. | United States of America, Dollars |
Contents of the Element | |||
(none) | |||