Added

2026-05 New Sales Search Filters and Sorting

The GET /api/2026-01/search endpoint now supports additional filter parameters and sort fields when searching for sales (type=sales).

New Filter Parameters

ParameterTypeDescription
register_idUUIDFilter by register.
payment_type_idUUIDFilter by payment type used in the sale.
product_idUUIDFilter by product included in the sale.
sale_totalnumberFilter by exact sale total amount.
customer_namestringFilter by customer name. Supports prefix matching.
time_fromstringLower time-of-day limit (local time) for the sale. Format: H:MM or HH:MM (e.g. 09:00). Use with timezone. When provided without time_to, defaults time_to to 24:00.
time_tostringUpper time-of-day limit (local time) for the sale. Format: H:MM or HH:MM (e.g. 17:00). Use with timezone. When provided without time_from, defaults time_from to 00:00.
timezonestringIANA timezone identifier used to interpret time_from and time_to (e.g. America/Toronto). Defaults to UTC.

register_id, payment_type_id, and product_id can be used multiple times to search for objects with different values.

New Sort Fields

The following fields can now be passed to the order_by parameter when searching for sales:

FieldsTypeDescription
customer_namestringSort by the name of the customer on the sale.
user_namestringSort by the name of the user who processed the sale.
payment_type_namestringSort by the name of the payment type used.
sale_totalnumberSort by the total amount of the sale.

🔒 Requires: sales:read scope