Search

getSalesTotalsByEmployeeAndMonth

Get recent monthly sales totals by employee.

This a concise data set that suits best for displaying a graph. To get a full sales report, see getSalesReport.

See also getSalesTotalsByEmployeeAndDay, getSalesTotalsByWarehouseAndDay, and getSalesTotalsByWarehouseAndMonth.

Input parameters

Parameter nameDescriptionPossible valueRequired
numberOfGroups

Number of employees to retrieve. By default, API returns 50 employees (top employees 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 numberOfPeriods = 3 will return data for the last 3 days, including current month.

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
warehouseIDLocation IDinteger

Response

Field nameTypeDescription
totalDoubleTotal sales. In US, this is net sales total. In other countries, this is the sales total with VAT.
yearInteger
monthInteger
employeeIDInteger