Get Currency Parameters
post
/config/sim/v2/setup/getCurrencyParameters
Gets all the currency parameters.
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
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Currency Parameters
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Currency Parameter 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:
arrayArray of Currency Parameter objects of the organization.
Show Source
-
Array of:
object CurrencyParameterv2
Model for Currency Parameter Object
Nested Schema : CurrencyParameterv2
Type:
objectModel for Currency Parameter Object
Show Source
-
baseCurrObjNum:
integer
Object number of the currency.Example:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unit where the Currency Parameter is configuredExample:
3599 -
hierUnitObjNum:
integer
Object number of the hierarchy unit where the Currency Parameter is configuredExample:
26 -
options:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency parameterExample:
11010101 -
optionsExt:
object CurrencyParameterOptionsExt
An object containing the descriptive options list associated with the currency parameter.
Nested Schema : CurrencyParameterOptionsExt
Type:
objectAn object containing the descriptive options list associated with the currency parameter.
Example:
{
"roundCurrency":false,
"roundToNearestZero":false,
"roundToSecondLeastSignDigit":false
}