Platform | Currency
Service to manage entities of type 'Currency'.
Overview
URL | api/{tenantKey}/{orgKey}/corePatterns/currencies |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set IsActive Currency
- PUT Set CurrencyKey Currency
- PUT Set Description Currency
- PUT Set CurrencyUnit Currency
- PUT Set CurrencySubUnit Currency
- PUT Set IsoCode Currency
- PUT Set Symbol Currency
- PUT Set ValidFrom Currency
- PUT Set ValidTo Currency
- PUT Set UseFixedRate Currency
- PUT Set ConversionFactor Currency
- PUT Set PricesFractionDigits Currency
- PUT Set ExternalId Currency
- PUT Set ExternalVersion Currency
- PUT Set IsExternallyManaged Currency
- PUT Set FixedRateReferenceCurrency Currency
- PUT Set Rate CurrencyRate
- PUT Set TargetCurrency CurrencyRate
- DELETE:
All Resources
This service uses the following resources:
GET Currencies (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See CurrencyResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Currency by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See CurrencyResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Currency by key
Returns the entity record that matches the specified key.
The following elements are required:
currencyKey | (string) The currency's logical key. |
Response:
When successful, the response body contains the entity record. See CurrencyResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST Currencies
Creates a new entity record.
The following elements are required:
currencyResource | (ApiCurrencyResource) The request body should contain the entity record that should be created. See ApiCurrencyResource. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiCurrencyResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Currency Rate
Inserts a new 'Currency Rate' in the 'Currency'.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (ApiCurrencyCurrencyRatesResource) The ApiCurrencyCurrencyRatesResource instance. See ApiCurrencyCurrencyRatesResource. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ConversionFactor Currency
Updates the value of attribute 'ConversionFactor' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CurrencyKey Currency
Updates the value of attribute 'CurrencyKey' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CurrencySubUnit Currency
Updates the value of attribute 'CurrencySubUnit' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CurrencyUnit Currency
Updates the value of attribute 'CurrencyUnit' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description Currency
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ExternalId Currency
Updates the value of attribute 'ExternalId' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ExternalVersion Currency
Updates the value of attribute 'ExternalVersion' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set FixedRateReferenceCurrency Currency
Updates the value of attribute 'FixedRateReferenceCurrency' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive Currency
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set IsExternallyManaged Currency
Updates the value of attribute 'IsExternallyManaged' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsoCode Currency
Updates the value of attribute 'IsoCode' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set PricesFractionDigits Currency
Updates the value of attribute 'PricesFractionDigits' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Rate CurrencyRate
Updates the value of attribute 'Rate' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
lineId | (string) The detail identifier. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Symbol Currency
Updates the value of attribute 'Symbol' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set TargetCurrency CurrencyRate
Updates the value of attribute 'TargetCurrency' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
lineId | (string) The detail identifier. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UseFixedRate Currency
Updates the value of attribute 'UseFixedRate' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ValidFrom Currency
Updates the value of attribute 'ValidFrom' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (DateTime) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ValidTo Currency
Updates the value of attribute 'ValidTo' in the specified entity record.
The following elements are required:
currencyKey | (string) The currency's logical key. |
value | (DateTime) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
DELETE Currency Rate by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
currencyKey | (string) The currency's logical key. |
lineId | (string) The line identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Currency by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Currency by key
Deletes the entity record that matches the specified key.
The following elements are required:
currencyKey | (string) The currency's logical key. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiCurrencyCurrencyRatesResource
The following elements are required:
targetCurrency | (string) The Target Currency. |
The following elements are optional:
rate | (decimal) The Rate. |
ApiCurrencyResource
The following elements are required:
currencyKey | (string) The currency's logical key. |
description | (string) The description for the currency. |
fractionDigits | (int) The number of digits used to represent fraction values. |
currencyUnit | (string) The currency main unit (e.g. Euro). |
isoCode | (string) The ISO standard currency code. |
symbol | (string) The symbol used to represent values in the currency (e.g. $). |
isExternallyManaged | (bool) A flag indicating if the currency is externally managed. |
The following elements are optional:
currencySubUnit | (string) The currency sub unit (e.g. Cent). |
validFrom | (DateTime) The start date for validity period. |
validTo | (DateTime) The end date for validity period. |
useFixedRate | (bool) Use Fixed Rate. |
conversionFactor | (decimal) The Conversion Factor. |
pricesFractionDigits | (int) The explicit number of digits used to represent fraction values in Prices. |
externalId | (string) The external identifier. |
externalVersion | (string) The external version. |
fixedRateReferenceCurrency | (string) The Fixed Rate Reference Currency. |
currencyRates | (List of ApiCurrencyCurrencyRatesResource) The Currency Rates.
See ApiCurrencyCurrencyRatesResource. |
CurrencyResource
The following elements are required:
currencyKey | (string) The currency's logical key. |
description | (string) The description for the currency. |
fractionDigits | (int) The number of digits used to represent fraction values. |
currencyUnit | (string) The currency main unit (e.g. Euro). |
isoCode | (string) The ISO standard currency code. |
symbol | (string) The symbol used to represent values in the currency (e.g. $). |
isExternallyManaged | (bool) A flag indicating if the currency is externally managed. |
The following elements are optional:
currencySubUnit | (string) The currency sub unit (e.g. Cent). |
validFrom | (DateTime) The start date for validity period. |
validTo | (DateTime) The end date for validity period. |
useFixedRate | (bool) Use Fixed Rate. |
conversionFactor | (decimal) The Conversion Factor. |
pricesFractionDigits | (int) The explicit number of digits used to represent fraction values in Prices. |
externalId | (string) The external identifier. |
externalVersion | (string) The external version. |
fixedRateReferenceCurrency | (string) The Fixed Rate Reference Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
currencyRates | (List of CurrencyRateResource) The Currency Rates.
See CurrencyRateResource. |