Get Inventory Valuation
GET/api/reporting/inventory-valuation
Returns the inventory valuation report summary grouped by warehouse/category.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token
Accounting alignment (lock dates). The response also carries an accounting_alignment object stating how much of this valuation the general ledger has not recognised yet. An accounting lock date cannot stop stock from moving — it only pushes the posting to the first open day — so until the GL catches up this report is right to be worth more than the inventory control account says, and the difference is not a discrepancy to chase. Fields: as_of_date (the valuation date the figures are stated at), displaced_value (value whose stock has already moved but whose posting a lock date pushed to a later day), total_valuation (this report's total), ledger_recognized_valuation (total_valuation − displaced_value — the figure that ties to the general ledger today) and has_displacement (false when nothing is held back, in which case displaced_value is 0 and the two totals are identical).
INVENTORY DEBT: totals and every group also carry inventory_debt (units shipped with no stock behind them and not yet settled) and inventory_debt_valuation (the Inventory Debt Clearing balance still carried - posted less relieved). Reported as their own figures rather than folded into on-hand: debt units consumed no cost layer, so on-hand quantity and valuation are unchanged by them.
A valuation for a past date is not necessarily reproducible: cost revisions can carry an effective date inside a period that has already been reported. retroactive_restatements discloses how many such revisions were recorded AFTER the as-of date and what they moved the figure by, and computed_at stamps when this response was produced — take every figure you are reconciling from a single run.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.