Get recent monthly sales by store (location).
This a concise data set that suits best for displaying a graph. To get a full sales report, see getSalesReport.
See also getSalesTotalsByEmployeeAndDay, getSalesTotalsByEmployeeAndMonth, and getSalesTotalsByWarehouseAndDay.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| numberOfGroups | Number of warehouses (locations) to retrieve. By default, API returns 50 locations (top locations by total sales during the selected period). 50 is also the largest number that can be requested, but this limit can be changed with a configuration parameter. |
integer | |
| numberOfPeriods | Number of months. Specifying By default, API returns last 6 months. 6 is also the largest number that can be requested, but this limit can be changed with a configuration parameter. |
integer |
| Field name | Type | Description |
|---|---|---|
| total | number | Total sales. In US, this is net sales total. In other countries, this is the sales total with VAT. |
| year | integer | |
| month | integer | |
| warehouseID | integer |