Skip to main content

List Inventory Debt Claims

GET 
/api/inventory/debt/claims

List inventory-debt claims - units that left a warehouse without stock behind them.

Required scope: inventory:read

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

Each claim is repaid automatically by subsequent receipts, oldest claim first, and the results are ordered that way by default.

Authentication: Requires Bearer token.

quantity is what was originally owed, outstanding_quantity what remains, and settled_quantity the difference.

posted_clearing_amount and relieved_clearing_amount track the money side, which reconciles 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.

estimated_unit_cost is provisional. It is restated to the actual receipt cost when the claim settles, with the difference posted as a dated variance.

Use filter[age_bucket] rather than a date range when triaging: stale claims are where the exposure accumulates.

DEFAULT STATUS: when no filter[status] is supplied the list returns OUTSTANDING claims only. Pass filter[status]=all to include settled and cancelled claims, or a specific value (outstanding | settled | cancelled). Omitting filter[status] is the ordinary case, so it deliberately means 'still owed' rather than 'every status' - an unfiltered call returns work to be done, not history.

SORTS: incurred_at, outstanding_quantity, quantity, estimated_unit_cost, posted_clearing_amount, relieved_clearing_amount, status, source, created_at, sku, warehouse_name, age_days. Prefix with '-' to reverse. Note age_days is the inverse of incurred_at (the oldest claim has the greatest age).

ADVANCED FILTERS: sku, product_name, warehouse_name, order_number, reason, status, source, quantity, outstanding_quantity, estimated_unit_cost, posted_clearing_amount, incurred_at - each with the standard operator suffixes.

Request​

Responses​

OK

Response Headers
    Content-Type