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 .xml suffix or ?format=xml

HTTP + XML

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

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

<CurrencyDelete xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <APIKEY>String</APIKEY>
  <CurrencyIDToDelete>0</CurrencyIDToDelete>
  <mvInsertUpdateDeleteSourceApplication>String</mvInsertUpdateDeleteSourceApplication>
</CurrencyDelete>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CurrencyDeleteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <result>false</result>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <InternalErrorCode>String</InternalErrorCode>
</CurrencyDeleteResponse>