Get Currency Availability
post
/config/sim/v1/setup/getcurrencyavailability
Gets all the currency availability.
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : GetCurrencyAvailabilityRequest
Type:
object
The 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.Example:
objectNum:asc
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of Currency Availability objects of the organization
Root Schema : CurrencyAvailabilityGetResponse
Type:
object
Model for Currency Availability Object
Show Source
-
currencyName(required):
object CurrencyNameTranslatedString
A group of string objects representing the name of the currency in configured languages.
-
currencyObjectNum(required):
integer
Object number of the currency.Example:
1
-
hierUnitId(required):
integer
Unique reference of the hierarchy unitExample:
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 unitExample:
26
-
objectNum(required):
integer
Object number of the currency availability.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 currency availabilityExample:
11010101
-
optionsExt(required):
object CurrencyAvailabilityOptionsExt
An object containing the descriptive options list associated with the currency availability.
Nested Schema : CurrencyNameTranslatedString
Type:
object
A group of string objects representing the name of the currency in configured languages.
Example:
{
"en-US":"USD Dollar",
"de-DE":"USD-Dollar"
}
Nested Schema : HierUnitNameTranslatedString
Type:
object
A string that contains translations of hierarchy unit name into multiple languages
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
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
object
Response 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