Search invoices
Returns one page of invoices 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.Invoice.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/invoices/filter-paginated' \ -H 'Authorization: Bearer <access-token>' \ -H 'Content-Type: application/json' \ -d '{}'{ "currentPage": 0, "data": [ { "address1": "string", "address2": "string", "amount": 0, "city": "string", "companyIdentificationNumber": "string", "currency": "string", "customerId": 0, "customerName": "string", "dateOfAccountingPosting": "2019-08-24T14:15:22Z", "dateOfCreation": "2019-08-24T14:15:22Z", "dateOfTaxableEvent": "2019-08-24T14:15:22Z", "deliveryAddressId": 0, "deliveryNotes": "string", "distanceSaleExchangeCurrency": "string", "distanceSaleExchangeRate": 0, "distanceSaleTotalPrice": 0, "documentState": 0, "downPayment": 0, "dueDate": "2019-08-24T14:15:22Z", "exchangeRate": 0, "formNumber": "string", "handedOfForTransport": "2019-08-24T14:15:22Z", "id": 0, "internalNumber": 0, "invoiceSeries": 0, "isExported": true, "isExportedForTransport": true, "isPaid": "2019-08-24T14:15:22Z", "isPrinted": true, "isSent": "2019-08-24T14:15:22Z", "isShippingLabelPrinted": true, "mainCurrencyTotal": 0, "note": "string", "orderNumber": "string", "paymentType": "string", "paymentTypeId": 0, "totalPriceWoVat": 0, "transportType": "string", "transportTypeId": 0, "userName": "string", "vatAmountBasicRate": 0, "vatAmountReducedRate": 0, "vatAmountSuperReducedRate": 0, "vatBasisBasicRate": 0, "vatBasisExempt": 0, "vatBasisReducedRate": 0, "vatBasisSuperReducedRate": 0, "vatRateBasicRate": 0, "vatRateReducedRate": 0, "vatRateSuperReducedRate": 0, "vatRegistrationNumber": "string", "warehouseId": 0 } ], "hasNextPage": true, "hasPreviousPage": true, "pageSize": 0, "totalCount": 0, "totalPages": 0}