Get Currency Availability

post

/config/sim/v1/setup/getcurrencyavailability

Gets all the currency availability.

Request

Supported Media Types
Body ()
The input Body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • Objects included in the response.
    Example: hierUnitId
  • This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.
    Example: detailed
  • If specified, limits the translated strings returned.
    Example: en-US, es-ES, es-MX
  • If using paging, number of results returned in this page.
    Example: 10
  • Starting resource record index. Not required if paging parameters are not supported.
    Example: 0
  • Sorts the response by the specified field name and sort order.
    Example: objectNum:asc
  • Search criteria to filter results based on field value.
    Example: where equals(objectNum,1)
Back to Top

Response

Supported Media Types

200 Response

A collection of Currency Availability objects.
Body ()
Root Schema : CurrencyAvailabilityGetResponsev1
Type: object
Show Source
Nested Schema : items
Type: array
Array of Currency Availability objects of the organization.
Show Source
Nested Schema : CurrencyAvailabilityResponsev1
Type: object
Model for Currency Availability Object
Show Source
Nested Schema : currencyName
Type: object
Currency Name
Example:
{
    "en-US":"USD Dollar",
    "de-DE":"USD-Dollar"
}
Nested Schema : hierUnitName
Type: object
Hier Unit Name
Example:
{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "es-MX":"Propiedad"
}
Nested Schema : CurrencyAvailabilityOptionsExt
Type: object
An object containing the descriptive options list associated with the currency availability.
Show Source
Back to Top