Update a Currency
put
/primeapi/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
Supported Media Types
- application/json
Currency to be updated.
Root 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)
Response
Supported Media Types
- application/json
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.