Get Currencies
post
/config/sim/v1/setup/getCurrencies
Gets all the currencies
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 Currencies.
Root Schema : Currencyv1GetResponse
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 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 objects of the organization.
Show Source
-
Array of:
object Currencyv1
Model for Currency Object
Nested Schema : Currencyv1
Type:
objectModel for Currency Object
Show Source
-
abbreviation:
object abbreviation
The abbreviation for the currency record. For a long abbreviation, you may add a space in the end for good print format.
-
dataExtensions:
array dataExtensions
An array of data extensions
-
hierUnitId:
integer
Unique reference of the hierarchy unit where the Currency is configuredExample:
3599 -
hierUnitName:
object hierUnitName
Hier Unit Name
-
hierUnitObjNum:
integer
Object number of the hierarchy unit where the Currency is configuredExample:
26 -
name:
object name
Name
-
numberOfDigits:
integer
The number of digits after the decimal point that each currency allows. Default value is 2.Values between 1-3.Example:
2 -
objectNum:
integer
Object number of the currency.Example:
1 -
options:
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currencyExample:
11010101 -
optionsExt:
object OptionsExt
An object containing the descriptive options list associated with the currency.
-
symbol:
string
The record symbol of the currency.Example:
$
Nested Schema : abbreviation
Type:
objectThe abbreviation for the currency record. For a long abbreviation, you may add a space in the end for good print format.
Example:
{
"en-US":"USD"
}Nested Schema : hierUnitName
Type:
objectHier Unit Name
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : name
Type:
objectName
Example:
{
"en-US":"USD Dollar",
"de-DE":"USD-Dollar"
}Nested Schema : OptionsExt
Type:
objectAn object containing the descriptive options list associated with the currency.
Example:
{
"printSymbolAfterTotal":false,
"useThousandsSeparator":false
}Nested Schema : items
Type:
Show Source
object-
columnName:
string
Name of the extension fieldExample:
extension column 1 -
value:
string
Value of the extension fieldExample:
Value1