Close Stock Period

Closes a stock period.

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

Requires the stock period close permission.

For a full explanation of stock periods, see Managing Stock Periods.

Closing stamps the period's end date from the closing count. When closing_count_id is supplied and the close fails validation, the count is not left attached to the period.

Sales that arrive after the close but belong inside the window cannot be applied, so make sure POS data has synced before closing.

Path Params
string
required

The ID of the outlet.

string
required

The ID of the stock period.

Body Params
string

ID of the finalised full count to close the period with.

Responses

400

The period is already closed, has no closing count, the count is not valid for this period, or an earlier period is still open.

403

The library does not have the stock periods module enabled, or the user lacks the required permission.

404

Outlet or stock period 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