Megaventory API v2017a

<back to all web services

DocumentTypeUpdate

The following routes are available for this service:
POST/DocumentType/DocumentTypeUpdateUpdates a document type.Uses your API Key and some Filters in an array format to apply the given action to an existing DocumentType.

Examples:



A.

Update the Document type with DocumentTypeAbbreviation = "PO". The result is returned as an mvDocumentTypes object.
The documentType with DocumentTypeAbbreviation = "PO" before the Update:

Response: 

    {
        "mvDocumentType":
        {
            "DocumentTypeID": 4,
            "DocumentTypeAbbreviation": "PO",
            "DocumentTypeDescription": "Purchase Order",
            "DocumentTypeStockChange": "None",
            "InvoiceType": "None",
            "RestrictProductsBySupplier": false,
            "UpdateSupplierClientPriceWhenIssued": false,
            "IsReturn": false,
            "IsAdjustment": false,
            "IsTransfer": false,
            "IsSalesQuote": false,
            "IsSalesOrder": false,
            "IsPurchaseOrder": true,
            "IsFinishedGoodsReceipt": false,
            "IsWorkOrder": false,
            "IsHandlingInvoice": false,
            "DocumentTypeOptionsShowSKUImage": true,
            "DocumentTypeOptionsShowSupplierSKU": true,
            "DocumentTypeOptionsShowTax": true,
            "DocumentTypeOptionsShowDiscount": true,
            "DocumentTypeOptionsShowRemarks": false,
            "DocumentTypeOptionsShowExpectedDeliveryDate": false,
            "DocumentTypePrintOptionsUseCustomHeader": false,
            "DocumentTypePrintOptionsUseCustomFooter": false,
            "DocumentTypePrintOptionsShowClientInPickPackSlips": false,
            "DocumentTypePrintOptionsUseCustomHeaderPackingSlip": false,
            "DocumentTypePrintOptionsUseCustomFooterPackingSlip": false,
            "DocumentTypePrintOptionsUseCustomHeaderPickingSlip": false,
            "DocumentTypePrintOptionsUseCustomFooterPickingSlip": false,
            "DocumentTypePrintOptionsUseCustomFont": false,
            "DocumentTypePrintOptionsShowEAN": false,
            "DocumentTypePrintOptionsShowSKU": false,
            "DocumentTypePrintOptionsShowSubLocation": true,
            "DocumentTypePrintOptionsShowMovedQuantity": true,
            "DocumentTypePrintOptionsShowURL": true,
            "DocumentTypePrintOptionsShowSerialNumbers": false,
            "DocumentTypeOptionsShowDateTime": true,
            "DocumentTypePrintOptionsUseCustomSubject": false,
            "DocumentTypePrintOptionsShowPreTaxTotalsInRow": false,
            "DocumentTypePrintOptionsShowPostTaxTotalsInRow": false,
            "DocumentTypePrintOptionsShowPreDiscountTotalsInRow": false,
            "DocumentTypePrintOptionsShowPostDiscountTotalsInRow": false,
            "DocumentTypeAutoNumbering": true,
            "DocumentTypeAutoNumberingStartFrom": 1,
            "DocumentTypeAutoNumberingNextNumber": 50,
            "DocumentTypeAutoNumberingPrefix": "",
            "DocumentTypeAutoNumberingPostfix": ""
        }
    }

Then we call the documentTypeUpdate.
We update the DocumentTypeOptionsShowSKUImage to false and DocumentTypeOptionsShowSupplierSKU to false.

Value: 

  {
   "mvDocumentType":
      {
         "DocumentTypeID": 4,
          "DocumentTypeAbbreviation": "PO",
          "DocumentTypeDescription": "Purchase Order",
          "DocumentTypeStockChange": "None",
          "InvoiceType": "None",
          "RestrictProductsBySupplier": false,
          "UpdateSupplierClientPriceWhenIssued": false,
          "IsReturn": false,
          "IsAdjustment": false,
          "IsTransfer": false,
          "IsSalesQuote": false,
          "IsSalesOrder": false,
          "IsPurchaseOrder": true,
          "IsFinishedGoodsReceipt": false,
          "IsWorkOrder": false,
          "IsHandlingInvoice": false,
          "DocumentTypeOptionsShowSKUImage": false,
          "DocumentTypeOptionsShowSupplierSKU": false,
          "DocumentTypeOptionsShowTax": true,
          "DocumentTypeOptionsShowDiscount": true,
          "DocumentTypeOptionsShowRemarks": false,
          "DocumentTypeOptionsShowExpectedDeliveryDate": false,
          "DocumentTypePrintOptionsUseCustomHeader": false,
          "DocumentTypePrintOptionsUseCustomFooter": false,
          "DocumentTypePrintOptionsShowClientInPickPackSlips": false,
          "DocumentTypePrintOptionsUseCustomHeaderPackingSlip": false,
          "DocumentTypePrintOptionsUseCustomFooterPackingSlip": false,
          "DocumentTypePrintOptionsUseCustomHeaderPickingSlip": false,
          "DocumentTypePrintOptionsUseCustomFooterPickingSlip": false,
          "DocumentTypePrintOptionsUseCustomFont": false,
          "DocumentTypePrintOptionsShowEAN": false,
          "DocumentTypePrintOptionsShowSKU": false,
          "DocumentTypePrintOptionsShowSubLocation": true,
          "DocumentTypePrintOptionsShowMovedQuantity": true,
          "DocumentTypePrintOptionsShowURL": true,
          "DocumentTypePrintOptionsShowSerialNumbers": false,
          "DocumentTypeOptionsShowDateTime": true,
          "DocumentTypePrintOptionsUseCustomSubject": false,
          "DocumentTypePrintOptionsShowPreTaxTotalsInRow": false,
          "DocumentTypePrintOptionsShowPostTaxTotalsInRow": false,
          "DocumentTypePrintOptionsShowPreDiscountTotalsInRow": false,
          "DocumentTypePrintOptionsShowPostDiscountTotalsInRow": false,
          "DocumentTypeAutoNumbering": true,
          "DocumentTypeAutoNumberingStartFrom": 1,
          "DocumentTypeAutoNumberingNextNumber": 50,
          "DocumentTypeAutoNumberingPrefix": "",
          "DocumentTypeAutoNumberingPostfix": ""
      },
   "mvRecordAction":"Update"
}

Response: 

{
   "mvDocumentType":
      {
         "DocumentTypeID": 4,
          "DocumentTypeAbbreviation": "PO",
          "DocumentTypeDescription": "Purchase Order",
          "DocumentTypeStockChange": "None",
          "InvoiceType": "None",
          "RestrictProductsBySupplier": false,
          "UpdateSupplierClientPriceWhenIssued": false,
          "IsReturn": false,
          "IsAdjustment": false,
          "IsTransfer": false,
          "IsSalesQuote": false,
          "IsSalesOrder": false,
          "IsPurchaseOrder": true,
          "IsFinishedGoodsReceipt": false,
          "IsWorkOrder": false,
          "IsHandlingInvoice": false,
          "DocumentTypeOptionsShowSKUImage": false,
          "DocumentTypeOptionsShowSupplierSKU": false,
          "DocumentTypeOptionsShowTax": true,
          "DocumentTypeOptionsShowDiscount": true,
          "DocumentTypeOptionsShowRemarks": false,
          "DocumentTypeOptionsShowExpectedDeliveryDate": false,
          "DocumentTypePrintOptionsUseCustomHeader": false,
          "DocumentTypePrintOptionsUseCustomFooter": false,
          "DocumentTypePrintOptionsShowClientInPickPackSlips": false,
          "DocumentTypePrintOptionsUseCustomHeaderPackingSlip": false,
          "DocumentTypePrintOptionsUseCustomFooterPackingSlip": false,
          "DocumentTypePrintOptionsUseCustomHeaderPickingSlip": false,
          "DocumentTypePrintOptionsUseCustomFooterPickingSlip": false,
          "DocumentTypePrintOptionsUseCustomFont": false,
          "DocumentTypePrintOptionsShowEAN": false,
          "DocumentTypePrintOptionsShowSKU": false,
          "DocumentTypePrintOptionsShowSubLocation": true,
          "DocumentTypePrintOptionsShowMovedQuantity": true,
          "DocumentTypePrintOptionsShowURL": true,
          "DocumentTypePrintOptionsShowSerialNumbers": false,
          "DocumentTypeOptionsShowDateTime": true,
          "DocumentTypePrintOptionsUseCustomSubject": false,
          "DocumentTypePrintOptionsShowPreTaxTotalsInRow": false,
          "DocumentTypePrintOptionsShowPostTaxTotalsInRow": false,
          "DocumentTypePrintOptionsShowPreDiscountTotalsInRow": false,
          "DocumentTypePrintOptionsShowPostDiscountTotalsInRow": false,
          "DocumentTypeAutoNumbering": true,
          "DocumentTypeAutoNumberingStartFrom": 1,
          "DocumentTypeAutoNumberingNextNumber": 50,
          "DocumentTypeAutoNumberingPrefix": "",
          "DocumentTypeAutoNumberingPostfix": ""
      },
   "ResponseStatus": {
      "ErrorCode": "0"
   }
}

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/DocumentTypeUpdate HTTP/1.1 
Host: api.megaventory.com 
Content-Type: text/csv
Content-Length: length

DocumentTypeID,DocumentTypeCompanyID,DocumentTypeAbbreviation,DocumentTypeDescription,DocumentTypeStockChange,InvoiceType,RestrictProductsBySupplier,UpdateSupplierClientPriceWhenIssued,IsReturn,IsAdjustment,IsTransfer,IsSalesQuote,IsSalesOrder,IsPurchaseOrder,IsFinishedGoodsReceipt,IsWorkOrder,IsHandlingInvoice,RelatedDocumentTypeID,DocumentTypeOptionsShowSKUImage,DocumentTypeOptionsShowSupplierSKU,DocumentTypeOptionsShowTax,DocumentTypeOptionsShowDiscount,DocumentTypeOptionsShowRemarks,DocumentTypeOptionsShowWeight,DocumentTypeOptionsShowExpectedDeliveryDate,DocumentTypePrintOptionsUseCustomHeader,DocumentTypePrintOptionsUseCustomFooter,DocumentTypePrintOptionsShowClientInPickPackSlips,DocumentTypePrintOptionsUseCustomHeaderPackingSlip,DocumentTypePrintOptionsUseCustomFooterPackingSlip,DocumentTypePrintOptionsUseCustomHeaderPickingSlip,DocumentTypePrintOptionsUseCustomFooterPickingSlip,DocumentTypePrintOptionsUseCustomHeaderDeliverySlip,DocumentTypePrintOptionsUseCustomFooterDeliverySlip,DocumentTypePrintOptionsUseCustomFont,DocumentTypePrintOptionsShowEAN,DocumentTypePrintOptionsShowSKU,DocumentTypePrintOptionsShowSubLocation,DocumentTypePrintOptionsShowMovedQuantity,DocumentTypePrintOptionsShowURL,DocumentTypePrintOptionsShowSerialNumbers,DocumentTypeOptionsShowDateTime,DocumentTypePrintOptionsUseCustomSubject,DocumentTypePrintOptionsShowPreTaxTotalsInRow,DocumentTypePrintOptionsShowPostTaxTotalsInRow,DocumentTypePrintOptionsShowPreDiscountTotalsInRow,DocumentTypePrintOptionsShowPostDiscountTotalsInRow,DocumentTypeAutoNumbering,DocumentTypeAutoNumberingStartFrom,DocumentTypeAutoNumberingNextNumber,DocumentTypeAutoNumberingPrefix,DocumentTypeAutoNumberingPostfix
0,0,String,String,None,None,False,False,False,False,False,False,False,False,False,False,False,0,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,0,0,String,String


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

DocumentTypeID,DocumentTypeCompanyID,DocumentTypeAbbreviation,DocumentTypeDescription,DocumentTypeStockChange,InvoiceType,RestrictProductsBySupplier,UpdateSupplierClientPriceWhenIssued,IsReturn,IsAdjustment,IsTransfer,IsSalesQuote,IsSalesOrder,IsPurchaseOrder,IsFinishedGoodsReceipt,IsWorkOrder,IsHandlingInvoice,RelatedDocumentTypeID,DocumentTypeOptionsShowSKUImage,DocumentTypeOptionsShowSupplierSKU,DocumentTypeOptionsShowTax,DocumentTypeOptionsShowDiscount,DocumentTypeOptionsShowRemarks,DocumentTypeOptionsShowWeight,DocumentTypeOptionsShowExpectedDeliveryDate,DocumentTypePrintOptionsUseCustomHeader,DocumentTypePrintOptionsUseCustomFooter,DocumentTypePrintOptionsShowClientInPickPackSlips,DocumentTypePrintOptionsUseCustomHeaderPackingSlip,DocumentTypePrintOptionsUseCustomFooterPackingSlip,DocumentTypePrintOptionsUseCustomHeaderPickingSlip,DocumentTypePrintOptionsUseCustomFooterPickingSlip,DocumentTypePrintOptionsUseCustomHeaderDeliverySlip,DocumentTypePrintOptionsUseCustomFooterDeliverySlip,DocumentTypePrintOptionsUseCustomFont,DocumentTypePrintOptionsShowEAN,DocumentTypePrintOptionsShowSKU,DocumentTypePrintOptionsShowSubLocation,DocumentTypePrintOptionsShowMovedQuantity,DocumentTypePrintOptionsShowURL,DocumentTypePrintOptionsShowSerialNumbers,DocumentTypeOptionsShowDateTime,DocumentTypePrintOptionsUseCustomSubject,DocumentTypePrintOptionsShowPreTaxTotalsInRow,DocumentTypePrintOptionsShowPostTaxTotalsInRow,DocumentTypePrintOptionsShowPreDiscountTotalsInRow,DocumentTypePrintOptionsShowPostDiscountTotalsInRow,DocumentTypeAutoNumbering,DocumentTypeAutoNumberingStartFrom,DocumentTypeAutoNumberingNextNumber,DocumentTypeAutoNumberingPrefix,DocumentTypeAutoNumberingPostfix
0,0,String,String,None,None,False,False,False,False,False,False,False,False,False,False,False,0,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,False,0,0,String,String