GET `/v1/sales/zreport`

Get the register Z reports of a business day live

Key	Required. See Authentication.
Capability	`sales-data`
Scope	`sales.read`
Price	1 credit, per call. How pricing works.
Estimate	Add `estimate=true` for a free quote. With estimate=true the 200 body is EstimateResponse (a priced quote for exactly this request), not the schema documented under responses.200; nothing is reserved or dispatched.

Example

curl -s "https://api.compudime.com/v1/sales/zreport" \
  -H "Authorization: Bearer $PUBLIC_API_KEY"

Parameters

Name	In	Type	Description
`businessDay` required	query	string (date)	The business day (YYYY-MM-DD, the store's calendar). Required. A register log belongs to the business day the POS recorded on it, else the day it started, the grouping TisWin3's register log dashboard uses.
`register`	query	string	Only the logs of this register: its code as the rows show it (register), 1-2 letters or digits. A one-digit code and the same digit with a leading 0 name the same register (1 and 01), as the register itself treats them. Pattern: ^[A-Za-z0-9]{1,2}$
`fields`	query	string	Comma-separated register z report fields to include (see x-compudime-field-catalog), or * for every field the key may see. Omitted: a flat-priced endpoint returns every field; once IT prices the endpoint by field count (includedFields in x-compudime-pricing), an omitted fields returns the standard set at the base price and each field beyond the included count adds extraFieldCost. An unknown or denied field is a free 400 field_not_allowed.
`estimate`	query	boolean	When true, returns EstimateResponse instead of the normal body and never reserves credits: the request is authenticated, authorized and field-resolved exactly like a real call, then priced by billing (base cost plus extra-field credits for the resolved fields) and returned without dispatching to the store. Free of charge. Default: false.

Responses

Status	Description	Body
`200`	The register logs (Z tapes) of the business day, live, each with the totals the register keeps and its tender totals.	`ZReportResponse`
`400`	businessDay is missing or not a YYYY-MM-DD day, or register is not of the documented shape (code bad_request); or a requested field is not allowed (code field_not_allowed). Rejected before billing.	`Problem`
`401`	Public API key is missing, invalid, or revoked.	`Problem`
`402`	The request was blocked by billing policy: no_api_plan (no plan funds this meter), billing_card_missing, billing_card_failed, usage_exhausted, overage_cap_reached, subscription_paused, sandbox_exhausted, or billing_blocked. A key the store pays for under its approval gets grant_cap_exceeded (the store's monthly limit for your calls) or payer_billing_blocked (the store cannot be charged right now; ask the store owner) instead: what is wrong with the store's billing is not shown to it.	`Problem`
`403`	capability_not_enabled: the API key is not a sales-data key with the sales.read scope (rejected before billing). store_feature_not_enabled: the key is entitled, but the store has not turned on per-item data for developers on its own POS agent (the same store switch as sales movement and the invoice reads); nothing changes until the store enables it. The reservation is released, nothing is charged.	`Problem`
`405`	The requested method is not allowed for this endpoint.	`Problem`
`422`	scope_not_applicable: the API key carries a row scope, and no row scope can be applied to a register ticket or a register log (rejected before billing). agent_update_required: the store's CompuDime agent is older than this read; the store must update it. zreport_unsupported: the store's POS database has no register log table with the columns this read needs. The reservation is released, nothing is charged.	`Problem`
`429`	Too many requests from this API key (code rate_limited). Each key has its own request budget at the API edge, refilled continuously; it covers every authenticated endpoint, including the free ones, and is checked before anything is billed or sent to the store. Billed endpoints are also subject to the store plan's per-minute ceiling, which answers the same problem code. Wait at least Retry-After seconds before the next request with this key, then resume; if 429 answers again, back off exponentially (double the wait each time, up to a minute or so) and add random jitter so parallel workers do not retry in step. A 429 is never charged and reserves nothing. Header `Retry-After`: Whole seconds to wait before retrying with this key: the time until the key's next request token at the edge (never less than 1), or 60 when the store plan's per-minute ceiling refused the call.	`Problem`
`500`	The API edge encountered an internal error.	`Problem`
`502`	The store's POS could not complete the Z report (code store_error): the agent answered an error, the store has not enabled per-item data for developers, or the agent or relay build predates this operation. The reservation is released.	`Problem`
`503`	The store's POS agent is offline (code store_offline), or a Public API dependency is unavailable. The reservation is released. Also answered, with code endpoint_disabled, while CompuDime has temporarily switched the endpoint off: the whole API, the endpoint's family (x-compudime-family) or this endpoint alone; the detail says which and why. It is checked before anything is validated, reserved or sent to the store, so it is never charged; it is retryable and carries Retry-After. Header `Retry-After`: Sent with code endpoint_disabled: whole seconds to wait before asking again. A switch has no scheduled end, so this is a polling interval (60), not a promise.	`Problem`
`504`	The store did not answer inside the read ceiling (code store_timeout). The reservation is released.	`Problem`

Error bodies are problem JSON; every code is listed there.

Fields

Choose with fields=; see Choosing fields.

All fields	`register`, `logNumber`, `businessDay`, `closed`, `startedAt`, `endedAt`, `lastTransactionAt`, `totals`, `drawer`, `tenders`
Standard set	`register`, `logNumber`, `businessDay`, `closed`, `startedAt`, `endedAt`, `lastTransactionAt`, `totals`, `drawer`, `tenders`

Access level

What your integration's access level changes here.