SmartAcc DynaMod Web API v2024.4 Build 0000 - Local

<back to all web services

CreateCustomerDeliveryOrderSimple

Customer Module - Transaction

Customer Delivery Order API

Requires Authentication
Required permission:CustomerDeliveryOrder-Transaction.ADD
The following routes are available for this service:
POST/CustomerDeliveryOrders/simpleCreate a record for Customer Delivery OrderAcCusDeliveryOrderMID is a primary key
CreateCustomerDeliveryOrderSimple Parameters:
NameParameterData TypeRequiredDescription
CustomerDeliveryOrderbodyCustomerDeliveryOrderSimpleNo
CustomerDeliveryOrderSimple Parameters:
NameParameterData TypeRequiredDescription
DocumentHeaderformAcCusDeliveryOrderMSimpleNo
DocumentDetailsformList<AcCusDeliveryOrderDSimple>No
AcCusDeliveryOrderMSimple Parameters:
NameParameterData TypeRequiredDescription
AcCusDeliveryOrderMIDformNVARCHAR(20)YesDelivery Order Number
AcCustomerIDformNVARCHAR(20)YesCustomer ID
AcTermIDformNVARCHAR(20)YesTerm ID
AcSalesmanIDformNVARCHAR(20)NoSalesman ID. Default to customer's salesman if not specified
AcLocationIDformNVARCHAR(20)YesLocation ID
DocumentDateformDATEYesDocument Date
DeliveryDateformDATEYesExpected Delivery Date
DocumentNetAmountformNUMERIC(18,2)YesNet Amount. Before Round Cent Adjustment
DocumentCentBalanceformNUMERIC(18,2)YesRound Cent Adjustment Amount
DocumentFinalAmountformNUMERIC(18,2)YesFinal Amount. After Round Cent Adjustment
RefDocumentNoformNVARCHAR(20)NoReference Number
DocumentRemarkformNVARCHAR(100)NoDocument Remark
ExtraRemark1formNVARCHAR(100)NoExtra Remark 1
ExtraRemark2formNVARCHAR(100)NoExtra Remark 2
ExtraRemark3formNVARCHAR(100)NoExtra Remark 3
ExtraRemark4formNVARCHAR(100)NoExtra Remark 4
DocumentYourReferenceformNVARCHAR(100)NoYour Reference
ShipToRemarkformNVARCHAR(100)NoShip To: Remark
ShipToShipViaformNVARCHAR(20)NoShip To: Ship Via
ShipToAddress1formNVARCHAR(100)NoShip To: Address 1
ShipToAddress2formNVARCHAR(100)NoShip To: Address 2
ShipToAddress3formNVARCHAR(100)NoShip To: Address 3
ShipToAddress4formNVARCHAR(100)NoShip To: Address 4
ShipToPhone1formNVARCHAR(100)NoShip To: Phone 1
ShipToPhone2formNVARCHAR(100)NoShip To: Phone 1
ShipToFaxformNVARCHAR(100)NoShip To: Fax
ShipToContact1formNVARCHAR(100)NoShip To: Contact 1
ShipToContact2formNVARCHAR(100)NoShip To: Contact 2
ShipToAttentionformNVARCHAR(100)NoShip To: Attention
EditDateformDATETIMEYesEdit Date
AcCustomerNameformNVARCHAR(100)NoCustomer Name (Read-Only)
AcCusDeliveryOrderDSimple Parameters:
NameParameterData TypeRequiredDescription
AcCusDeliveryOrderDIDformNVARCHAR(40)YesRecord ID. Recommend use GUID
AcCusDeliveryOrderMIDformNVARCHAR(20)YesDelivery Order Number
ItemNoformINTYesItem Number. Unique in a document.
AcStockIDformNVARCHAR(20)YesStock ID
AcStockUOMIDformNVARCHAR(20)YesStock UOM ID
ItemUnitPriceformNUMERIC(18,4)YesItem Unit Price
ItemQuantityformNUMERIC(18,4)YesItem Quantity
ItemGrossTotalformNUMERIC(18,2)YesItem Gross Total. [Item Unit Price] x [ Item Quantity ]
ItemDiscountAmountformNUMERIC(18,2)YesItem Discount Amount
ItemTotalPriceformNUMERIC(18,2)YesItem Total Price. [(Unit Price x Quantity) - Discount Amount]
ItemRemark1formNVARCHAR(MAX)YesItem Remark 1
MatchIsActiveformNVARCHAR(1)YesMatch Is Active. (Y/N). Default to N. If Y, please provide MatchType;MatchDocumentNo;MatchItemNo
MatchTypeformNVARCHAR(20)NoMatch Document Type. Valid Value: Sales Order
MatchDocumentNoformNVARCHAR(20)NoMatch Document Number.
MatchItemNoformINTYesMatch Document Item Number.
AcCusDeliveryOrderDSerialformListNoCustomer Delivery Order Serial List.
AcCusDeliveryOrderDSerialSimple Parameters:
NameParameterData TypeRequiredDescription
AcCusDeliveryOrderMIDformNVARCHAR(20)YesCustomer Delivery Order Number
ItemNoformINTEGERYesItem Number (Referred to AcCusDeliveryOrderD.ItemNo)
AcStockIDformNVARCHAR(20)NoStock ID
AcStockUOMIDformNVARCHAR(20)NoStock UOM ID
StockSerialNumberformNVARCHAR(40)YesStock Serial Number
ItemQuantityformINTNoItem Quantity. Always 1.
CreateCustomerDeliveryOrderSimpleResponse Parameters:
NameParameterData TypeRequiredDescription
CustomerDeliveryOrderformCustomerDeliveryOrderSimpleNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the 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 /CustomerDeliveryOrders/simple HTTP/1.1 
Host: snr2u.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCustomerDeliveryOrderSimple xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <CustomerDeliveryOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:DocumentDetails xmlns:d3p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.CustomerDeliveryOrder">
      <d3p1:AcCusDeliveryOrderDSimple>
        <d3p1:AcCusDeliveryOrderDID>String</d3p1:AcCusDeliveryOrderDID>
        <d3p1:AcCusDeliveryOrderDSerial>
          <d3p1:AcCusDeliveryOrderDSerialSimple>
            <d3p1:AcCusDeliveryOrderMID>String</d3p1:AcCusDeliveryOrderMID>
            <d3p1:AcStockID>String</d3p1:AcStockID>
            <d3p1:AcStockUOMID>String</d3p1:AcStockUOMID>
            <d3p1:ItemNo>0</d3p1:ItemNo>
            <d3p1:ItemQuantity>0</d3p1:ItemQuantity>
            <d3p1:StockSerialNumber>String</d3p1:StockSerialNumber>
          </d3p1:AcCusDeliveryOrderDSerialSimple>
        </d3p1:AcCusDeliveryOrderDSerial>
        <d3p1:AcCusDeliveryOrderMID>String</d3p1:AcCusDeliveryOrderMID>
        <d3p1:AcStockID>String</d3p1:AcStockID>
        <d3p1:AcStockUOMID>String</d3p1:AcStockUOMID>
        <d3p1:ItemDiscountAmount>0</d3p1:ItemDiscountAmount>
        <d3p1:ItemGrossTotal>0</d3p1:ItemGrossTotal>
        <d3p1:ItemNo>0</d3p1:ItemNo>
        <d3p1:ItemQuantity>0</d3p1:ItemQuantity>
        <d3p1:ItemRemark1>String</d3p1:ItemRemark1>
        <d3p1:ItemTotalPrice>0</d3p1:ItemTotalPrice>
        <d3p1:ItemUnitPrice>0</d3p1:ItemUnitPrice>
        <d3p1:MatchDocumentNo>String</d3p1:MatchDocumentNo>
        <d3p1:MatchIsActive>String</d3p1:MatchIsActive>
        <d3p1:MatchItemNo>0</d3p1:MatchItemNo>
        <d3p1:MatchType>String</d3p1:MatchType>
      </d3p1:AcCusDeliveryOrderDSimple>
    </d2p1:DocumentDetails>
    <d2p1:DocumentHeader xmlns:d3p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.CustomerDeliveryOrder">
      <d3p1:AcCusDeliveryOrderMID>String</d3p1:AcCusDeliveryOrderMID>
      <d3p1:AcCustomerID>String</d3p1:AcCustomerID>
      <d3p1:AcCustomerName>String</d3p1:AcCustomerName>
      <d3p1:AcLocationID>String</d3p1:AcLocationID>
      <d3p1:AcSalesmanID>String</d3p1:AcSalesmanID>
      <d3p1:AcTermID>String</d3p1:AcTermID>
      <d3p1:DeliveryDate>0001-01-01T00:00:00</d3p1:DeliveryDate>
      <d3p1:DocumentCentBalance>0</d3p1:DocumentCentBalance>
      <d3p1:DocumentDate>0001-01-01T00:00:00</d3p1:DocumentDate>
      <d3p1:DocumentFinalAmount>0</d3p1:DocumentFinalAmount>
      <d3p1:DocumentNetAmount>0</d3p1:DocumentNetAmount>
      <d3p1:DocumentRemark>String</d3p1:DocumentRemark>
      <d3p1:DocumentYourReference>String</d3p1:DocumentYourReference>
      <d3p1:EditDate>0001-01-01T00:00:00</d3p1:EditDate>
      <d3p1:ExtraRemark1>String</d3p1:ExtraRemark1>
      <d3p1:ExtraRemark2>String</d3p1:ExtraRemark2>
      <d3p1:ExtraRemark3>String</d3p1:ExtraRemark3>
      <d3p1:ExtraRemark4>String</d3p1:ExtraRemark4>
      <d3p1:RefDocumentNo>String</d3p1:RefDocumentNo>
      <d3p1:ShipToAddress1>String</d3p1:ShipToAddress1>
      <d3p1:ShipToAddress2>String</d3p1:ShipToAddress2>
      <d3p1:ShipToAddress3>String</d3p1:ShipToAddress3>
      <d3p1:ShipToAddress4>String</d3p1:ShipToAddress4>
      <d3p1:ShipToAttention>String</d3p1:ShipToAttention>
      <d3p1:ShipToContact1>String</d3p1:ShipToContact1>
      <d3p1:ShipToContact2>String</d3p1:ShipToContact2>
      <d3p1:ShipToFax>String</d3p1:ShipToFax>
      <d3p1:ShipToPhone1>String</d3p1:ShipToPhone1>
      <d3p1:ShipToPhone2>String</d3p1:ShipToPhone2>
      <d3p1:ShipToRemark>String</d3p1:ShipToRemark>
      <d3p1:ShipToShipVia>String</d3p1:ShipToShipVia>
    </d2p1:DocumentHeader>
  </CustomerDeliveryOrder>
</CreateCustomerDeliveryOrderSimple>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateCustomerDeliveryOrderSimpleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
  <CustomerDeliveryOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
    <d2p1:DocumentDetails xmlns:d3p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.CustomerDeliveryOrder">
      <d3p1:AcCusDeliveryOrderDSimple>
        <d3p1:AcCusDeliveryOrderDID>String</d3p1:AcCusDeliveryOrderDID>
        <d3p1:AcCusDeliveryOrderDSerial>
          <d3p1:AcCusDeliveryOrderDSerialSimple>
            <d3p1:AcCusDeliveryOrderMID>String</d3p1:AcCusDeliveryOrderMID>
            <d3p1:AcStockID>String</d3p1:AcStockID>
            <d3p1:AcStockUOMID>String</d3p1:AcStockUOMID>
            <d3p1:ItemNo>0</d3p1:ItemNo>
            <d3p1:ItemQuantity>0</d3p1:ItemQuantity>
            <d3p1:StockSerialNumber>String</d3p1:StockSerialNumber>
          </d3p1:AcCusDeliveryOrderDSerialSimple>
        </d3p1:AcCusDeliveryOrderDSerial>
        <d3p1:AcCusDeliveryOrderMID>String</d3p1:AcCusDeliveryOrderMID>
        <d3p1:AcStockID>String</d3p1:AcStockID>
        <d3p1:AcStockUOMID>String</d3p1:AcStockUOMID>
        <d3p1:ItemDiscountAmount>0</d3p1:ItemDiscountAmount>
        <d3p1:ItemGrossTotal>0</d3p1:ItemGrossTotal>
        <d3p1:ItemNo>0</d3p1:ItemNo>
        <d3p1:ItemQuantity>0</d3p1:ItemQuantity>
        <d3p1:ItemRemark1>String</d3p1:ItemRemark1>
        <d3p1:ItemTotalPrice>0</d3p1:ItemTotalPrice>
        <d3p1:ItemUnitPrice>0</d3p1:ItemUnitPrice>
        <d3p1:MatchDocumentNo>String</d3p1:MatchDocumentNo>
        <d3p1:MatchIsActive>String</d3p1:MatchIsActive>
        <d3p1:MatchItemNo>0</d3p1:MatchItemNo>
        <d3p1:MatchType>String</d3p1:MatchType>
      </d3p1:AcCusDeliveryOrderDSimple>
    </d2p1:DocumentDetails>
    <d2p1:DocumentHeader xmlns:d3p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types.CustomerDeliveryOrder">
      <d3p1:AcCusDeliveryOrderMID>String</d3p1:AcCusDeliveryOrderMID>
      <d3p1:AcCustomerID>String</d3p1:AcCustomerID>
      <d3p1:AcCustomerName>String</d3p1:AcCustomerName>
      <d3p1:AcLocationID>String</d3p1:AcLocationID>
      <d3p1:AcSalesmanID>String</d3p1:AcSalesmanID>
      <d3p1:AcTermID>String</d3p1:AcTermID>
      <d3p1:DeliveryDate>0001-01-01T00:00:00</d3p1:DeliveryDate>
      <d3p1:DocumentCentBalance>0</d3p1:DocumentCentBalance>
      <d3p1:DocumentDate>0001-01-01T00:00:00</d3p1:DocumentDate>
      <d3p1:DocumentFinalAmount>0</d3p1:DocumentFinalAmount>
      <d3p1:DocumentNetAmount>0</d3p1:DocumentNetAmount>
      <d3p1:DocumentRemark>String</d3p1:DocumentRemark>
      <d3p1:DocumentYourReference>String</d3p1:DocumentYourReference>
      <d3p1:EditDate>0001-01-01T00:00:00</d3p1:EditDate>
      <d3p1:ExtraRemark1>String</d3p1:ExtraRemark1>
      <d3p1:ExtraRemark2>String</d3p1:ExtraRemark2>
      <d3p1:ExtraRemark3>String</d3p1:ExtraRemark3>
      <d3p1:ExtraRemark4>String</d3p1:ExtraRemark4>
      <d3p1:RefDocumentNo>String</d3p1:RefDocumentNo>
      <d3p1:ShipToAddress1>String</d3p1:ShipToAddress1>
      <d3p1:ShipToAddress2>String</d3p1:ShipToAddress2>
      <d3p1:ShipToAddress3>String</d3p1:ShipToAddress3>
      <d3p1:ShipToAddress4>String</d3p1:ShipToAddress4>
      <d3p1:ShipToAttention>String</d3p1:ShipToAttention>
      <d3p1:ShipToContact1>String</d3p1:ShipToContact1>
      <d3p1:ShipToContact2>String</d3p1:ShipToContact2>
      <d3p1:ShipToFax>String</d3p1:ShipToFax>
      <d3p1:ShipToPhone1>String</d3p1:ShipToPhone1>
      <d3p1:ShipToPhone2>String</d3p1:ShipToPhone2>
      <d3p1:ShipToRemark>String</d3p1:ShipToRemark>
      <d3p1:ShipToShipVia>String</d3p1:ShipToShipVia>
    </d2p1:DocumentHeader>
  </CustomerDeliveryOrder>
  <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:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CreateCustomerDeliveryOrderSimpleResponse>