<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/simple | Create a record for Customer Delivery Order | AcCusDeliveryOrderMID is a primary key |
---|
CreateCustomerDeliveryOrderSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
CustomerDeliveryOrder | body | CustomerDeliveryOrderSimple | No | |
CustomerDeliveryOrderSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
DocumentHeader | form | AcCusDeliveryOrderMSimple | No | |
DocumentDetails | form | List<AcCusDeliveryOrderDSimple> | No | |
AcCusDeliveryOrderMSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
AcCusDeliveryOrderMID | form | NVARCHAR(20) | Yes | Delivery Order Number |
AcCustomerID | form | NVARCHAR(20) | Yes | Customer ID |
AcTermID | form | NVARCHAR(20) | Yes | Term ID |
AcSalesmanID | form | NVARCHAR(20) | No | Salesman ID. Default to customer's salesman if not specified |
AcLocationID | form | NVARCHAR(20) | Yes | Location ID |
DocumentDate | form | DATE | Yes | Document Date |
DeliveryDate | form | DATE | Yes | Expected Delivery Date |
DocumentNetAmount | form | NUMERIC(18,2) | Yes | Net Amount. Before Round Cent Adjustment |
DocumentCentBalance | form | NUMERIC(18,2) | Yes | Round Cent Adjustment Amount |
DocumentFinalAmount | form | NUMERIC(18,2) | Yes | Final Amount. After Round Cent Adjustment |
RefDocumentNo | form | NVARCHAR(20) | No | Reference Number |
DocumentRemark | form | NVARCHAR(100) | No | Document Remark |
ExtraRemark1 | form | NVARCHAR(100) | No | Extra Remark 1 |
ExtraRemark2 | form | NVARCHAR(100) | No | Extra Remark 2 |
ExtraRemark3 | form | NVARCHAR(100) | No | Extra Remark 3 |
ExtraRemark4 | form | NVARCHAR(100) | No | Extra Remark 4 |
DocumentYourReference | form | NVARCHAR(100) | No | Your Reference |
ShipToRemark | form | NVARCHAR(100) | No | Ship To: Remark |
ShipToShipVia | form | NVARCHAR(20) | No | Ship To: Ship Via |
ShipToAddress1 | form | NVARCHAR(100) | No | Ship To: Address 1 |
ShipToAddress2 | form | NVARCHAR(100) | No | Ship To: Address 2 |
ShipToAddress3 | form | NVARCHAR(100) | No | Ship To: Address 3 |
ShipToAddress4 | form | NVARCHAR(100) | No | Ship To: Address 4 |
ShipToPhone1 | form | NVARCHAR(100) | No | Ship To: Phone 1 |
ShipToPhone2 | form | NVARCHAR(100) | No | Ship To: Phone 1 |
ShipToFax | form | NVARCHAR(100) | No | Ship To: Fax |
ShipToContact1 | form | NVARCHAR(100) | No | Ship To: Contact 1 |
ShipToContact2 | form | NVARCHAR(100) | No | Ship To: Contact 2 |
ShipToAttention | form | NVARCHAR(100) | No | Ship To: Attention |
EditDate | form | DATETIME | Yes | Edit Date |
AcCustomerName | form | NVARCHAR(100) | No | Customer Name (Read-Only) |
AcCusDeliveryOrderDSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
AcCusDeliveryOrderDID | form | NVARCHAR(40) | Yes | Record ID. Recommend use GUID |
AcCusDeliveryOrderMID | form | NVARCHAR(20) | Yes | Delivery Order Number |
ItemNo | form | INT | Yes | Item Number. Unique in a document. |
AcStockID | form | NVARCHAR(20) | Yes | Stock ID |
AcStockUOMID | form | NVARCHAR(20) | Yes | Stock UOM ID |
ItemUnitPrice | form | NUMERIC(18,4) | Yes | Item Unit Price |
ItemQuantity | form | NUMERIC(18,4) | Yes | Item Quantity |
ItemGrossTotal | form | NUMERIC(18,2) | Yes | Item Gross Total. [Item Unit Price] x [ Item Quantity ] |
ItemDiscountAmount | form | NUMERIC(18,2) | Yes | Item Discount Amount |
ItemTotalPrice | form | NUMERIC(18,2) | Yes | Item Total Price. [(Unit Price x Quantity) - Discount Amount] |
ItemRemark1 | form | NVARCHAR(MAX) | Yes | Item Remark 1 |
MatchIsActive | form | NVARCHAR(1) | Yes | Match Is Active. (Y/N). Default to N. If Y, please provide MatchType;MatchDocumentNo;MatchItemNo |
MatchType | form | NVARCHAR(20) | No | Match Document Type. Valid Value: Sales Order |
MatchDocumentNo | form | NVARCHAR(20) | No | Match Document Number. |
MatchItemNo | form | INT | Yes | Match Document Item Number. |
AcCusDeliveryOrderDSerial | form | List | No | Customer Delivery Order Serial List. |
AcCusDeliveryOrderDSerialSimple Parameters:Name | Parameter | Data Type | Required | Description |
---|
AcCusDeliveryOrderMID | form | NVARCHAR(20) | Yes | Customer Delivery Order Number |
ItemNo | form | INTEGER | Yes | Item Number (Referred to AcCusDeliveryOrderD.ItemNo) |
AcStockID | form | NVARCHAR(20) | No | Stock ID |
AcStockUOMID | form | NVARCHAR(20) | No | Stock UOM ID |
StockSerialNumber | form | NVARCHAR(40) | Yes | Stock Serial Number |
ItemQuantity | form | INT | No | Item Quantity. Always 1. |
CreateCustomerDeliveryOrderSimpleResponse Parameters:Name | Parameter | Data Type | Required | Description |
---|
CustomerDeliveryOrder | form | CustomerDeliveryOrderSimple | No | |
ResponseStatus | form | ResponseStatus | No | |
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>