List Bills by Location

get

https://api.ewitypos.com/apps-v1/sales/bills/location/{id}

Lists the bills of a location, newest first (bill summaries — fetch GET /sales/bills/{id} for full detail). Pass the literal string all as the id to list bills across every location. Requires the p/r-bill-history permission on the location (company-wide for all). The response search block advertises the q_* filters available to the caller. To fetch the bills of a specific register session — including closed sessions — filter with q_register_session_id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Location id, or the string all for every location.

Query Params

page

integer

Page number (default 1).

limit

integer

Items per page (default 20).

no_paginate

integer

Set to 1 to return every matching bill without paging (row count is capped server-side).

order_by

string

Sort field, optionally with direction as field:asc or field:desc (default direction desc). Allowed fields: id, status, customer, location, total, number, created_at. Default is newest first.

q_number

string

Filter by bill number. Exact match on high-bill-volume companies, substring match otherwise.

q_type

string

Filter by bill type: sale, refund or void (plus layaway when the layaway setting is enabled and foc for restaurant companies).

q_status

string

Filter by bill status: settled, refunded, partially-refunded or voided (plus layaway-pending / layaway-paid when layaway is enabled).

q_payment_status

string

Filter by payment status: paid or payment-pending. Note payment-pending also matches partially-paid bills.

q_delivery_status

string

Filter by delivery status: pending, out-for-delivery or delivered.

q_created_at

string

Filter by created date range in the company timezone, format YYYY-MM-DD,YYYY-MM-DD (inclusive).

q_customer

string

Filter by customer name or mobile number.

q_po_number

string

Filter by PO number (exact match).

q_serial_number

string

Filter by a serial number sold on a bill line (exact match).

q_register_session_id

integer

Filter to bills booked in the given register session id — works for closed sessions, so this is how an app fetches the bills of a closed register session (get session ids from GET /locations/registers/sessions/location/{id}).

q_tags

string

Filter by tag name.

q_kot_number

string

Filter by KOT number (restaurant companies only, substring match).

Headers

X-Ewity-Store

string

required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated bill summaries.