List sales
phppos_list_salesList or search completed sales, by date range, customer (id or email) or location. verbosity: minimal (headline fields), medium (adds customer, totals, profit, location - the default here) or full (every line item, payment and tax). Suspended sales (layaways, estimates) are fetched with suspended_type. GET /sales.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Rows per page, 1-1000 (default 25). | |
| offset | No | Rows to skip (default 0). Pass the previous reply's next_offset (paging.next_offset for a report). | |
| end_date | No | Only sales on or before this date or date-time. | |
| verbosity | No | minimal, medium (default) or full. | |
| start_date | No | Only sales on or after this date or date-time (yyyy-mm-dd or yyyy-mm-dd hh:mm:ss). | |
| customer_id | No | Only this customer's sales. | |
| location_id | No | Only sales at this location id - see phppos_list_locations. | |
| email_address | No | Look the customer up by email address and return their sales. | |
| suspended_type | No | Fetch suspended sales instead of completed ones: a comma-separated list of layaway, estimate or a sale type name. |