Consumables — User Guide
Module: Fixed Equipment
Audience: IT administrators, warehouse staff, operations managers
Version: 1.0.0
Last updated: 2026-07-22
Overview
Consumables is where you track quantity-based supplies — toner, paper, cables, and similar items issued in multiples. Each consumable record has a total quantity, a minimum quantity warning level, and an available count that decreases when units are checked out to staff.
Use this screen for stock you hand out and may or may not expect back. For peripherals you routinely loan and return, use Accessories. For parts installed inside tagged equipment, use Components.
Prerequisites
| Task | Permission |
|---|---|
| View the consumable list and detail ledger | Fixed Equipment → Consumables → View (or View own) |
| Add consumables, check-out from list or detail | Fixed Equipment → Consumables → Create |
| Edit a consumable | Fixed Equipment → Consumables → Edit |
| Delete a consumable | Fixed Equipment → Consumables → Delete |
Setup before adding consumables:
- Settings → Categories — create at least one category with type Consumable.
- Settings → Manufacturers — optional vendor list for filtering.
- Settings → Locations — optional default storage location.
Step-by-step: View and filter consumables
- Go to Fixed Equipment → Consumables.
- Use the filter dropdowns:
- Manufacturer
- Category
- Location
- Review the table columns: name, category, model number, manufacturer, location, total quantity, minimum quantity, available, and purchase cost.
Expected result: Active consumables with availability at a glance. Names and available counts appear in red when stock falls below the minimum quantity.
Step-by-step: Add a consumable
- On the Consumables page, click Add.
- Complete the form:
- Consumable name (required)
- Category (required — consumable-type category)
- Manufacturer, Location
- Model number, Item number, Order number
- Purchase cost, Purchase date
- Quantity (required — total units on hand)
- Minimum quantity — warning threshold for low stock
- For sell + Selling price (optional commerce flag)
- Upload image (optional)
- Click Submit.
Expected result: The consumable appears in the list with available count equal to the quantity entered.
Step-by-step: Edit a consumable
- In the list, open the row menu and click Edit.
- Update fields. To reduce quantity, you cannot go below the number of units currently checked out.
- Click Submit.
Tip: If you see a quantity error, open the consumable View page and check in outstanding units first.
Step-by-step: Check out a consumable (from list)
Assign one unit to a staff member directly from the main list.
Before you start: At least one unit must be available.
- In the last column, click Check-out on the row.
- Confirm the consumable name.
- Select a Staff member.
- Add Notes if needed.
- Click Check-out.
Expected result: Available count decreases by one. The checkout is recorded on the consumable detail page.
Note: List check-out assigns to staff only. To review who has units, open View on the row.
Step-by-step: Open consumable details (checkout ledger)
- In the list, click View on a row.
- The detail page lists all units currently checked out: assignee, notes, checkout date.
- To check out another unit, click Check-out in the page header (when units remain available).
- To return a unit, click Check-in on a ledger row, set the check-in date and notes, and submit.
Expected result: Returned units increase the available count on the main list.
Step-by-step: Bulk upload
- On the Consumables page, click Bulk upload.
- Download the template, fill in rows, and upload the spreadsheet.
Validate that categories and manufacturers exist in Settings before importing.
Field reference
| Field | Required | Description |
|---|---|---|
| Consumable name | Yes | Display name for the item type |
| Category | Yes | Must be a consumable-type category |
| Quantity | Yes | Total units in inventory |
| Minimum quantity | No | Low-stock warning; UI highlights when available falls below |
| Manufacturer | No | Used for list filtering |
| Location | No | Default storage location |
| Model number | No | Manufacturer part or internal SKU |
| Item number | No | Internal item reference |
| Purchase cost | No | Unit cost in base currency |
| Purchase date | No | When stock was acquired |
| Order number | No | PO or invoice reference |
| For sell | No | Marks item for commerce flows |
| Image | No | Thumbnail shown in list |
Common issues
| Symptom | Likely cause | What to do |
|---|---|---|
| Check-out button disabled | No available units | Check in units from the detail page |
| Cannot reduce quantity on edit | Checked-out units exceed new total | Check in outstanding units first |
| Red available count | Stock below minimum quantity | Reorder or adjust minimum threshold |
| No Add button | Missing Create permission | Ask admin to grant Consumables → Create |
| Bulk delete unavailable | Bulk delete uses Components delete permission | Use row delete or request Components → Delete |
| Check-in only on detail page | By design — list has checkout only | Open View to check in |
Related features
- Locations — view consumables stored at a specific site
- Accessories — loaned peripherals expected back
- Components — parts installed into parent assets
- Settings → Categories — define consumable categories