Submit Top Count

Closes and submits a top count.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Executing this action commits all changes to inventory. Any child sub-counts that are still open will also be closed.

Supplying stock_period_id assigns the submitted count as the closing count of that stock period. It requires full_count: true. The period is validated before the count is submitted, so a rejection leaves the count in progress. A period that already has a closing count is rejected; change a period's closing count from the Stock Periods screen in the web app instead. The response then carries stock_period_assigned: true when the count is now the period's closing count, false when the count was saved but the assignment did not land.

Path Params
string
required

An outlet's ID.

string
required

A top count's ID.

Body Params
date-time
string
boolean
Defaults to false

Optional. Marks the count as a full count. This is an informative flag only: it does not change any stock values, calculations, or other behaviour, except when stock_period_id is supplied, in which case it must be true.

string | null

Optional. The ID of an open stock period. When supplied together with full_count: true, the submitted count becomes that period's closing count. The period is validated before the count is submitted, so a rejected period leaves the count in progress; a period that already has a closing count is rejected. Write-only: the outcome is reported in stock_period_assigned.

Responses

202

Accepted: the stock queue did not finish within the request. The count, and any period assignment requested with stock_period_id, land when the worker completes. The body carries no stock_period_assigned.

400

The count cannot be submitted, or the supplied stock_period_id cannot take this count as its closing count.

403

User lacks permission to submit the count, or stock periods are not enabled for the outlet.

404

Count event not found.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json