CompuDime API docs

Reference / Schemas

PosPurchaseOrder

One vendor purchase order of the store. A field whose column the store's POS lacks, or that the POS left blank, is absent. It never carries the salesperson, who entered it, a remark, the ship-to block or the vendor's contact details. 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
purchaseOrderId requiredstringThe POS purchase order id; pass it to GET /v1/purchase-orders/{posPurchaseOrderId}, or as purchaseOrderId to GET /v1/receiving to find what received it.
datestring (date)Order date (YYYY-MM-DD, the store's calendar); what dateFrom / dateTo filter on.
discountPercentnumberThe order's discount percentage as stored: what the POS takes off each line's caseCostBeforeDiscount to arrive at its caseCost. Passed through; the API applies it to nothing.
linesarray of PosPurchaseOrderLineSingle-order reads only: the order's lines in the POS line order, at most 500. Always present on a single-order read that selects it (an empty array for an order without lines); never on a list row. At most 500 items.
linesTruncatedbooleanSingle-order reads only: present and true when the order has more lines than the 500 one answer carries.
numberstringThe store's running purchase-order number.
requestedShipDatestring (date)Requested ship date (YYYY-MM-DD).
shipViastringHow the order is to ship, as the store wrote it.
statusstringThe POS status as stored (the POS offers New, Open, Sent, Complete and Canceled).
statusClassstringThe class of status, which the status filter uses: open (New, Open or Sent: still to be received), received (Complete: imported into a receiving document) or canceled. Absent when the stored status is none of the five the POS offers. The POS has no partly-received status; how much arrived is on the receiving document. One of: open, received, canceled.
vendorCodestringThe vendor's short code in the POS vendor list.
vendorIdstringThe POS vendor id; what vendorId filters on.
vendorNamestringThe vendor's name in the POS vendor list; absent when the vendor row is gone.
vendorPoNumberstringThe vendor's own reference for the order.

No other fields appear.