Skip to content

Consumables Design

Ed Mozley edited this page Nov 21, 2026 · 4 revisions

📦 Consumables - design

Status: built in 5.8.0 - see Consumables and the Developer Guide. Built as designed, all three slices; the issue/receive capabilities in the permissions table below were not needed (Ed: anybody with access to Assets issues and receives, so it is write access to Assets). A Consumables screen in Assets for the things a service desk counts rather than tracks one by one - toner, fusers, rollers, paper, mice, keyboards, RAM, drives - with stock levels, issuing against tickets, stock takes and a full audit trail.

Asked for by email by a supporter of the project, who runs printer parts and spares from a spreadsheet today and finds out something has run out only when the shelf is empty.


Asset or consumable?

One rule, shown on screen: if you would write down its serial number, it is an asset; if you would count it, it is a consumable.

  • Laptops, switches, access points, small printers: assets, as now. A spare in the cupboard is an asset with an In stock status - nothing new needed.
  • Toner, fusers, rollers, belts, paper, mice, keyboards, RAM, drives: consumables - a quantity on a shelf.

What it does

Slice 1 - stock and issuing

  • Items, grouped by type. Each type has its own fields from the same field-set engine asset types use (asset_field_sets) - "properties based on the item type". An item has a name, a unit (each, box, ream...), a minimum level, a reorder point, a preferred supplier (People → Suppliers), and optionally the asset models it fits (this toner → these printers).
  • Stock is a ledger, never a typed number. Nobody edits "quantity". Every change is a movement:
Movement Who Records
Received Anyone with Assets quantity, supplier, invoice number and date, unit cost
Issued Anyone with Assets quantity, the person it went to, the ticket, who issued it
Returned Anyone with Assets quantity, from whom, the original issue
Adjusted Administrators, or a role given it (below) quantity up or down, a reason (damaged, found, written off...)
Counted from a stock take (below) expected, counted, the difference
  • Issue from a ticket. On a ticket, Issue consumables: pick the item (items that fit the ticket's linked asset first), quantity, recipient (the requester by default). It shows in the ticket's activity and on the person's record.

Slice 2 - running low, and reordering

  • An item at or below its reorder point is flagged in the list, raises a bell notification for the people you choose, and appears on a Watchtower card (the number opening the list filtered to Low stock, as every Watchtower number does).
  • Reorder opens the requisition form you design in Forms, filled in with the item, supplier and a suggested quantity (up to the minimum level plus whatever you set), and it goes through the request approvals you already have.

Slice 3 - stock takes and the differences report

  • Stock take. Start one for the store; walk the shelves and enter what is actually there. Each line keeps expected (what the ledger said at that moment), counted, the difference and its value at the time. Expecting 10 toners in the basement and finding 8 records -2, and -2 × the toner's cost.
  • Finishing the stock take posts each difference as a Counted movement, so the stock is right again - and the difference stays on record for ever.
  • Differences report: by stock take, by item and over time - a chart of units and cash value, losses and gains shown separately (a gain of 3 must not hide a loss of 3), with the items that go missing most often at the top.

Later (only if wanted)

  • More than one store per company - a store per site (Locations), and transfers between them.
  • Spend by item, supplier or cost centre.

Everything is audited

  • The ledger is append-only. A movement is never edited or deleted. A mistake is put right by a reversing movement that points at the one it cancels, with a reason - so the history shows both the mistake and the correction.
  • Item changes (name, levels, supplier, cost, type, fields) are recorded field by field - who, when, old value, new value - as asset_history does for assets.
  • Every movement carries who, when, and from where (screen, ticket, API, workflow).
  • A check you can run: the stock on hand must equal the sum of the ledger, item by item. Database Verification (or a scheduled check) says so if they ever disagree.
  • Value never changes after the fact: each movement stores the unit cost it was valued at, so last year's report is still last year's numbers after a price change.

Not boxed in: one store now, more later

Every movement and every stock figure belongs to a store from day one (consumable_stores). Each company gets one store, made automatically, and the screens do not mention stores while there is only one. Allowing a second store later is screens and a transfer movement - not a data migration, because nothing ever assumed "one company = one stock figure".

Sketch of the tables

Table Holds
consumable_types Types, with a field set (asset_field_sets)
consumable_items Items: type, unit, minimum, reorder point, supplier, current unit cost, company
consumable_item_fits Which asset models an item fits
consumable_stores Stores - one per company to start
consumable_stock On hand per item per store (kept in step with the ledger, in the same transaction)
consumable_movements The ledger: item, store, kind, signed quantity, unit cost, ticket, person, supplier, invoice, reason, reverses_id, analyst, source, when
consumable_counts / consumable_count_lines Stock takes, and per item: expected, counted, difference, unit cost, value
consumable_audit Field-by-field changes to items and types

Decided

  • 2026-11-21 (Ed): a Consumables screen in Assets, not a new module.
  • 2026-11-21 (Ed): one store per company to start, as long as it does not box us in - hence a store on every row from day one (above).
  • 2026-11-21 (Ed): anyone with access to Assets can issue and receive stock; administrators make adjustments.
  • 2026-11-21 (Ed): EVERYTHING heavily audited.
  • 2026-11-21 (Ed): stock takes, with the differences recorded at that point (expected 10, found 8: -2), and a report that visualises the differences and their cash value.
  • 2026-11-21: value at the latest receipt's price, stored on each movement (not average cost).
  • 2026-11-21 (Ed): who may finish a stock take is configurable in System → Roles - a capability, administrators-only until granted (above).
  • 2026-11-21 (Ed): issuing does not need a ticket - optional, encouraged; the report shows issues without one.
  • 2026-11-21 (Ed): deliveries - one order with several items, an optional order number and documents attached to it ("if you have 10 mice, 10 toners and 5 keyboards from one company then that's just one order number with 1 document"); in 5.8.0.
  • 2026-11-21 (Ed): stock cannot go below zero - an issue bigger than what is on hand is refused ("only 3 in stock"); the fix is a receipt or a stock take.

Permissions - System → Roles

Configurable in System → Roles, in the two shapes Roles already has (includes/capabilities.php, includes/rbac.php):

Capability Kind Out of the box
assets.consumables_adjust - adjust stock, and finish a stock take (which posts its differences) A power: deny by default Administrators only; grant it to a role to let others
assets.consumables_issue - issue and return Everyday work (analystMayAct()) Anyone with Assets, until Assets → Settings restricts it to a role
assets.consumables_receive - receive deliveries Everyday work Anyone with Assets, until restricted
assets.consumables - items, types, levels, the reorder form Settings Administrators, or a role with it

Recording counts in a stock take needs only Assets access; finishing it needs assets.consumables_adjust.

Related pages

FreeITSM

Getting Started

Modules

Multi-tenancy (planned)

Responses to feedback

Blue sky thinking

Bugs resolved

Pull requests

Links

Clone this wiki locally