Get Inventory Debt Claim
GET/api/inventory/debt/claims/:inventoryDebtClaim
Get a single inventory-debt claim with its settlement history.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
A claim records units that left a warehouse without stock behind them, and is repaid automatically by subsequent receipts, oldest claim first.
Authentication: Requires Bearer token.
quantity is what was originally owed; outstanding_quantity is what remains; settled_quantity is the difference.
posted_clearing_amount and relieved_clearing_amount track the money side, which is reconciled independently of quantity: a claim settled in slices rounds per settlement, so unrelieved_clearing_amount - not outstanding_quantity x estimated_unit_cost - is the authoritative balance still carried.
settlements lists each repayment slice with the layer it drew from, the actual unit cost, and the variance recognised against the original estimate.
Returns 404 if the claim does not exist.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.