Fill Line Item Object
Fill Line Item is a line on an Adjustment, Ship Doc, Customer Return, Receiver or Vendor Returns as well as a component on Work Orders or Disassemblies.
End Point
/FillLineItem
GET, POST, PUT 1, DELETE
GET request expect three paramaters 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 either "AOLib7.ShipDocLineItem, AOLib7" OR "AOLib7.ReceiverLineItem, AOLib7" OR "AOLib7.AdjustmentLineItem, AOLib7" OR "AOLib7.WorkOrderComponent, AOLib7" | |||
| TranType | Tran Type | RecordTypeEnum | Yes | Yes |
| DocNo | Doc No. | Int32 | Yes | Yes |
| Id | Id | Int32 | False | 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 |
| LinkedInfo | Links | LinkedLineItemInfo | False | False |
| CustomFields | Custom Fields | Array of CustomFieldData | False | False |
| Details | Line Item Details | Array of FillBinBase | False | False |
| Property | Caption | Data Type |
| TranType | Tran Type | RecordTypeEnum |
| DocNo | Doc No | Int32 |
| LineNo | Line No | Int16 |
| PromiseDate | Promise Date | DateTime |
Properties - Details
The Details node is comprised of Line Item Details. If you have used the Form Designer, you know that you can add details to show the Bins and Lot or Serial No data for inventoried items. Only inventoried items comprising of Part and Assembly items need Details. Details for non-inventoried items will be ignored. You only need to include Details if you want to specifically identify the bins and / or lot and serial numbers being included, otherwise you can omit the Details section and Order Time use the Quantity property in the Fill Line Item.
Line Item Details are comprised of an Array of FillBinBase. FillBinBase can morph into either FillBin or DocFillLotOrSerial. DocFillLotOrSerial is used when the item has TrackLotOrSerial set to true and FillBin is used otherwise.
| Property | Caption | Data Type | Required | Read Only | Applied to |
| $type | This property MUST be included to tell the API what type of Detail is being added. The value should be "AOLib7.FillBin, AOLib7" or "AOLib7.DocFillLotOrSerial, AOLib7" | ||||
| Id | Id | Int32 | False | True | Both |
| BinRef | Bin | EntityRef | True | False | Both |
| LotOrSerialNo | Lot Or Serial No | String (50) | True | False | DocFillLotOrSerial |
| ExpirationDate | Expiration Date | DateTime | True | False | DocFillLotOrSerial |
| Quantity | Quantity | Decimal | True | False | Both |
| Description | Description | String (4000) | False | False | DocFillLotOrSerial |
| WarrantyTypeRef | Warranty | EntityRef | False | False | DocFillLotOrSerial |
| WarrantyDays | Warranty Days | Int32 | False | False | DocFillLotOrSerial |
| CustomFields | Custom Fields | Array of CustomFieldData | False | False | DocFillLotOrSerial |
Json Sample
{
{
"$type": "AOLib7.ShipDocLineItem, AOLib7",
"TranType": 4,
"DocNo": 798
"ItemRef": {
"Id": 30
},
"LineNo": 1,
"Quantity": 2,
"LinkedInfo": {
"LineNo": 1,
"PromiseDate": "2018-11-14T00:00:00",
"DocNo": 18,
"TranType": 7
},
"Details": [
{
"$type": "AOLib7.FillBin, AOLib7",
"ItemRef": {
"Id": 30
},
"BinRef": {
"Id": 8,
"Name": "Floor"
},
"Quantity": 2
}
],
"CustomFields": []
}
}1. PUT end point cannot be used to change quanties.
