View a Currency by Code
get
/api/restapi/currency/code/{currencyCode}
This endpoint returns currencies that meet the following requirements:
- The object has a code that matches the value of the {currencyCode} path parameter.
Request
Path Parameters
-
currencyCode(required): string
The user-specified identifier of a currency.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityCurrency>
Type:
array
Title:
Show Source
List<ApiEntityCurrency>
-
Array of:
object ApiEntityCurrency
Title:
ApiEntityCurrency
Nested Schema : ApiEntityCurrency
Type:
object
Title:
Show Source
ApiEntityCurrency
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the currency and the workspace. Possible values are Owned and Inherited. -
currencyCode: string
Minimum Length:
1
Maximum Length:3
The unique identifier for the currency. The currency code is 3 characters. -
currencyId: integer
(int64)
The unique identifier of a currency.
-
currencyName: string
Minimum Length:
1
Maximum Length:255
The name of the currency. -
currencySymbol: string
Minimum Length:
1
Maximum Length:6
The symbol for the currency. -
decimalsToDisplay: integer
(int32)
Minimum Value:
0
Maximum Value:5
Multiple Of:0.000010
The number of decimals to display. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace currency. -
systemCurrencyFlag: 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: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
204 Response
Successful operation with no content.
404 Response
The requested currency does not exist, or you do not have access to it.