Get currency conversions.
post
/config/sim/v1/setup/getcurrencyconversion
Gets all the currency conversions for the specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : CurrencyConversionGetRequestBody
Type:
objectThe input Body model that needs to be given for get request.
Show Source
-
include:
string
Example:
locations -
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.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
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 valueExample:
where equals(active,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Currency Conversion objects of the organization
Root Schema : CurrencyConversionGetResponse
Type:
objectModel for Currency Conversion Object
Show Source
-
conversionCurrencyName(required):
object CurrencyNameTranslatedString
A group of string objects representing the name of the currency in configured languages.
-
conversionCurrencyObjectNum(required):
integer
Object number of the conversion currency.Example:
31 -
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:
31 -
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 -
objectNum(required):
integer
Object number of the currency conversion.Example:
1 -
rate(required):
number
Rate of conversion between currency and conversion currencyExample:
1.3
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 : HierUnitNameTranslatedString
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}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