View a Currency by Code
get
/primeapi/restapi/currency/code/{code}
This endpoint returns currencies that meet the following requirements:
- The object has a code that matches the value of the {code} path parameter.
Request
Path Parameters
-
code: string
The user-specified identifier of a currency.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityCurrency
Type:
Show Source
object
-
configuredByUser(optional):
boolean
The username of the user who configured the currency.
-
currencyCode(optional):
string
Allowed Values:
[ "Length[1-3]" ]
The unique identifier for the currency. The currency code is 3 characters. -
currencyId:
integer(int64)
-
currencyName(optional):
string
Allowed Values:
[ "Length[1-40]" ]
The name of the currency. -
currencySymbol(optional):
string
Allowed Values:
[ "Length[1-6]" ]
The symbol for the currency. -
decimalsToDisplay(optional):
integer(int32)
The number of decimals to display.
-
link(optional):
string(url)
Read Only:
true
-
pushDownType(optional):
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace currency. -
systemCurrencyFlag(optional):
boolean
The base currency is the default currency when new workspaces are created.
Any currency conversions will be measured against this form of currency. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId(optional):
integer(int64)
204 Response
Successful operation with no content.
404 Response
The requested currency does not exist, or you do not have access to it.