Get Currency Availability
post
/config/sim/v1/setup/getcurrencyavailability
Gets all the currency availability.
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object
-
include:
string
Objects included in the response.Example:
hierUnitId
-
includeAll:
string
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
-
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX
-
limit:
integer
If using paging, number of results returned in this page.Example:
10
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0
-
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc
-
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Currency Availability objects.
Root Schema : CurrencyAvailabilityGetResponsev1
Type:
Show Source
object
-
count:
integer
Current response record count.Example:
1
-
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true
-
items:
array items
Array of Currency Availability objects of the organization.
-
limit:
integer
Server page sizeExample:
10
-
offset:
integer
Starting resource record indexExample:
0
-
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
array
Array of Currency Availability objects of the organization.
Show Source
-
Array of:
object CurrencyAvailabilityResponsev1
Model for Currency Availability Object
Nested Schema : CurrencyAvailabilityResponsev1
Type:
object
Model for Currency Availability Object
Show Source
-
currencyName:
object currencyName
Currency Name
-
currencyObjectNum:
integer
Object number of the currency.Example:
1
-
hierUnitId:
integer
Unique reference of the hierarchy unitExample:
3599
-
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
26
-
objectNum:
integer
Object number of the currency availability.Example:
1
-
options:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency availabilityExample:
11010101
-
optionsExt:
object CurrencyAvailabilityOptionsExt
An object containing the descriptive options list associated with the currency availability.
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
-
issueChangeInOtherCurrency:
boolean
Select to issue change in any other currencyExample:
false
-
promptForIssuingChange:
boolean
Select if change in other currency is neededExample:
false
-
roundCurrency:
boolean
Select to round value in currencyExample:
false
-
roundToNearestZero:
boolean
Select if value is to be rounded off to nearest zeroExample:
false
-
roundToSecondLeastSignificantDigit:
boolean
Select if value is to be rounded off to second least significant digitExample:
false