Megaventory API v2017a

<back to all web services

CurrencyDelete

The following routes are available for this service:
POST/Currency/CurrencyDeleteDeletes a current currencyUses 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.

Examples:



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"
}

To override the Content-type in your clients HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/CurrencyDelete HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/csv
Content-Length: length

APIKEY,CurrencyIDToDelete,mvInsertUpdateDeleteSourceApplication
String,0,String

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

result,ResponseStatus,InternalErrorCode
False,"{ErrorCode:String,Message:String,StackTrace:String,Errors:[{ErrorCode:String,FieldName:String,Message:String}]}",String