CompuDime API docs

Reference / Schemas

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.

NameTypeDescription
lineId requiredstringThe POS line id.
orderedQuantity requirednumberQuantity ordered, in CASES, signed as stored (a return to the vendor is negative; a stored null reads 0).
amountnumberThe line amount as the POS stored it (the POS stores orderedQuantity x caseCost); never recomputed.
caseCostnumberCost of ONE CASE after the order's discountPercent, as stored. Not a unit cost.
caseCostBeforeDiscountnumberCost of ONE CASE before the order's discount, as stored. Not a unit cost.
costFlagstringThe POS cost-flag letter of the line.
descriptionstringThe item description on the line.
discountAmountnumberThe line's discount amount, as stored.
lineNumberstringThe line's position on the order, as the POS shows it.
noDiscountbooleanThe line is excluded from the order's discount.
productCodestringThe store product code.
receivedQuantitynumberA 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.
receivingIdstringThe receiving document the POS stored on the order line. Normally absent, for the same reason as receivedQuantity.
unitsPerCasenumberSell units in one case, as the POS copied it from the product when the line was written.
vendorItemCodestringThe vendor's own item code.

No other fields appear.