Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Headers

Signature-Token
string
required

A signing token for this call, from POST /api/v1/access/signatures. Each token works once.

Path Parameters

period
string
required

The period's first day, as YYYY-MM-DD.

Body

application/json

Why a locked inventory period is reopened. The period is named in the path.

reason
string
required

Why the period is reopened, up to 500 characters. It is saved with the period.

Maximum string length: 500

Response

StockPeriodResource

data
StockPeriodResource · object
required

An inventory period: one month of the fiscal calendar, with its status, its valuation snapshot once closed and what still keeps it open.