Search

getReports

Retrieve an “X Report” or “Z Report”.

X / Z Report is a report of POS transactions and payments. The output is identical, but an X report is typically printed during the day, and a Z report at the end of the day, after counting the cash drawer.

X / Z Report can be retrieved either as structured data or HTML.

For other reports, see the following API calls:

To get day’s payment totals by type (before the cashier starts counting the cash in the drawer), see the API call getPointOfSaleDayTotals.

Input parameters

Parameter nameDescriptionPossible valueRequired
type

The report to retrieve. Possible values: "ZReport", "SalesReport", "totalTax".

The "SalesReport" and "totalTax" reports are customer-specific formats and not documented, so "ZReport" is the only option that can be actually used.

String yes
pointOfSaleIDIf set, report will contain only the transactions in a specific POS.Integer
warehouseIDIf set, report will contain only the transactions in a specific store / warehouse.Integer
salesManagerIDIf set, report will contain only the transactions of a specific cashier / associate / salesperson / sales manager.Integer
currencyCodeIf set, report will contain only the transactions in a specific currency.Integer
dateStartDate (yyyy-mm-dd)
dateEndDate (yyyy-mm-dd)
getShortReport0 or 1
formatBy default API returns structured data. Set format to "HTML" to retrieve an HTML reportString

Response

Field nameTypeDescription
htmStringIf HTML format was selected, this variable contains the report HTML.
STRUCTURED DATAArrayTo be documented.