CompuDime API docs

Reference / Schemas

PosInvoice

One POS invoice (a customer order). A field whose column the store's POS lacks, or that the POS left blank, is absent. The invoice never carries who the customer is beyond the POS customer id: no name, phone, ship-to, remark or note.

Type: object.

NameTypeDescription
invoiceId requiredstringThe POS invoice id; pass it to GET /v1/invoices/{posInvoiceId}.
anonymousCustomerbooleanPresent and true when the invoice belongs to the register's anonymous walk-in or remote-customer placeholder account, which is not a customer; absent otherwise.
customerIdstringThe POS customer id (posCustomerId on the customer reads). Absent, with anonymousCustomer true, on an invoice of the register's anonymous walk-in or remote-customer placeholder account.
datestring (date)Invoice date (YYYY-MM-DD, the store's calendar).
deliveryPosInvoiceDeliverySingle-invoice reads only: the newest delivery-control record of the register tickets the order was rung up on (the POS keeps delivery records per register ticket); absent while the order has not been rung up or the store recorded no delivery for it, and from stores whose CompuDime agent predates this lookup.
deliveryMethodstringThe POS delivery method of the order, as the store configured it.
deliveryTimestringRequested delivery time of day, store wall clock (HH:MM:SS).
duestring (date)Due date (YYYY-MM-DD, the store's calendar); what dueFrom / dueTo filter on.
externalIdstringThe placing system's own order id as the POS stored it (leading zeros stripped; its first 25 characters on current TisWin3 databases). Only at stores from TisWin3 database version 1.324.
linesarray of PosInvoiceLineSingle-invoice reads only: the invoice's lines in the POS line order, at most 500. Always present on a single-invoice read that selects it (an empty array for an invoice without lines); never on a list row. At most 500 items.
linesTruncatedbooleanSingle-invoice reads only: present and true when the invoice has more lines than the 500 one answer carries.
modifiedAtstring (date-time)When the POS last modified the invoice (UTC); what modifiedSince filters on. Absent when the store's POS keeps no modification time.
numberstringThe invoice number, at stores whose POS keeps one.
orderDeptstringThe POS order department.
orderNumberstringThe store's running order number.
payTypestringThe POS payment type of the order.
processorCodestringThe system that placed the order, as the POS stored it: its first 10 characters on current TisWin3 databases, so an order placed through POST /v1/orders reads CDAPI: plus the first four characters of the integration id. Only at stores from TisWin3 database version 1.324.
routestringThe delivery route (see GET /v1/delivery/routes).
routeSeqstringThe stop sequence on the route.
sourcestringWhich program or feed entered the order.
statusstringThe POS status as the store wrote it (the POS writes Created, Picked, Completed and Processed; a store may use others).
taxRate1numberThe header's first tax percentage: what the POS multiplies a taxable1 line's amount by.
taxRate2numberThe header's second tax percentage.
timelinePosInvoiceTimelineThe order's fulfilment timeline; absent when the POS recorded no step.
totalsPosInvoiceTotalsThe header money columns as stored. Absent only when the store's POS has none of them.

No other fields appear.