Get Currencies
post
/config/sim/v1/setup/getCurrencies
Gets all the currencies
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : GetRequestBody
Type:
objectThe input Body model that needs to be given for get request.
Show Source
-
include:
string
Objects included in response
-
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 translated strings returned
-
limit:
integer
If using paging, number of results returned in this page.
-
offset:
integer
Starting resource record index. Not required if paging parameters are not supported
-
orderBy:
integer
Sorts the response by the specified field name and sort order.
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of Currency objects of the organization
Root Schema : CurrencyGetResponse
Type:
objectModel for Currency Object
Show Source
-
abbreviation(required):
object abbreviation
The abbreviation for the currency record. For a long abbreviation, you may add a space in the end for good print format.
-
hierUnitId(required):
integer
Unique reference of the hierarchy unit where the print class is configuredExample:
3599 -
hierUnitName(required):
object HierUnitNameTranslatedString
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unit where the print class is configuredExample:
26 -
name(required):
object CurrencyNameTranslatedString
A group of string objects representing the name of the currency in configured languages.
-
numberOfDigits(required):
integer
The number of digits after the decimal point that each currency allows. Default value is 2.Values between 1-3.Example:
2 -
objectNum(required):
integer
Object number of the currency.Example:
1 -
options(required):
string
A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the Print ClassExample:
11010101 -
optionsExt(required):
object OptionsExt
An object containing the descriptive options list associated with the currency.
-
symbol(required):
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 : HierUnitNameTranslatedString
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : CurrencyNameTranslatedString
Type:
objectA group of string objects representing the name of the currency in configured languages.
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
}400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html