# Sample ledger

A React block (a whole screen) in [Beamline](https://beamline.io/)'s [Inventory](https://beamline.io/components/apps/inventory) app. Live demo: https://beamline.io/components/sample-ledger

Materials used in a record and the containers they came from, plus pooling. Subtracting a used amount writes a stock movement with its unit and the container's new balance; accepting a catalog update changes only the description; each container keeps its own balance and history, even when two hold the same material. An unknown balance or an unwritten amount is said, never treated as zero. Pooling reads as a small equation (each draw and what it leaves, adding up to the new container), happens all or nothing, and the result links to every parent.

## Use it for

- Recording what a piece of work used from which container, with a movement for every change.
- Combining several containers into one and keeping where it came from.

## Not for

- Shop stock counted by location ([stock-adjust](https://beamline.io/components/stock-adjust), [stock-count](https://beamline.io/components/stock-count)).
- Where containers are kept ([sample-storage](https://beamline.io/components/sample-storage)).

## Anatomy

- header: the product's mark, Materials; tabs Used in this record and Pool
- used: each material with its container and balance; amount used; Subtract, Subtracted with the movement, or why not; a catalog update with Accept; the opened container's movements with parents
- pool: material, new container name; each container with Include and the draw, or why it can't be drawn; the equation; Pool; the new container with links to its parents

## States

- use: to subtract, subtracting, subtracted, refused, balance unknown, amount not written; catalog update waiting, accepted
- pool: fewer than two, ready, pooling, refused (nothing changed), made
- container: unknown amount, another unit (can't be pooled)
- phone: the movements fold under the materials
- right to left: mirrors

## Keyboard

- Tab through each material, Subtract, Accept, the parents, the Pool tab's fields, each Include and draw, and Pool

## Motion

None of its own; the shared parts move.

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `containers` (required) | `Container[]` | — |  |
| `movements` (required) | `Movement[]` | — |  |
| `uses` (required) | `MaterialUse[]` | — | Materials used in the record this screen belongs to. |
| `onSubtract` | `((use: MaterialUse) => Promise<Movement>)` | — | Write a stock movement for a use's amount; resolve with the movement written. |
| `onAcceptCatalog` | `((use: MaterialUse) => Promise<void>)` | — | Take the catalog's description; nothing else changes. |
| `onPool` | `((request: PoolRequest) => Promise<PoolResult>)` | — | Pool all or nothing: resolve with the new container and every movement, or reject and nothing changed. |
| `defaultTab` | `"pool" \| "used"` | — |  |
| `defaultContainer` | `string` | — | The container whose movements show first. |
| `defaultDraws` | `Record<string, number>` | — | Draws already filled in on the Pool tab, by container id. |
| `defaultPoolName` | `string` | — |  |
| `product` | `string` | — |  |
| `className` | `string` | — | Classes on the documented visual root; no override by default. |
| `ref` | `Ref<HTMLDivElement>` | — | Receives the documented native target or imperative handle; omitted by default. |

## Built from

- [Avatar](https://beamline.io/components/avatar.md)
- [Button](https://beamline.io/components/button.md)
- [Checkbox](https://beamline.io/components/checkbox.md)
- [Dropdown menu](https://beamline.io/components/dropdown-menu.md)
- [Input](https://beamline.io/components/input.md)
- [Label](https://beamline.io/components/label.md)
- [Number field](https://beamline.io/components/number-field.md)
- [Select](https://beamline.io/components/select.md)
- [Spinner](https://beamline.io/components/spinner.md)
- [Tabs](https://beamline.io/components/tabs.md)

## Dependencies

`lucide-react`

## Import

```tsx
import { SampleLedger } from "@beamline/sample-ledger";
```

## Get it

Sample ledger is part of Beamline UI. Install the parts you need in your React app as compiled packages or editable source. [Get Beamline](https://beamline.io/checkout?pack=complete) · [Connect your agent](https://beamline.io/connect)

## More in Inventory

- [Stock count](https://beamline.io/components/stock-count): A shelf counted. Count: the products on it with counted units, not counted (an empty field that changes nothing) kept apart from a counted zero, expected…
- [Inventory counts](https://beamline.io/components/inventory-counts): Recurring stock counts from plan to shelf: a phone-first count of one occurrence where an untouched part reads not counted and a zero reads counted, none…
- [Goods receiving](https://beamline.io/components/goods-receiving): Goods received against purchase orders and invoices. Cards grouped by purchase order or invoice, each line once whichever way (a line keeps both sources…
- [Purchase order desk](https://beamline.io/components/purchase-order-desk): Purchase orders for stock from draft to closed. The list of orders with status (ready for review on warning, approved, ordered and partly received on…
- [Restock desk](https://beamline.io/components/restock-desk): Restocking from suppliers' own shops. Items low on stock (below the minimum on danger, at it on warning, unknown said) beside the chosen item with how…
- [Stock alerts](https://beamline.io/components/stock-alerts): Alerts on stock counts and expiry dates. Counts of alerts gone off (danger) and close (warning) in the header. A table: item and type, the rule in words…
- [Inventory finder](https://beamline.io/components/inventory-finder): Find stock and act on what's found. A rail of filters: name or SKU; folders with or without their subfolders (folders the person can't see said as not…
- [Item setup](https://beamline.io/components/item-setup): Setting items up for scanning and records. Barcodes: scanned codes waiting to be linked, each with its symbology, when and who; Look it up brings a…
- [Bulk item edit](https://beamline.io/components/bulk-item-edit): Many items corrected at once. Pick a folder, with its subfolders or not (fixed once anything is edited), up to a limit said. The items in a grid: name…
- [Kit builder](https://beamline.io/components/kit-builder): A kit (bundle) made of standalone products, and how many its parts' stock can make. Sell as a kit; the parts in one kit with units per kit, removable…
- [Serial allocation](https://beamline.io/components/serial-allocation): A receipt line's serial numbers. Serials generated from a first serial and how many (its digits counted up, padding kept; a first serial without digits…
- [Stock moves](https://beamline.io/components/stock-moves): Where stock went, and moving it. The ledger lists movements newest first: moves on info, stock added on success, stock taken out on warning; each with…
- [Scan station](https://beamline.io/components/scan-station): A warehouse scanner, phone-first. Home: one scan field that also takes typing (and says so when the scanner isn't connected), each code named as what it…
- [Pack station](https://beamline.io/components/pack-station): A packing bench. Scanner, scale and printer each said, on the warning tone when away. Find the shipment by scanning or typing its number (none found…
- [Shipment split](https://beamline.io/components/shipment-split): An order's lines split across shipments. A table of lines with what was ordered and a column per shipment (new ones marked); a line already shipped can't…
- [Route plan](https://beamline.io/components/route-plan): A day's delivery routes in the service's zone. The day at a glance: routes, routes without a driver (warning), stops running late (danger), stops done…
- [Job materials](https://beamline.io/components/job-materials): Materials sent out to jobs and pick lists. Jobs: the list (draft, active on info, completed on success) beside the chosen job with its site, dates (the…
- [Service tasks](https://beamline.io/components/service-tasks): A fleet shop's maintenance setup. Tasks: active and archived, searchable, main tasks and their subtasks told apart in words, archiving refused while…
- [Owner records](https://beamline.io/components/owner-records): Who a customer is and what they own, at the front desk. New customer: name, phone and email checked as typed against existing customers; each likely…
- [Sample storage](https://beamline.io/components/sample-storage): Where physical items are kept (rooms, freezers, shelves, racks, boxes) and acting on several at once. The storage tree is browsed apart from moving: Move…

Part of [Beamline UI: polished, editable React components and complete screens for custom applications](https://beamline.io/). [Build your own style from any look; tokens, fonts, radii, motion; not only colours](https://beamline.io/docs/customize).
