Materials
The technical specification of a material, without size, stock or supply policy.
- API name:
materials - Domain: Catalog
- Modules: Sales, Stores, Finances, Inventory, Manufacturing, Purchasing, Logistics, Master data
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text I18n | ||
| Code | code | Text | Short internal code for the material grade. Stored in uppercase and unique within the organization. | |
| Density | density | Decimal | Material grade density for mass/volume conversion on lines and costing. | |
| Density unit | densityunit | Constant | Unit for the density measurement (e.g. g/cm³). | |
| Characteristics | characteristics | Characteristic | Characteristics | Technical grade properties (standard, alloy, finish) without piece dimensions. | |
| Links | links | Link | Links | ||
| Image | image | Image | ||
| Tags | tagIds | Tags | ||
| Description | description | Text Area I18n | ||
| Data | data | Data | ||
| External identifiers | identifiers | External identifier | External identifiers | Remote system keys and optional id types. One value per system and type pair on this record. | |
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Published by | publishedBy | User | ||
| Published at | publishedAt | Date and Time | ||
| Disabled by | disabledBy | User | ||
| Disabled at | disabledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event materials.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new material. | App · API · MCP · CLI |
| Edit | update | Save changes to this material. | App · API · MCP · CLI |
| Disable | disable | Turn this material off for new use. Existing references stay. Enable it again to use it. | App · API · MCP · CLI |
| Enable | undisable | Turn this material back on for new use. | App · API · MCP · CLI |
| Publish | publish | Make this material available for use. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this material. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · CLI |
| Unblock | unblock | Allow edits and deletion of this material again. | App · API · CLI |
| Archive | archive | Retire this material from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · API · MCP · CLI |
| Restore | unarchive | Return this material to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this material and the data that belongs with it. This cannot be undone. | App · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.