Returns the currency specified by the currency code.
get
/primeapi/restapi/v16.2/currency/code/{code}
Request
Path Parameters
- code
-
Type:
string
Required:true
Code of the currency to be found.
Response
Supported Media Types
- application/json
200 Response
successful operation
Body
Root Schema : ApiEntityCurrency
Type:
object
- configuredByUser
-
Type:
boolean
Default Value:false
The username of the user who configured the currency. - currencyCode
-
Type:
string
Allowed Values:[ "Length[1-3]" ]
The unique identifier for the currency. The currency code is 3 characters. - currencyId
-
Type:
integer
(int64
)Required:true
- currencyName
-
Type:
string
Allowed Values:[ "Length[1-40]" ]
The name of the currency. - currencySymbol
-
Type:
string
Allowed Values:[ "Length[1-6]" ]
The symbol for the currency. - decimalsToDisplay
-
Type:
integer
(int32
)The number of decimals to display. - systemCurrencyFlag
-
Type:
boolean
Default Value:false
The base currency is the default currency when new workspaces are created. Any currency conversions will be measured against this form of currency. - workspaceId
-
Type:
integer
(int64
)
404 Response
The currency do not exist or you do not have access to it.