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
| Property | Caption | Data Type | Required | Read Only |
| $type | This property MUST be included to tell the API what type of item is being added. The value should be "AOLib7.SalesOrderLineItem, AOLib7" | |||
| Id | Id | Int32 | For Put only | True |
| LineNo | Line No | Int16 | False | True |
| ItemRef | Item | EntityRef | True | False |
| Description | Description | String (4000) | False | False |
| LineInstructions | Line Instructions | String (4000) | False | False |
| SalesTaxCodeRef | Tax Code | EntityRef | False | False |
| UomRef | UOM | EntityRef | False | False |
| UomConversionRate | UOM Conversion Rate | Decimal | False | False |
| Price | Price | Decimal | True | False |
| Quantity | Quantity | Decimal | True | False |
| StdCost | Std. Cost | Decimal | False | True |
| StdPrice | Std. Price | Decimal | False | True |
| CustomerPartNo | Customer Part No | String (50) | False | False |
| CustomFields | Custom Fields | Array of CustomFieldData | False | False |
| IsCleared | Cleared | Boolean | False | False |
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"
}
]
}