PosPurchaseOrderLine
One line of a vendor purchase order, as stored. The POS buys by the case: quantities count CASES (purchase units of unitsPerCase sell units each) and costs are the cost of ONE CASE, exactly as the POS stores them. The API derives nothing: no unit cost, no extended total and no outstanding quantity is computed, no sign is changed and nothing is clamped. Divide a case cost by unitsPerCase yourself if you need a unit cost.
Type: object.
| Name | Type | Description |
|---|---|---|
lineId required | string | The POS line id. |
orderedQuantity required | number | Quantity ordered, in CASES, signed as stored (a return to the vendor is negative; a stored null reads 0). |
amount | number | The line amount as the POS stored it (the POS stores orderedQuantity x caseCost); never recomputed. |
caseCost | number | Cost of ONE CASE after the order's discountPercent, as stored. Not a unit cost. |
caseCostBeforeDiscount | number | Cost of ONE CASE before the order's discount, as stored. Not a unit cost. |
costFlag | string | The POS cost-flag letter of the line. |
description | string | The item description on the line. |
discountAmount | number | The line's discount amount, as stored. |
lineNumber | string | The line's position on the order, as the POS shows it. |
noDiscount | boolean | The line is excluded from the order's discount. |
productCode | string | The store product code. |
receivedQuantity | number | A received quantity (in CASES) stored on the order line. Normally absent: the POS records a receipt on the receiving document, not here, so absent does NOT mean nothing was received. Read GET /v1/receiving?purchaseOrderId= for what arrived; the API never derives it. |
receivingId | string | The receiving document the POS stored on the order line. Normally absent, for the same reason as receivedQuantity. |
unitsPerCase | number | Sell units in one case, as the POS copied it from the product when the line was written. |
vendorItemCode | string | The vendor's own item code. |
No other fields appear.