Update a Currency
put
/api/restapi/currency
Send a request to this endpoint to update a currency. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityCurrencyInput
Type:
object
Title:
ApiEntityCurrencyInput
This entity represents a Currency object, a unique Currency object can be identified by the following combinations of the fields.
Show Source
- currencyId
- currencyCode,workspaceId
- currencyCode,workspaceCode
-
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 24.4.The type of association in the relationship between the currency and the workspace. Possible values are Owned and Inherited. -
currencyCode(required): 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(required): string
Minimum Length:
1
Maximum Length:255
The name of the currency. -
currencySymbol(required): string
Minimum Length:
1
Maximum Length:6
The symbol for the currency. -
decimalsToDisplay(required): integer
(int32)
Minimum Value:
0
Maximum Value:5
Multiple Of:0.000010
The number of decimals to display. -
link: string(url)Read Only:true
Deprecated. As of 23.10.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)Read Only:true
Deprecated. As of 24.4.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Examples
Back to Top
Response
204 Response
Successful operation with no content.
400 Response
Invalid input for the Currency service. Verify the request contains valid data, then resubmit the request.