Megaventory API v2017a

<back to all web services

CurrencyUpdate

Inserts a currency or updates a current currency.Uses your API Key and applies a mvRecordAction value on an mvCurrency object. We can insert the mvCurrency object we specified using "Insert" as our mvRecordAction. We can update a current currency using "Update". We can insert a currency 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 currency using "InsertOrUpdateNonEmptyFields". Optionally, you can use mvInsertUpdateDeleteSourceApplication when an external application ( eg Magento ) is the one that triggers the CurrencyUpdate call. CurrencyId cannot be updated. There is only one currency that is default. There cannot be a case where a default currency does not exist.

Examples:



A.

Inserts a Non-Default Currency and enables it to appear on reports.

Value:

{
   "mvCurrency": {
      "CurrencyCode": "UGS",
      "CurrencyDescription": "Uganda Shilling (UGS) ",
      "CurrencySymbol": "UGS",
      "CurrencyIsDefault": false,
      "CurrencyInReports": true
   },
   "mvRecordAction": "Insert"
}


Response:

{
   "mvCurrency": {
      "CurrencyId": 23,
      "CurrencyCode": "UGS",
      "CurrencyDescription": "Uganda Shilling (UGS) ",
      "CurrencySymbol": "UGS",
      "CurrencyIsDefault": false,
      "CurrencyInReports": true
   },
   "ResponseStatus": {
      "ErrorCode": "0"
   },
   "entityID": 23
}

B.



Update the Currency you just added to not appear in reports.

Value:

{
   "mvCurrency": {
      "CurrencyDescription": "Uganda Shilling (UGS) - new description",
      "CurrencyCode": "UGS",
      "CurrencySymbol": "UGS",
      "CurrencyIsDefault": false,
      "CurrencyInReports": false
   },
   "mvRecordAction": "Update"
}


Response:

{
   "mvCurrency": {
      "CurrencyId": 23,
      "CurrencyCode": "UGS",
      "CurrencyDescription": "Uganda Shilling (UGS) - new description",
      "CurrencySymbol": "UGS",
      "CurrencyIsDefault": false,
      "CurrencyInReports": false
   },
   "ResponseStatus": {
      "ErrorCode": "0"
   },
   "entityID": 23
}

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>

<CurrencyUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <APIKEY>String</APIKEY>
  <mvCurrency xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:CurrencyId>0</d2p1:CurrencyId>
    <d2p1:CurrencyCode>String</d2p1:CurrencyCode>
    <d2p1:CurrencyDescription>String</d2p1:CurrencyDescription>
    <d2p1:CurrencySymbol>String</d2p1:CurrencySymbol>
    <d2p1:CurrencyIsDefault>false</d2p1:CurrencyIsDefault>
    <d2p1:CurrencyInReports>false</d2p1:CurrencyInReports>
  </mvCurrency>
  <mvRecordAction>Insert</mvRecordAction>
  <mvInsertUpdateDeleteSourceApplication>String</mvInsertUpdateDeleteSourceApplication>
</CurrencyUpdate>

    </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>

<CurrencyUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Megaventory.APIEndpoints.Operations">
  <mvCurrency xmlns:d2p1="https://api.megaventory.com/types">
    <d2p1:CurrencyId>0</d2p1:CurrencyId>
    <d2p1:CurrencyCode>String</d2p1:CurrencyCode>
    <d2p1:CurrencyDescription>String</d2p1:CurrencyDescription>
    <d2p1:CurrencySymbol>String</d2p1:CurrencySymbol>
    <d2p1:CurrencyIsDefault>false</d2p1:CurrencyIsDefault>
    <d2p1:CurrencyInReports>false</d2p1:CurrencyInReports>
  </mvCurrency>
  <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>
</CurrencyUpdateResponse>

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