Requires the Sales module or the Inventory module, and Insights Hub access for the user.

For a per-outlet breakdown, use Get Inventory Movement and Get Sales Performance.

Period boundaries

This report combines inventory figures and sales figures, which follow different period rules:

• Inventory runs per outlet from just after its opening boundary up to and including its closing boundary. A boundary is the finished timestamp of the full count the outlet closed on that date (the latest, if it closed several), or the start_datetime or end_datetime you passed if it closed none.
• Sales are counted in whole days, so a day on which an outlet closed a full count goes wholly to one period. count_moment decides which:
  • after_closing (default): the count is taken after the day's last sale. A full count on the start date leaves that whole day's sales out, as they belong to the previous period. The end day is always included.
  • before_opening: the count is taken before the day's first sale. The start day is always included. A full count on the end date leaves that whole day's sales out, as they belong to the next period.

theoretical_cost covers the same days as net_sales. actual_cost adds waste and negative variance, which follow the inventory boundaries.

Calendar days are resolved in local time, not UTC. When the report covers a single outlet, that outlet's timezone is used, or the library's if the outlet has none set. Otherwise the library's timezone is used. The offset you send on start_datetime does not change which day a moment falls on.

So with after_closing, for an outlet that counted at 14:00 on the start date, sold_stock_value leaves out only the movements booked before 14:00, while net_sales leaves out the entire day. With before_opening, for an outlet that counted at 08:00 on the end date, the inventory figures stop at 08:00, while net_sales leaves out the entire end day.

Signs

The response mixes two sign conventions, so adding the fields up as they are double-counts what left the outlet:

• sold_stock_value, created_out_stock_value, transfers_out_value, shipped_out_stock_value and wasted_stock_value are negative, because that stock left the outlet.
• positive_variance_value and negative_variance_value are both positive, even though a negative variance is a loss. Use net_variance_value for the signed figure.