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

Period boundaries

Each outlet's period runs from just after its opening boundary up to and including its closing boundary.

• The opening boundary is the finished timestamp of the full count the outlet closed on the start date (the latest, if it closed several), or the start_datetime you passed, unchanged, if it closed none.
• The closing boundary follows the same rule against the end date and end_datetime.

Calendar days are resolved in the library's timezone, not UTC, so a count finished at 23:30 UTC can belong to the following day. The offset you send on start_datetime does not change which day a moment falls on.

So for an outlet that counted at 14:00 on the start date, the movements booked before 14:00 are left out, because they belong to the previous period. opening_value_has_full_count and closing_value_has_full_count tell you which rows a count applied to.

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.