PosReceiving
One receiving document of the store: a vendor invoice / delivery, which is what moves stock and cost in the POS. Expense invoices (rent, utilities) are not receiving documents and never appear. 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 memo, remark or note, what was paid, the payment terms 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.
| Name | Type | Description |
|---|---|---|
receivingId required | string | The POS receiving id; pass it to GET /v1/receiving/{posReceivingId}. |
billDue | string (date) | When the vendor's bill is due (YYYY-MM-DD). |
businessDay | string (date) | The store business day the document belongs to (YYYY-MM-DD). |
createdAt | string (date-time) | When the POS created the document (UTC). |
date | string (date) | Document date (YYYY-MM-DD, the store's calendar); what dateFrom / dateTo filter on. |
discountPercent | number | The vendor's discount percentage on the document, as stored. Passed through; the API applies it to nothing. |
ignoreInventory | boolean | The document did not move stock. |
inventoryLocation | string | The inventory location the document received into. |
lines | array of PosReceivingLine | Single-document reads only: the document's lines in the POS line order, at most 500. Always present on a single-document read that selects it (an empty array for a document without lines, such as a quick delivery); never on a list row. At most 500 items. |
linesTruncated | boolean | Single-document reads only: present and true when the document has more lines than the 500 one answer carries. |
modifiedAt | string (date-time) | When the POS last modified the document (UTC); what modifiedSince filters on. Absent when the store's POS keeps no modification time. |
number | string | The store's running delivery number. |
purchaseOrderId | string | The purchase order this document received (GET /v1/purchase-orders/{posPurchaseOrderId}); absent when it was entered without one. What the purchaseOrderId filter matches. |
purchaseOrderNumber | string | That purchase order's running number; only next to purchaseOrderId. |
quick | boolean | A quick delivery: entered as a header with a total and no lines. |
source | string | Which program or feed entered the document. |
statusCode | integer | The POS workflow status number as stored. Its meaning is a per-store list this read does not carry, so it is not named. |
totals | PosReceivingTotals | The header money columns as stored. Absent only when the store's POS has none of them. |
transactionType | integer | The POS transaction type as stored: 0 a bill, 1 a vendor credit. The sign of a vendor credit's totals is not dependable in storage and the API negates nothing; read this field to tell a credit. |
vendorCode | string | The vendor's short code in the POS vendor list. |
vendorId | string | The POS vendor id; what vendorId filters on. |
vendorInvoiceNumber | string | The vendor's invoice number for the delivery. |
vendorName | string | The vendor's name in the POS vendor list; absent when the vendor row is gone. |
No other fields appear.