Materials
A material is a purchased physical input — something you buy from a vendor, hold in inventory, and consume when you make a product. Raw plastic, a fragrance oil, a cardboard box: if you order it in and it gets used up rather than sold, it's a material.
Materials are the entries in the materials inventory ledger and the components on the left-hand side of a bill of materials.
Key fields
| Field | Meaning |
|---|---|
materialCode | Your identifier for the material, unique within the organization |
name | Display name |
materialTypeId | The material type that classifies it (required) |
notes | Free-form notes |
isActive | Whether the material is available for new work |
Relationships
- Classified by exactly one material type.
- Appears as a component in one or more bills of materials.
- Bought through purchase orders targeting materials.
- Consumed by work orders and production orders as a BOM-exploded input.
- Tracked on hand and on order in the materials inventory ledger.
Because so many records point at a material, an in-use material can't be deleted — set
isActive to false to retire it.
See also
Manage materials through the REST API or the MCP server.