Purpose
Speeds up your reconciliation flows by listing sales receipts by date, amount, or status.HTTP Request
Authorization
The following headers are mandatory:x-tokenx-brandx-venue
Request Example
Response
200 OK — List of receipts
400 Bad Request — Parameter error
401 Unauthorized — Missing header
Field Reference
Top-level fields
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates the result of the request. |
data | array | List of receipt objects. |
total | number | Total number of receipts matching filters. |
time | number | Response time in milliseconds. |
timestamp | string | Server timestamp (YYYY-MM-DD HH:mm:ss). |
unix | number | Unix timestamp in seconds. |
sorts | array | Available sort fields. |
Receipt object (selected fields)
| Field | Type | Description |
|---|---|---|
id | number | Unique receipt identifier. |
cid | string | Transaction UUID. |
status | number | Receipt status code. |
sale_type_id | number | Sale type identifier. |
total | number | Total amount collected. |
subtotal | number | Subtotal before adjustments. |
by_cash | number | Amount paid in cash. |
by_card | number | Amount paid by card. |
payment_methods | array | Detailed payment method breakdown. |
meta | object | Additional metadata such as sale type and user. |
created_at | string | Receipt creation time (YYYY-MM-DD HH:mm:ss). |
closed_at | string | Receipt close time (YYYY-MM-DD HH:mm:ss). |
shift_date | string | Shift date associated with the receipt. |
properties | object | Other derived identifiers (e.g., daily_id). |
payment_methods[]
| Field | Type | Description |
|---|---|---|
id | number | Payment method ID. |
name | string | Payment method name. |
amount | number | Amount paid using this method. |
Notes
- Use the
date[0]anddate[1]filters to restrict receipts to a date range (inclusive, YYYY-MM-DD). - Sorting accepts multiple fields (
sort[0],sort[1], etc.); directions must be1(ascending) or-1(descending). - Pagination uses classic
pageandlimitsemantics; the defaultlimitis 50. - Combine
status,sale_type_id, andterminal_idfilters via the OpenAPI explorer when you need more granular reporting. - Inspect
sortsin the response to discover additional sortable fields supported by the API. - Directly created receipts do not trigger POS notifications or external updates; they are saved closed for reconciliation.
Authorizations
Access token obtained from /auth endpoint
Brand identifier
Venue identifier
Query Parameters
Page number for pagination (starts at 1)
Required range:
x >= 1Number of receipts to return per page (1-200)
Required range:
1 <= x <= 200Primary sort field
Primary sort direction (1 = ascending, -1 = descending)
Available options:
1, -1 Start date (inclusive) in YYYY-MM-DD format
End date (inclusive) in YYYY-MM-DD format