Retrieve invoices to which rounding was applied.
This API call may be useful for a report which needs to summarize and show amount of applied rounding separately from sales revenue.
Rounding can be configured in back office, Settings → Configuration (all invoice totals to be rounded to the nearest 5 cents, 10 cents or full currency units) or in POS (receipt total to be rounded only if customer pays in cash).
This report only returns confirmed Invoices, Invoice-Waybills, Receipts and Credit Invoices — ie., sales documents that incur sales revenue.
API call getSalesDocuments can be used to retrieve full data about documents.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| dateFrom | Date range filter. | ISO date (yyyy-mm-dd) | yes |
| dateTo | Date range filter. | ISO date (yyyy-mm-dd) | yes |
| warehouseID | Filter by warehouse ID. | integer | |
| pointOfSaleID | Filter by point of sale ID. | integer | |
| recordsOnPage | Number of records API should return. By default 20, at most 500. | integer | |
| pageNo | API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". | integer |
| Field name | Type | Description |
|---|---|---|
| invoiceID | integer | ID of sales document. |
| invoiceNumber | string | Invoice number. |
| date | string | Format: yyyy-mm-dd. eg. 2010-01-29 |
| amountOfRounding | number | Rounding amount. |