Deletes a current currency | Uses your API Key and the ID of the currency you want to delete (CurrencyIDToDelete) and deletes the
specified currency if it exists.
Cannot delete default currency.
A. Delete a currency.
To begin with, we use CurrencyGet to see all of our existing currencies as shown below:
Value: {}
Response: {
"mvCurrencies": [
{
"CurrencyId": 22,
"CurrencyCode": "DZD",
"CurrencyDescription": "Algerian Dinar (DZD)",
"CurrencySymbol": "din",
"CurrencyIsDefault": false,
"CurrencyInReports": false
},
{
"CurrencyId": 21,
"CurrencyCode": "EUR",
"CurrencyDescription": "Euro (EUR)",
"CurrencySymbol": "EUR",
"CurrencyIsDefault": false,
"CurrencyInReports": true
},
{
"CurrencyId": 20,
"CurrencyCode": "USD",
"CurrencyDescription": "US Dollar (USD)",
"CurrencySymbol": "USD",
"CurrencyIsDefault": true,
"CurrencyInReports": true
}
],
"ResponseStatus": {
"ErrorCode": "0"
}
}
Then we decide to remove the Algerian Dinar from our list of currencies.
Value: {
"CurrencyIDToDelete": 22
}
Response: {
"result": true,
"ResponseStatus": {
"ErrorCode": "0"
}
}
B. Trying to delete our default currency.
Value: {
"CurrencyIDToDelete": 20
}
Response: {
"result": false,
"ResponseStatus": {
"ErrorCode": "500",
"Message": "The Currency with Code [USD] is the primary currency. Delete action failed"
},
"InternalErrorCode": "CurrencyPrimaryCannotDelete"
}
|