Megaventory API v2017a

<back to all web services

TaxUpdate

Inserts a tax or updates a current tax.Uses your API Key and applies a mvRecordAction value on an mvTax object. We can insert the mvTax object we specified using "Insert" as our mvRecordAction. We can update a current tax using "Update", we can insert it if it doesn't already exist, update it if it does using "InsertOrUpdate" and we can insert new fields or update non-empty fields of the tax using "InsertOrUpdateNonEmptyFields". Optionally, you can use mvInsertUpdateDeleteSourceApplication when an external application ( eg Magento ) is the one that triggers the TaxUpdate call. Only the TaxDescription field can be updated.

Examples:



A.

Updates a tax's description.

Value:

{
   "mvTax": {
      "TaxID": 3,
      "TaxName": "tea",
      "TaxDescription": "NEW DESCRIPTION",
      "TaxValue": 6.6
   },
   "mvRecordAction": "Update"
} 


Response:

{
   "mvTax": {
      "TaxID": 3,
      "TaxName": "tea",
      "TaxDescription": "NEW DESCRIPTION",
      "TaxValue": 6.6
   },
   "ResponseStatus": {
      "ErrorCode": "0"
   },
   "entityID": 3
}
 

B.



Insert a new tax to our list of taxes.

Value:

 {
   "mvTax": {
      "TaxName": "newsteepTAX",
      "TaxDescription": "Inserting a new steep tax",
      "TaxValue": 16.16
   },
   "mvRecordAction": "Insert",
   "mvInsertUpdateDeleteSourceApplication": "Magento"
} 


Response:

 {
   "mvTax": {
      "TaxID": 12,
      "TaxName": "newsteepTAX",
      "TaxDescription": "Inserting a new steep tax",
      "TaxValue": 16.16
   },
   "ResponseStatus": {
      "ErrorCode": "0"
   },
   "entityID": 12
} 

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

HTTP + SOAP12

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

POST /soap12 HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<TaxUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <APIKEY>String</APIKEY>
  <mvTax xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:TaxID>0</d2p1:TaxID>
    <d2p1:TaxName>String</d2p1:TaxName>
    <d2p1:TaxDescription>String</d2p1:TaxDescription>
    <d2p1:TaxValue>0.00</d2p1:TaxValue>
  </mvTax>
  <mvRecordAction>Insert</mvRecordAction>
  <mvInsertUpdateDeleteSourceApplication>String</mvInsertUpdateDeleteSourceApplication>
</TaxUpdate>

    </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>

<TaxUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvTax xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:TaxID>0</d2p1:TaxID>
    <d2p1:TaxName>String</d2p1:TaxName>
    <d2p1:TaxDescription>String</d2p1:TaxDescription>
    <d2p1:TaxValue>0.00</d2p1:TaxValue>
  </mvTax>
  <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>
  <entityID>0</entityID>
  <InternalErrorCode>String</InternalErrorCode>
</TaxUpdateResponse>

    </soap12:Body>
</soap12:Envelope>