CompuDime API docs

Reference / Schemas

PosReceivingLine

One line of a receiving document, 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.
receivedQuantity requirednumberQuantity received, 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 receivedQuantity x caseCost); never recomputed.
caseCostnumberCost of ONE CASE after the document's discount, as stored. Not a unit cost.
caseCostBeforeDiscountnumberCost of ONE CASE before the 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 document, as the POS shows it.
modifiedAtstring (date-time)When the POS last modified the line (UTC).
newProductbooleanThe line created the product in the POS.
noDiscountbooleanThe line is excluded from the document's discount.
orderedQuantitynumberThe purchase-order line's quantity, in CASES, copied when the order was imported into this document: ordered next to received. On a line that did not come from a purchase order it is whatever the POS left there; the header's purchaseOrderId says whether the document had an order at all. The API never computes a difference.
productCodestringThe store product code.
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.