Sales Order Line Item

Sales Order Line Item Object

A sales order line item can be in either a sales order or quote. 

End Point

/salesorderlineitem

GET, POST, PUT,  DELETE

GET request expect three parameters of type Int32 as follows

  • recordType (either 7 or 13)
  • docNo
  • lineId

DELETE requests expect parameter id of type Int32.

Properties

PropertyCaptionData TypeRequiredRead Only
$typeThis property MUST be included to tell the API what type of item is being added.
The value should be "AOLib7.SalesOrderLineItem, AOLib7"
IdIdInt32For Put only
True
LineNoLine NoInt16FalseTrue
ItemRefItemEntityRefTrueFalse
DescriptionDescriptionString (4000)FalseFalse
LineInstructionsLine InstructionsString (4000)FalseFalse
SalesTaxCodeRefTax CodeEntityRefFalseFalse
UomRefUOMEntityRefFalseFalse
UomConversionRateUOM Conversion RateDecimalFalseFalse
PricePriceDecimalTrueFalse
QuantityQuantityDecimalTrueFalse
StdCostStd. CostDecimalFalseTrue
StdPriceStd. PriceDecimalFalseTrue
CustomerPartNoCustomer Part NoString (50)FalseFalse
CustomFieldsCustom FieldsArray of CustomFieldDataFalseFalse
IsClearedClearedBooleanFalseFalse

Json Sample

{
     "$type": "AOLib7.SalesOrderLineItem, AOLib7",           
      "ItemRef": {
         "Id": 37,
         "Name": "TSS - Grey - SN"
        },           
        "Description": "Company Branded T-Shirt Large GREY Check out our website for other offers!",
         "Price": 42,          
         "SalesTaxCodeRef": {
                "Id": 12,
                "Name": "Non"
            },         
         "Quantity": 12,           
         "CustomFields": [
             {
                 "Name": "SOICust1",
                  "Value": "Valve",
                  "Caption": "H Code"
                }
            ]
}