1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. List of Values
  4. Preferred Currencies List of Values

Get all currencies

get

/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • GetActiveCurrenciesFinder: Finds the currency that matches the specified criteria of the currency, enabled indicator, and end date.
      Finder Variables:
      • BindCurrencyEnabledFlag; string; The indicator for whether the currency is enabled for use.
      • BindEndDate; string; The end date of the currency.
      • BindStartDate; string.
      • SearchTerm; string; A keyword that can be applied on the finder to facilitate server-side filtering.
    • GetCurrenciesByLedgerSetFinder: Finds the currencies of all ledgers in the specified ledger set.
      Finder Variables:
      • BindLedgerSetId; integer; The unique identifier of the ledger set.
      • SearchTerm; string; A keyword that can be applied to find the currencies.
    • KeywordFinder: Finds values when more than 500 rows are returned by applying server-side filtering using the specified search term.
      Finder Variables:
      • SearchTerm; string; A keyword that can be applied on the finder to facilitate server-side filtering.
    • PrimaryKey: Finds the currency that matches the specified primary key criteria.
      Finder Variables:
      • CurrencyCode; string; The three-letter code associated with the currency as established by the International Standards Organization.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CurrencyCode; string; The three-letter code associated with the currency as established by the International Standards Organization.
    • CurrencyFlag; boolean; The indicator for whether the currency is a statistical unit.
    • CurrencyFormat; string; The currency representation format for the currency code.
    • CurrencyFormatWithCode; string; The currency format code representation for the currency name.
    • CurrencyFormatWithSymbol; string; The currency format symbol representation for the currency name.
    • CurrencyName; string; The name of the currency associated with the row.
    • DisplaySequence; integer; The sequence in which the currency details are ordered and displayed.
    • EnabledFlag; boolean; The indicator for whether the currency is enabled for use. Valid values are YES and NO.
    • EndDateActive; string; The date when the preferred currency is no longer active.
    • ExtendedPrecision; integer; The number of digits placed after the decimal point that must be greater than or equal to the precision value. Used for calculations requiring greater precision.
    • IssuingTerritoryCode; string; A unique two-letter code that identifies the territory of the preferred currency.
    • LedgerSetId; integer; The unique identifier of the ledger set.
    • MinimumAccountableUnit; number; The smallest denomination for the currency.
    • Name; string; The name of the currency associated with the currency format or currency symbol.
    • Precision; integer; The number of digits to the right of the decimal point used in regular currency transactions.
    • StartDateActive; string; The date when the preferred currency becomes active.
    • Symbol; string; A graphic representation used as a shorthand for the name of a currency.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : preferredCurrenciesLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : preferredCurrenciesLOV-item-response
Type: object
Show Source
  • Title: Currency Code
    Read Only: true
    Maximum Length: 15
    The three-letter code associated with the currency as established by the International Standards Organization.
  • Title: Currency Flag
    Read Only: true
    Maximum Length: 1
    The indicator for whether the currency is a statistical unit.
  • Read Only: true
    Maximum Length: 255
    The currency representation format for the currency code.
  • Read Only: true
    Maximum Length: 255
    The currency format code representation for the currency name.
  • Read Only: true
    Maximum Length: 255
    The currency format symbol representation for the currency name.
  • Title: Currency Name
    Read Only: true
    Maximum Length: 80
    The name of the currency associated with the row.
  • Read Only: true
    The sequence in which the currency details are ordered and displayed.
  • Title: Enabled
    Read Only: true
    Maximum Length: 1
    The indicator for whether the currency is enabled for use. Valid values are YES and NO.
  • Read Only: true
    The date when the preferred currency is no longer active.
  • Title: Extended Precision
    Read Only: true
    The number of digits placed after the decimal point that must be greater than or equal to the precision value. Used for calculations requiring greater precision.
  • Title: Issuing Territory
    Read Only: true
    Maximum Length: 2
    A unique two-letter code that identifies the territory of the preferred currency.
  • The unique identifier of the ledger set.
  • Links
  • Title: Minimum Accountable Unit
    Read Only: true
    The smallest denomination for the currency.
  • Title: Currency Name
    Read Only: true
    Maximum Length: 80
    The name of the currency associated with the currency format or currency symbol.
  • Title: Precision
    Read Only: true
    The number of digits to the right of the decimal point used in regular currency transactions.
  • Read Only: true
    The date when the preferred currency becomes active.
  • Title: Symbol
    Read Only: true
    Maximum Length: 12
    A graphic representation used as a shorthand for the name of a currency.
Back to Top

Examples

The following example shows how to retrieve all the currencies by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "CurrencyCode": "USD",
            "CurrencyName": "US Dollar",
            "CurrencyFlag": true,
            "EnabledFlag": true,
            "DisplaySequence": 1,
            "Precision": 2,
            "MinimumAccountableUnit": null,
            "Symbol": "$",
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV/USD",
                    "name": "preferredCurrenciesLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV/USD",
                    "name": "preferredCurrenciesLOV",
                    "kind": "item"
                }
            ]
        },
        {
            "CurrencyCode": "EUR",
            "CurrencyName": "Euro",
            "CurrencyFlag": true,
            "EnabledFlag": true,
            "DisplaySequence": 2,
            "Precision": 2,
            "MinimumAccountableUnit": null,
            "Symbol": "???",
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV/EUR",
                    "name": "preferredCurrenciesLOV",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV/EUR",
                    "name": "preferredCurrenciesLOV",
                    "kind": "item"
                }
            ]
        },
        ...
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV",
            "name": "preferredCurrenciesLOV",
            "kind": "collection"
        }
    ]
}
Back to Top