CompuDime API docs

Reference / Schemas

PosZReportLog

One register log (a register's shift; the register prints its Z tape when the log is closed), with the totals the register keeps for it. Every figure is the register's own running total, as stored: an open log changes with every sale, and a closed log can still change when a ticket is edited or the log is recalculated. The cashier names and the cost-derived margins on the log are never part of it.

Type: object.

NameTypeDescription
businessDay requiredstring (date)The business day the log belongs to.
closed requiredbooleanThe log was closed (its Z was taken). An open log's totals are an X reading and still change.
logNumber requiredintegerThe register log number: logNumber on a ticket rung in it.
register requiredstringThe register code.
tenders requiredarray of PosZReportTenderThe log's totals per tender and source, as the register computed them (the register keeps no counted amount per tender). Empty for a log without any (logs of register builds older than 8.8.2 keep none).
totals requiredPosZReportTotals
drawerPosZReportDrawer
endedAtstring (date-time)When the log was closed (UTC). The register may record the time of the last sale instead of the close.
lastTransactionAtstring (date-time)When the last transaction was posted to the log (UTC).
startedAtstring (date-time)When the log was opened (UTC).

No other fields appear.