Skip to main content
Version: v1.0.0(int)

E101: Get materials inventory summary

GET /api/materials-inventory/summary

Returns net on-hand and on-order quantities per material and location, computed from the ledger. Triggered from the Materials Inventory page.

Authentication​

Standard tenant route. Requires Authorization: Bearer <firebase-id-token> and X-Org-Id: <org-id>. Access: Member. Also reachable with an org-scoped PAT.

Request​

No body. Optional filters narrow the rollup:

  • ?materialId= — one material.
  • ?locationId= — one location.

Response — 200 OK​

{
  "data": [
    { "materialId": "uuid", "locationId": "uuid", "onHand": "950", "onOrder": "100" }
  ]
}

onHand nets RECEIVE / ADJUST against CONSUME / DISPOSE / TRANSFER (and the matching reversals); onOrder nets ORDER against RECEIVE. Numeric values arrive as strings.

Errors​

Standard envelope only.

Workflow​

Calls W101 Get materials inventory summary.