Sales Order
This service is to recieve existing sales orders in Business Central. Please see Sales Archive
Service Endpoint
The base Endpoints are:
SalesOrder_WebConIISWebService/SalesOrder_WebConIISWebService
OutboundSalesOrderIISWebService/OutboundSalesOrderIISWebService
API Methods
Here are the available methods for the Sales Order Service:
- Read
- Read Multiple
- Update
- Update Multiple
- GetSalesOrder
Read Sample
Request
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:sal="http://tempuri.org/SalesOrderIISWebService/">
<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">
<wsa:Action>http://tempuri.org/SalesOrderIISWebService/SalesOrderIISWebService/Read</wsa:Action>
</soap:Header>
<soap:Body>
<sal:Read>
<sal:No>1004</sal:No>
</sal:Read>
</soap:Body>
</soap:Envelope>
Response
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
<s:Header>
<a:Action s:mustUnderstand="1">http://tempuri.org/SalesOrderIISWebService/SalesOrderIISWebService/ReadResponse</a:Action>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ReadResponse xmlns="http://tempuri.org/SalesOrderIISWebService/">
<ReadResult>
<Key xmlns="urn:microsoft-dynamics-schemas/page/salesorder">28;JAAAAACLAQAAAAJ7BDEAMAAwADQ=6;5685101;10;SalesLines2;36;JQAAAACLAQAAAAJ7BDEAMAAwADQAAAAAhxAn6;5685120;36;JQAAAACLAQAAAAJ7BDEAMAAwADQAAAAAhyBO6;5685130;</Key>
<No xmlns="urn:microsoft-dynamics-schemas/page/salesorder">1004</No>
<Sell_to_Customer_No xmlns="urn:microsoft-dynamics-schemas/page/salesorder">10000</Sell_to_Customer_No>
<Sell_to_Contact_No xmlns="urn:microsoft-dynamics-schemas/page/salesorder">KT100156</Sell_to_Contact_No>
<Sell_to_Customer_Name xmlns="urn:microsoft-dynamics-schemas/page/salesorder">New Customer Name</Sell_to_Customer_Name>
<Sell_to_Address xmlns="urn:microsoft-dynamics-schemas/page/salesorder">Tischlerstr. 4-10</Sell_to_Address>
<Sell_to_Post_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">48436</Sell_to_Post_Code>
<Sell_to_City xmlns="urn:microsoft-dynamics-schemas/page/salesorder">Düsseldorf</Sell_to_City>
<Sell_to_Contact xmlns="urn:microsoft-dynamics-schemas/page/salesorder">John Emory</Sell_to_Contact>
<No_of_Archived_Versions xmlns="urn:microsoft-dynamics-schemas/page/salesorder">1</No_of_Archived_Versions>
<Posting_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2016-04-28</Posting_Date>
<Order_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2016-04-28</Order_Date>
<Document_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2016-04-28</Document_Date>
<Requested_Delivery_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">0001-01-01</Requested_Delivery_Date>
<Promised_Delivery_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">0001-01-01</Promised_Delivery_Date>
<External_Document_No xmlns="urn:microsoft-dynamics-schemas/page/salesorder">SHOPNO1234</External_Document_No>
<Salesperson_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">PS</Salesperson_Code>
<Responsibility_Center xmlns="urn:microsoft-dynamics-schemas/page/salesorder">DÜSSELDORF</Responsibility_Center>
<Job_Queue_Status xmlns="urn:microsoft-dynamics-schemas/page/salesorder">_blank_</Job_Queue_Status>
<Status xmlns="urn:microsoft-dynamics-schemas/page/salesorder">Open</Status>
<Bill_to_Customer_No xmlns="urn:microsoft-dynamics-schemas/page/salesorder">10000</Bill_to_Customer_No>
<Bill_to_Contact_No xmlns="urn:microsoft-dynamics-schemas/page/salesorder">KT100156</Bill_to_Contact_No>
<Bill_to_Name xmlns="urn:microsoft-dynamics-schemas/page/salesorder">New Customer Name</Bill_to_Name>
<Bill_to_Address xmlns="urn:microsoft-dynamics-schemas/page/salesorder">Tischlerstr. 4-10</Bill_to_Address>
<Bill_to_Post_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">48436</Bill_to_Post_Code>
<Bill_to_City xmlns="urn:microsoft-dynamics-schemas/page/salesorder">Düsseldorf</Bill_to_City>
<Bill_to_Contact xmlns="urn:microsoft-dynamics-schemas/page/salesorder">John Emory</Bill_to_Contact>
<Shortcut_Dimension_1_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">VERKAUF</Shortcut_Dimension_1_Code>
<Payment_Terms_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">1M(8T)</Payment_Terms_Code>
<Due_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2016-05-28</Due_Date>
<Payment_Discount_Percent xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2</Payment_Discount_Percent>
<Pmt_Discount_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2016-05-06</Pmt_Discount_Date>
<Prices_Including_VAT xmlns="urn:microsoft-dynamics-schemas/page/salesorder">false</Prices_Including_VAT>
<VAT_Bus_Posting_Group xmlns="urn:microsoft-dynamics-schemas/page/salesorder">NATIONAL</VAT_Bus_Posting_Group>
<Ship_to_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">001</Ship_to_Code>
<Ship_to_Name xmlns="urn:microsoft-dynamics-schemas/page/salesorder">TSO-DATA GmbH</Ship_to_Name>
<Ship_to_Address xmlns="urn:microsoft-dynamics-schemas/page/salesorder">Preussenweg 10</Ship_to_Address>
<Ship_to_Post_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">49076</Ship_to_Post_Code>
<Ship_to_City xmlns="urn:microsoft-dynamics-schemas/page/salesorder">Osnabrück</Ship_to_City>
<Ship_to_Contact xmlns="urn:microsoft-dynamics-schemas/page/salesorder">Herr Michael Emanuel</Ship_to_Contact>
<Location_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">BLAU</Location_Code>
<Shipment_Method_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">EXW</Shipment_Method_Code>
<Shipping_Agent_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">DHL</Shipping_Agent_Code>
<Shipping_Agent_Service_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">ÜBER NACHT</Shipping_Agent_Service_Code>
<Shipping_Time xmlns="urn:microsoft-dynamics-schemas/page/salesorder">1D</Shipping_Time>
<Late_Order_Shipping xmlns="urn:microsoft-dynamics-schemas/page/salesorder">false</Late_Order_Shipping>
<Shipment_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2016-04-28</Shipment_Date>
<Shipping_Advice xmlns="urn:microsoft-dynamics-schemas/page/salesorder">Partial</Shipping_Advice>
<EU_3_Party_Trade xmlns="urn:microsoft-dynamics-schemas/page/salesorder">false</EU_3_Party_Trade>
<Prepayment_Percent xmlns="urn:microsoft-dynamics-schemas/page/salesorder">0</Prepayment_Percent>
<Compress_Prepayment xmlns="urn:microsoft-dynamics-schemas/page/salesorder">true</Compress_Prepayment>
<Prepmt_Payment_Terms_Code xmlns="urn:microsoft-dynamics-schemas/page/salesorder">1M(8T)</Prepmt_Payment_Terms_Code>
<Prepayment_Due_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2016-05-28</Prepayment_Due_Date>
<Prepmt_Payment_Discount_Percent xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2</Prepmt_Payment_Discount_Percent>
<Prepmt_Pmt_Discount_Date xmlns="urn:microsoft-dynamics-schemas/page/salesorder">2016-05-06</Prepmt_Pmt_Discount_Date>
<SalesLines xmlns="urn:microsoft-dynamics-schemas/page/salesorder">
<Sales_Order_Line>
<Key>36;JQAAAACLAQAAAAJ7BDEAMAAwADQAAAAAhxAn6;5685120;</Key>
<Type>Item</Type>
<No>1000</No>
<IC_Partner_Ref_Type>_blank_</IC_Partner_Ref_Type>
<Substitution_Available>false</Substitution_Available>
<Nonstock>false</Nonstock>
<VAT_Prod_Posting_Group>VAT19</VAT_Prod_Posting_Group>
<Description>Tourenrad</Description>
<Drop_Shipment>false</Drop_Shipment>
<Special_Order>false</Special_Order>
<Location_Code>BLAU</Location_Code>
<Reserve>Optional</Reserve>
<Quantity>2</Quantity>
<Qty_to_Assemble_to_Order>0</Qty_to_Assemble_to_Order>
<Reserved_Quantity>0</Reserved_Quantity>
<Unit_of_Measure_Code>STÜCK</Unit_of_Measure_Code>
<Unit_of_Measure>Stück</Unit_of_Measure>
<Unit_Cost_LCY>350.594</Unit_Cost_LCY>
<SalesPriceExist>false</SalesPriceExist>
<Unit_Price>4000</Unit_Price>
<Line_Amount>8000</Line_Amount>
<SalesLineDiscExists>true</SalesLineDiscExists>
<Line_Discount_Percent>0</Line_Discount_Percent>
<Line_Discount_Amount>0</Line_Discount_Amount>
<Prepayment_Percent>0</Prepayment_Percent>
<Prepmt_Line_Amount>0</Prepmt_Line_Amount>
<Prepmt_Amt_Inv>0</Prepmt_Amt_Inv>
<Allow_Invoice_Disc>true</Allow_Invoice_Disc>
<Inv_Discount_Amount>0</Inv_Discount_Amount>
<Qty_to_Ship>2</Qty_to_Ship>
<Quantity_Shipped>0</Quantity_Shipped>
<Qty_to_Invoice>2</Qty_to_Invoice>
<Quantity_Invoiced>0</Quantity_Invoiced>
<Prepmt_Amt_to_Deduct>0</Prepmt_Amt_to_Deduct>
<Prepmt_Amt_Deducted>0</Prepmt_Amt_Deducted>
<Allow_Item_Charge_Assignment>true</Allow_Item_Charge_Assignment>
<Qty_to_Assign>0</Qty_to_Assign>
<Qty_Assigned>0</Qty_Assigned>
<Requested_Delivery_Date>0001-01-01</Requested_Delivery_Date>
<Promised_Delivery_Date>0001-01-01</Promised_Delivery_Date>
<Planned_Delivery_Date>2016-04-29</Planned_Delivery_Date>
<Planned_Shipment_Date>2016-04-28</Planned_Shipment_Date>
<Shipment_Date>2016-04-28</Shipment_Date>
<Shipping_Agent_Code>DHL</Shipping_Agent_Code>
<Shipping_Agent_Service_Code>ÜBER NACHT</Shipping_Agent_Service_Code>
<Shipping_Time>1D</Shipping_Time>
<Whse_Outstanding_Qty>0</Whse_Outstanding_Qty>
<Whse_Outstanding_Qty_Base>0</Whse_Outstanding_Qty_Base>
<ATO_Whse_Outstanding_Qty>0</ATO_Whse_Outstanding_Qty>
<ATO_Whse_Outstd_Qty_Base>0</ATO_Whse_Outstd_Qty_Base>
<Blanket_Order_Line_No>0</Blanket_Order_Line_No>
<FA_Posting_Date>0001-01-01</FA_Posting_Date>
<Depr_until_FA_Posting_Date>false</Depr_until_FA_Posting_Date>
<Use_Duplication_List>false</Use_Duplication_List>
<Appl_from_Item_Entry>0</Appl_from_Item_Entry>
<Appl_to_Item_Entry>0</Appl_to_Item_Entry>
<Shortcut_Dimension_1_Code>VERKAUF</Shortcut_Dimension_1_Code>
<ShortcutDimCode_x005B_3_x005D_>MITTEL</ShortcutDimCode_x005B_3_x005D_>
<ShortcutDimCode_x005B_4_x005D_>30</ShortcutDimCode_x005B_4_x005D_>
<Document_No>1004</Document_No>
<Line_No>10000</Line_No>
<Invoice_Discount_Amount>0</Invoice_Discount_Amount>
<Invoice_Disc_Pct>0</Invoice_Disc_Pct>
<Total_Amount_Excl_VAT>8000</Total_Amount_Excl_VAT>
<Total_VAT_Amount>1520</Total_VAT_Amount>
<Total_Amount_Incl_VAT>9520</Total_Amount_Incl_VAT>
</Sales_Order_Line>
</SalesLines>
</ReadResult>
</ReadResponse>
</s:Body>
</s:Envelope>
Field Information
Sales Header Field Information
| Name | Description | Type | max. Length | Occurance |
|---|---|---|---|---|
| 🔑 No | Specifies the number of the Sales order. Leave this empty when creating a new order. (Requieres auto incremented no. series in NAV. | String | 20 | 1..1 |
| Sell-to Contact_No | Specifies the number of the contact. | String | 20 | 1..1 |
| Sell-to Customer_No | Specifies the number of the customer. | String | 20 | 1..1 |
| Sell-to Name | Specifies the name. | String | 50 | 0..1 |
| Sell-to Name_2 | Specifies the additional name. | String | 50 | 0..1 |
| Sell-to First_Name | Specifies the first name. | String | 30 | 0..1 |
| Sell-to Surname | Specifies the surname. | String | 30 | 0..1 |
| Sell-to Address | Specifies the address. i.E. 'Hauptstraße 12b' | String | 50 | 1..1 |
| Sell-to Address_2 | Specifies the add. address information. | String | 50 | 1..1 |
| Sell-to City | Specifies the city. | String | 30 | 1..1 |
| Sell-to Post_Code | Specifies a code for the post code of the address. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Sell-to Country_Region_Code | Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Bill-to Contact_No | Specifies the number of the contact. | String | 20 | 1..1 |
| Bill-to Customer_No | Specifies the number of the customer. | String | 20 | 1..1 |
| Bill-to Name | Specifies the name. | String | 50 | 0..1 |
| Bill-to Name_2 | Specifies the additional name. | String | 50 | 0..1 |
| Bill-to First_Name | Specifies the first name. | String | 30 | 0..1 |
| Bill-to Surname | Specifies the surname. | String | 30 | 0..1 |
| Bill-to Address | Specifies the address. i.E. 'Hauptstraße 12b' | String | 50 | 1..1 |
| Bill-to Address_2 | Specifies the add. address information. | String | 50 | 1..1 |
| Bill-to City | Specifies the city. | String | 30 | 1..1 |
| Bill-to Post_Code | Specifies a code for the post code of the address. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Bill-to Country_Region_Code | Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Ship-to Code | Specifies the Ship-to Address Codes. | String | 10 | 0..1 |
| Ship-to Contact_No | Specifies the number of the contact. | String | 20 | 1..1 |
| Ship-to Name | Specifies the name. | String | 50 | 0..1 |
| Ship-to Name_2 | Specifies the additional name. | String | 50 | 0..1 |
| Ship-to First_Name | Specifies the first name. | String | 30 | 0..1 |
| Ship-to Surname | Specifies the surname. | String | 30 | 0..1 |
| Ship-to Address | Specifies the address. i.E. 'Hauptstraße 12b' | String | 50 | 1..1 |
| Ship-to Address_2 | Specifies the add. address information. | String | 50 | 1..1 |
| Ship-to City | Specifies the city. | String | 30 | 1..1 |
| Ship-to Post_Code | Specifies a code for the post code of the address. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Ship-to Country_Region_Code | Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| External_Document_No | Specifies the external document no. This must be unique in NAV/Business Central. You'll receive an error when insert two orders with the same external document no. | String | 35 | 0..1 |
| Order_Date | Specifies the orders DateTime. Date is saved in NAV/Business Central only! | DateTime | 0..1 | |
| Status | Specifies the order status. Possible Values are "Open","Released","Pending Approval","Pending Prepayment" ! | String | 1..1 | |
| Due_Date | Specifies due date of the order. | DateTime | 0..1 | |
| Currency_Code | Specifies a default currency code for the order. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Shipping_Agent_Code | Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
| Shipping_Agent_Service_Code | Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service | String | 10 | 0..1 |
Sales Header Field Information
| Name | Description | Type | max. Length | Occurance |
|---|---|---|---|---|
| 🔑 Line_No* | Specifies the pos. number. | Decimal | 1..1 | |
| Type | Specifies the Type: "Item", "Resource", "G/L Account" | String | 0..1 | |
| No | Specifies the No. i.E. Item No. "70000" | String | 20 | 0..1 |
| Variant_Code | Specifies the item variant code | String | 10 | 0..1 |
| Description | Specifies the Description. | String | 50 | 0..1 |
| Description_2 | Specifies the additional Description. | String | 50 | 0..1 |
| Unit_Of_Measure_Code | Specifies the sales unit of measure of the item. | String | 10 | 0..1 |
| Quantity | Specifies the quantity. | Decimal | 1..1 | |
| Line_Amount | Specifies the lines amount | Decimal | 0..1 | |
| Line_Discount_Percent | Specifies the lines discount percentage. | Decimal | 0..1 | |
| Line_Discount_Amount | Specifies the lines discount amount. | Decimal | 0..1 | |
| Shipment_Date | Specifies the lines shipment date. | DateTime | 0..1 | |
| Unit_Price | Specifies the lines unit price | Decimal | 0..1 | |
| Gross_Weight | Specifies the gross weight | Decimal | 0..1 | |
| Net_Weight | Specifies the gross weight | Decimal | 0..1 |