Search POS receipts
Returns one page of POS receipts matching the filter. Body is a `PaginationRequest` — see the *Filtering & pagination* concept in the developer docs. Sortable and limitable fields depend on the instance's data-grid view. Requires `Permissions.PosReceipt.View`.
BearerAuthorizationBearer <token>OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.
application/json- body
filter?Endpoint-specific filter. Every field is optional; the ones you set are combined with AND.
limitFields?array<string>|Names of the fields to return; omit it for all of them. Which fields exist depends on the instance's data-grid view.
orderBy?array<string>|Sort order, one entry per level, each written as Field or Field desc. Which fields can be sorted on depends on the instance's data-grid view.
pageNumber?integer1-based page to return. 0 and 1 both mean the first page.
int32pageSize?integerRows per page. Defaults to every matching row, and -1 asks for every row explicitly.
int32application/json- response
currentPage?integer1-based number of the page in this response.
int32data?array<>The rows of this page, shaped by the request's limitFields.
hasNextPage?booleanTrue when a page follows this one.
hasPreviousPage?booleanTrue when a page precedes this one.
pageSize?integerRows per page actually applied, which is 10 when the request asked for a non-positive size.
int32totalCount?integerNumber of rows matching the filter across every page.
int32totalPages?integerNumber of pages the whole result set spans at this page size.
int32curl -X POST 'https://<your-instance>/api/documents/pos/receipts/filter-paginated' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{}'{ "currentPage": 0, "data": [ { "amountTotal": 0, "branchId": 0, "branchName": "string", "customerId": 0, "customerName": "string", "customersCardBarcode": "string", "dateOfPurchase": "2019-08-24T14:15:22Z", "foreignCurrencyCode": "str", "foreignCurrencyTotalPrice": 0, "hasA4BeenPrinted": true, "headerInternalId": 0, "internalNumber": 0, "invoiceNumber": 0, "note": "string", "orderCustomerFormNumber": "string", "orderInternetFormNumber": "string", "paidAsDownPayment": 0, "paidCashOnDelivery": 0, "paidInAdvance": 0, "paidInCash": 0, "paidOnEshop": 0, "paidWithAnonCredit": 0, "paidWithConsumerCredit": 0, "paidWithCredit": 0, "paidWithCreditCard": 0, "paidWithFoodStamps": 0, "paidWithForeignCreditCard": 0, "paidWithVouchers": 0, "posId": 0, "posName": "string", "posNumber": "string", "totalWarehousePrice": 0, "userFullName": "string", "warehouse": "string" } ], "hasNextPage": true, "hasPreviousPage": true, "pageSize": 0, "totalCount": 0, "totalPages": 0}