CompuDime API docs

Reference / Schemas

PosInvoiceLine

One line of a POS invoice, as stored.

Type: object.

NameTypeDescription
amount requirednumberLine amount as the POS stored it (for a weighed line the POS itself stores quantity x weight x price); never recomputed.
lineId requiredstringThe POS line id.
price requirednumberUnit price, as stored.
quantity requirednumberQuantity ordered, as stored (a stored null reads 0).
casesbooleanSold by the case (a flag, not a count).
descriptionstringThe item description on the line.
discountAmountnumberDiscount amount of the line. Normally absent: the POS does not store a per-line figure, and the API never derives one. Compute it yourself from amount, discountPercent, taxable1/2 and the header's taxRate1/2 if you need it.
discountPercentnumberThe line's discount percentage, as stored.
filledbooleanThe line's picked flag.
filledQuantitynumberHow much of the line was picked.
lineNumberstringThe line's position on the order, as the POS shows it.
netAmountnumberNet amount of the line. Normally absent: the POS does not store a per-line figure, and the API never derives one. Compute it yourself from amount, discountPercent, taxable1/2 and the header's taxRate1/2 if you need it.
productCodestringThe store product code.
scalebooleanA weighed item.
taxAmount1numberFirst tax amount of the line. Normally absent: the POS does not store a per-line figure, and the API never derives one. Compute it yourself from amount, discountPercent, taxable1/2 and the header's taxRate1/2 if you need it.
taxAmount2numberSecond tax amount of the line. Normally absent: the POS does not store a per-line figure, and the API never derives one. Compute it yourself from amount, discountPercent, taxable1/2 and the header's taxRate1/2 if you need it.
taxable1booleanWhether the first tax applies to the line.
taxable2booleanWhether the second tax applies to the line.
weightLbnumberThe weight factor of a weighed line.

No other fields appear.