Skip to main content

Get Fulfillment Debt Summary

GET 
/api/inventory/fulfillment-debt-report/summary

Returns aggregated summary totals for the fulfillment debt report header cards. The headline totals count OUTSTANDING debt only; covered_lines counts the additional lines whose debt is fully reserved against incoming inventory and will settle automatically. Authentication: Requires Bearer token.

Required scope: inventory:read

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

The summary reports BOTH halves of the debt. total_debt_* are the legacy sales-channel lines; claims is the inventory-debt ledger; combined_debt_lines and combined_debt_quantity are the two added together. clearing_balance is money (posted minus relieved), not quantity x estimate: the two diverge once a claim settles in slices, and it is the money figure that has to agree with the Inventory Debt Clearing account. claims.has_any_claims says whether this tenant has ever raised a claim in any status, which is distinct from having one outstanding now. Note that not every combined_* field is a sum: combined_debt_lines and combined_debt_quantity add the two halves, but combined_affected_products and combined_affected_warehouses are a DISTINCT count across both halves, because a product can owe on a claim and on a channel line at the same time and is one affected product either way. Do not add the per-half affected_products values together, and do not take the larger of them — both answers are wrong.

Request​

Responses​

OK

Response Headers
    Content-Type