GET api/SalesDocument/WithLines/{Sales_Doc_Type}/{Sales_Doc_Num}
Retrieves a Sales Document and its Sales Line Items in one http request. 'LineItems' is an array property for Sales Line Items.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| Sales_Doc_Type | No documentation available. |
Define this parameter in the request URI. |
| Sales_Doc_Num | No documentation available. |
Define this parameter in the request URI. |
Request body formats
text/plain
Sample:
No body required. Body is ignored.
Response Information
Response body formats
application/json, text/json
Sample:
{
"LineItems": [
{
"Sales_Doc_Type": "sample string 1",
"Sales_Doc_Num": "sample string 2",
"Line_Num": 3,
"Component_Seq_Num": 4,
"Source": "sample string 5",
"Item_Number": "sample string 6",
"Item_Description": "sample string 7",
"Is_Non_Inventory": true,
"Is_Dropship": true,
"UOfM_Schedule": "sample string 8",
"Unit_Of_Measure": "sample string 9",
"Base_UofM": "sample string 10",
"Warehouse_Code": "sample string 11",
"Unit_Cost": 12.0,
"Expected_Unit_Cost": 1.0,
"Extended_Cost": 1.0,
"Unit_Price": 1.0,
"Extended_Price": 1.0,
"Currency_Dec": 1,
"Markdown_Amount": 1.0,
"Markdown_Pct": 13,
"Item_Tax_Schedule": "sample string 14",
"Quantity": 15.0,
"Qty_Allocated": 16.0,
"Qty_Remaining": 17.0,
"Qty_Canceled": 18.0,
"Qty_Backordered": 19.0,
"Qty_SentTo_Backordered": 20.0,
"Qty_ToPick": 1.0,
"Qty_Fulfilled": 21.0,
"Qty_Selected": 22.0,
"Qty_Avail": 23.0,
"Qty_On_Hand": 24.0,
"Qty_To_Invoice": 25.0,
"Qty_Base_UofM": 26.0,
"Fulfillment_Date": "2025-04-04T00:45:46.63-04:00",
"Actual_Ship_Date": "2025-04-04T00:45:46.63-04:00",
"Shipping_Method": "sample string 29",
"Tax_Schedule": "sample string 30",
"Sales_Territory": "sample string 31",
"Sales_Person_ID": "sample string 32",
"Price_Level": "sample string 33",
"Purchasing_Status": "sample string 34",
"Item_Qty_Dec": 1,
"Item_Curr_Dec": 1,
"Custom_Group": "sample string 35",
"Tax_Amount": 36.0,
"Req_Ship_Date": "2025-04-04T00:45:46.63-04:00",
"Item_Tracking": "sample string 38",
"ReadOnly": true,
"Master_Num": 39,
"Ship_To_Address_Code": "sample string 40",
"Ship_To_Name": "sample string 41",
"Contact_Person": "sample string 42",
"Address_Line_1": "sample string 43",
"Address_Line_2": "sample string 44",
"Address_Line_3": "sample string 45",
"City": "sample string 46",
"STATE": "sample string 47",
"Zip": "sample string 48",
"Country": "sample string 49",
"Country_Code": "sample string 50",
"Phone_1": "sample string 51",
"Phone_2": "sample string 52",
"Phone_3": "sample string 53",
"Fax": "sample string 54",
"Comment": "sample string 55",
"Customer_Num": "sample string 56",
"Customer_Name": "sample string 57",
"Previous_Qty": 58.0,
"Previous_UofM": "sample string 59",
"Price_Source": "sample string 60",
"Qty_Unblocked": 61.0,
"Item_Short_Description": "sample string 62",
"Item_Type": "sample string 63",
"Item_Blocked": true,
"Standard_Cost": 1.0,
"Inventory_Acct_Index": 64,
"Cost_Of_Sales_Acct_Index": 65,
"Sales_Acct_Index": 66,
"Markdowns_Acct_Index": 67,
"Returns_Acct_Index": 68,
"In_Use_Acct_Index": 69,
"In_Service_Acct_Index": 70,
"Damaged_Acct_Index": 71,
"Exceptional_Demand": 64,
"Exchange_Rate": 73.0,
"Rate_Calc_Method": 74,
"Contract_Num": 1,
"Contract_Detail_Num": 1,
"Assembly_Created": true,
"Configuration_ID": 1,
"Configuration_String_Code": "sample string 75",
"Item_Promo_ID": 1,
"Item_Promo_Type": 1,
"EDI_Type": "sample string 76",
"Comment_ID": "sample string 77",
"Item_Generic_Description": "sample string 78",
"Is_Promo_Item": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"Sales_Doc_Type": "sample string 1",
"Sales_Doc_Num": "sample string 2",
"Line_Num": 3,
"Component_Seq_Num": 4,
"Source": "sample string 5",
"Item_Number": "sample string 6",
"Item_Description": "sample string 7",
"Is_Non_Inventory": true,
"Is_Dropship": true,
"UOfM_Schedule": "sample string 8",
"Unit_Of_Measure": "sample string 9",
"Base_UofM": "sample string 10",
"Warehouse_Code": "sample string 11",
"Unit_Cost": 12.0,
"Expected_Unit_Cost": 1.0,
"Extended_Cost": 1.0,
"Unit_Price": 1.0,
"Extended_Price": 1.0,
"Currency_Dec": 1,
"Markdown_Amount": 1.0,
"Markdown_Pct": 13,
"Item_Tax_Schedule": "sample string 14",
"Quantity": 15.0,
"Qty_Allocated": 16.0,
"Qty_Remaining": 17.0,
"Qty_Canceled": 18.0,
"Qty_Backordered": 19.0,
"Qty_SentTo_Backordered": 20.0,
"Qty_ToPick": 1.0,
"Qty_Fulfilled": 21.0,
"Qty_Selected": 22.0,
"Qty_Avail": 23.0,
"Qty_On_Hand": 24.0,
"Qty_To_Invoice": 25.0,
"Qty_Base_UofM": 26.0,
"Fulfillment_Date": "2025-04-04T00:45:46.63-04:00",
"Actual_Ship_Date": "2025-04-04T00:45:46.63-04:00",
"Shipping_Method": "sample string 29",
"Tax_Schedule": "sample string 30",
"Sales_Territory": "sample string 31",
"Sales_Person_ID": "sample string 32",
"Price_Level": "sample string 33",
"Purchasing_Status": "sample string 34",
"Item_Qty_Dec": 1,
"Item_Curr_Dec": 1,
"Custom_Group": "sample string 35",
"Tax_Amount": 36.0,
"Req_Ship_Date": "2025-04-04T00:45:46.63-04:00",
"Item_Tracking": "sample string 38",
"ReadOnly": true,
"Master_Num": 39,
"Ship_To_Address_Code": "sample string 40",
"Ship_To_Name": "sample string 41",
"Contact_Person": "sample string 42",
"Address_Line_1": "sample string 43",
"Address_Line_2": "sample string 44",
"Address_Line_3": "sample string 45",
"City": "sample string 46",
"STATE": "sample string 47",
"Zip": "sample string 48",
"Country": "sample string 49",
"Country_Code": "sample string 50",
"Phone_1": "sample string 51",
"Phone_2": "sample string 52",
"Phone_3": "sample string 53",
"Fax": "sample string 54",
"Comment": "sample string 55",
"Customer_Num": "sample string 56",
"Customer_Name": "sample string 57",
"Previous_Qty": 58.0,
"Previous_UofM": "sample string 59",
"Price_Source": "sample string 60",
"Qty_Unblocked": 61.0,
"Item_Short_Description": "sample string 62",
"Item_Type": "sample string 63",
"Item_Blocked": true,
"Standard_Cost": 1.0,
"Inventory_Acct_Index": 64,
"Cost_Of_Sales_Acct_Index": 65,
"Sales_Acct_Index": 66,
"Markdowns_Acct_Index": 67,
"Returns_Acct_Index": 68,
"In_Use_Acct_Index": 69,
"In_Service_Acct_Index": 70,
"Damaged_Acct_Index": 71,
"Exceptional_Demand": 64,
"Exchange_Rate": 73.0,
"Rate_Calc_Method": 74,
"Contract_Num": 1,
"Contract_Detail_Num": 1,
"Assembly_Created": true,
"Configuration_ID": 1,
"Configuration_String_Code": "sample string 75",
"Item_Promo_ID": 1,
"Item_Promo_Type": 1,
"EDI_Type": "sample string 76",
"Comment_ID": "sample string 77",
"Item_Generic_Description": "sample string 78",
"Is_Promo_Item": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"Sales_Doc_Type": "sample string 1",
"Sales_Doc_Num": "sample string 2",
"Line_Num": 3,
"Component_Seq_Num": 4,
"Source": "sample string 5",
"Item_Number": "sample string 6",
"Item_Description": "sample string 7",
"Is_Non_Inventory": true,
"Is_Dropship": true,
"UOfM_Schedule": "sample string 8",
"Unit_Of_Measure": "sample string 9",
"Base_UofM": "sample string 10",
"Warehouse_Code": "sample string 11",
"Unit_Cost": 12.0,
"Expected_Unit_Cost": 1.0,
"Extended_Cost": 1.0,
"Unit_Price": 1.0,
"Extended_Price": 1.0,
"Currency_Dec": 1,
"Markdown_Amount": 1.0,
"Markdown_Pct": 13,
"Item_Tax_Schedule": "sample string 14",
"Quantity": 15.0,
"Qty_Allocated": 16.0,
"Qty_Remaining": 17.0,
"Qty_Canceled": 18.0,
"Qty_Backordered": 19.0,
"Qty_SentTo_Backordered": 20.0,
"Qty_ToPick": 1.0,
"Qty_Fulfilled": 21.0,
"Qty_Selected": 22.0,
"Qty_Avail": 23.0,
"Qty_On_Hand": 24.0,
"Qty_To_Invoice": 25.0,
"Qty_Base_UofM": 26.0,
"Fulfillment_Date": "2025-04-04T00:45:46.63-04:00",
"Actual_Ship_Date": "2025-04-04T00:45:46.63-04:00",
"Shipping_Method": "sample string 29",
"Tax_Schedule": "sample string 30",
"Sales_Territory": "sample string 31",
"Sales_Person_ID": "sample string 32",
"Price_Level": "sample string 33",
"Purchasing_Status": "sample string 34",
"Item_Qty_Dec": 1,
"Item_Curr_Dec": 1,
"Custom_Group": "sample string 35",
"Tax_Amount": 36.0,
"Req_Ship_Date": "2025-04-04T00:45:46.63-04:00",
"Item_Tracking": "sample string 38",
"ReadOnly": true,
"Master_Num": 39,
"Ship_To_Address_Code": "sample string 40",
"Ship_To_Name": "sample string 41",
"Contact_Person": "sample string 42",
"Address_Line_1": "sample string 43",
"Address_Line_2": "sample string 44",
"Address_Line_3": "sample string 45",
"City": "sample string 46",
"STATE": "sample string 47",
"Zip": "sample string 48",
"Country": "sample string 49",
"Country_Code": "sample string 50",
"Phone_1": "sample string 51",
"Phone_2": "sample string 52",
"Phone_3": "sample string 53",
"Fax": "sample string 54",
"Comment": "sample string 55",
"Customer_Num": "sample string 56",
"Customer_Name": "sample string 57",
"Previous_Qty": 58.0,
"Previous_UofM": "sample string 59",
"Price_Source": "sample string 60",
"Qty_Unblocked": 61.0,
"Item_Short_Description": "sample string 62",
"Item_Type": "sample string 63",
"Item_Blocked": true,
"Standard_Cost": 1.0,
"Inventory_Acct_Index": 64,
"Cost_Of_Sales_Acct_Index": 65,
"Sales_Acct_Index": 66,
"Markdowns_Acct_Index": 67,
"Returns_Acct_Index": 68,
"In_Use_Acct_Index": 69,
"In_Service_Acct_Index": 70,
"Damaged_Acct_Index": 71,
"Exceptional_Demand": 64,
"Exchange_Rate": 73.0,
"Rate_Calc_Method": 74,
"Contract_Num": 1,
"Contract_Detail_Num": 1,
"Assembly_Created": true,
"Configuration_ID": 1,
"Configuration_String_Code": "sample string 75",
"Item_Promo_ID": 1,
"Item_Promo_Type": 1,
"EDI_Type": "sample string 76",
"Comment_ID": "sample string 77",
"Item_Generic_Description": "sample string 78",
"Is_Promo_Item": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
}
],
"Sales_Doc_Type": "sample string 1",
"Sales_Doc_Num": "sample string 2",
"Sales_Doc_ID": "sample string 3",
"Doc_Date": "2025-04-04T00:45:46.63-04:00",
"Actual_Ship_Date": "2025-04-04T00:45:46.63-04:00",
"Fulfillment_Date": "2025-04-04T00:45:46.63-04:00",
"Source": "sample string 7",
"Sales_Batch": "sample string 8",
"Customer_Num": "sample string 9",
"Customer_Name": "sample string 10",
"Bill_To_Address_Code": "sample string 11",
"Ship_To_Address_Code": "sample string 12",
"Ship_To_Name": "sample string 13",
"Contact_Person": "sample string 14",
"Address_Line_1": "sample string 15",
"Address_Line_2": "sample string 16",
"Address_Line_3": "sample string 17",
"City": "sample string 18",
"State": "sample string 19",
"Zip": "sample string 20",
"Country": "sample string 21",
"Country_Code": "sample string 22",
"Phone_1": "sample string 23",
"Phone_2": "sample string 24",
"Phone_3": "sample string 25",
"Fax": "sample string 26",
"Price_Level": "sample string 27",
"Customer_PO_Num": "sample string 28",
"Status": "sample string 29",
"Req_Ship_Date": "2025-04-04T00:45:46.63-04:00",
"Subtotal": 31.0,
"Freight": 32.0,
"Tax": 33.0,
"Misc_Charge": 34.0,
"Discount": 1.0,
"Trade_Discount_Pct": 1.0,
"Total": 1.0,
"On_Account": 35.0,
"Deposits": 36.0,
"Shipping_Method": "sample string 37",
"Tax_Exempt_1": "sample string 38",
"Tax_Exempt_2": "sample string 39",
"Tax_Registration_Num": "sample string 40",
"Tax_Schedule": "sample string 41",
"Warehouse_Code": "sample string 42",
"Sales_Person_ID": "sample string 43",
"Sales_Territory": "sample string 44",
"Payment_Terms": "sample string 45",
"Master_Num": 46,
"Comments": "sample string 47",
"Notes": "sample string 48",
"User_Def_Date1": "2025-04-04T00:45:46.63-04:00",
"User_Def_Date2": "2025-04-04T00:45:46.63-04:00",
"User_Def_List1": "sample string 49",
"User_Def_List2": "sample string 50",
"User_Def_List3": "sample string 51",
"User_Def_1": "sample string 52",
"User_Def_2": "sample string 53",
"User_Def_3": "sample string 54",
"User_Def_4": "sample string 55",
"User_Def_5": "sample string 56",
"Prev_Sales_Doc_Type": "sample string 57",
"Prev_Sales_Doc_Num": "sample string 58",
"Quote_Num": "sample string 59",
"Invoice_Num": "sample string 60",
"Currency_ID": "sample string 61",
"Pickticket_Num": "sample string 62",
"Packingslip_Num": "sample string 63",
"Ship_Complete": true,
"Currency_Dec": 64,
"Created_On": "2025-04-04T00:45:46.63-04:00",
"Created_By": "sample string 66",
"Email": "sample string 67",
"EnteredBatch": "2025-04-04T00:45:46.63-04:00",
"BatchHours": 1.0,
"BatchDays": 1.0,
"Alert": "sample string 68",
"CC_ID": 1,
"ReadOnly": true,
"Forwardable": true,
"Message": "sample string 69",
"Comment_ID": "sample string 70",
"USRDAT01": "2025-04-04T00:45:46.63-04:00",
"USRDAT02": "2025-04-04T00:45:46.63-04:00",
"USRTAB01": "sample string 71",
"USRTAB09": "sample string 72",
"USRTAB03": "sample string 73",
"USERDEF1": "sample string 74",
"USERDEF2": "sample string 75",
"USRDEF03": "sample string 76",
"USRDEF04": "sample string 77",
"USRDEF05": "sample string 78",
"UPS_Zone": "sample string 79",
"Email_Billing": "sample string 80",
"Quote_Expiration_Date": "2025-04-04T00:45:46.63-04:00",
"Address_Validated": true,
"Order_Date": "2025-04-04T00:45:46.63-04:00",
"Due_Date": "2025-04-04T00:45:46.63-04:00",
"Opportunity_ID": 1,
"Quote_Date": "2025-04-04T00:45:46.63-04:00",
"DEX_ROW_TS": "2025-04-04T00:45:46.63-04:00",
"Exchange_Rate": 86.0,
"Exchange_Date": "2025-04-04T00:45:46.63-04:00",
"Times_Printed": 88,
"Allocate_By": 89,
"Changed_Trade_Discount": true,
"Funct_Subtotal": 1.0,
"Funct_Discount": 1.0,
"Funct_Total": 1.0,
"Funct_On_Account": 1.0,
"Funct_Deposits": 1.0,
"Funct_Misc_Charge": 1.0,
"Funct_Tax": 1.0,
"Funct_Freight": 1.0,
"Store_Name": "sample string 90",
"Drawer_Name": "sample string 91",
"EDI_Type": 1,
"Copy_From_Type": "sample string 92",
"Copy_From_Number": "sample string 93",
"Step_Number": 1,
"EDI_Carrier_Info_Key": 94,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
}