Skip to main content

Create Catch-Up Stock Takes

POST 
/api/inventory/debt/claims/create-stock-take

Raise DRAFT catch-up stock takes for the outstanding units on the selected inventory debt claims.

Required scope: inventory:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Use this for debt no incoming receipt will ever repay - a receiving error, or stock that was on the shelf all along. The count is POSITIVE: it brings the owed units into stock so the debt can be repaid from them. The claim's own movement already took those units out, so counting down again would deduct them twice.

This does NOT settle anything by itself. Each stock take is created as a draft; finalising it lands the stock and the ordinary settlement then repays the claims from it, exactly as a real receipt would. One settlement path, not two.

A stock take cannot span warehouses, so one call creates one stock take per warehouse in the selection. Call Preview Catch-Up Stock Takes first to see that fan-out before committing.

Request body:

  • claim_ids (array of integer, required, 1-200) - the claims to count in

Response 200:

  • data.stock_takes[] (array) - the drafts created
    • id (integer)
    • warehouse_id (integer, nullable)
    • warehouse_name (string, nullable)
    • item_count (integer) - product lines on the draft
    • status (string) - draft
  • data.message (string) - human summary

Response 422 when none of the selected claims are outstanding.

Request​

Responses​

OK

Response Headers
    Content-Type