Project earmarks
A quantity of inventory set aside for a project or a project demand.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Project | projectId | Reference | Yes | |
| Quantity | quantity | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Consumed quantity | quantityConsumed | Quantity | Yes | Quantity in the catalog unit after any unit conversion on the line. |
| Item | productitemId | Reference | ||
| Item | customitemId | Reference | ||
| Demand | projectdemandId | Reference | ||
| Catalog | catalog | Constant | Yes | Fixed option from the allowed set for this field. |
| Unit | catalogunit | Unit | ||
| Identifier | inventoryidentifierId | Reference | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
Project projectId | Projects | reference |
Demand projectdemandId | Project demands | reference |
Identifier inventoryidentifierId | Inventory identifiers | reference |
Actions
What you can do with a record. Every action also sends the webhook event inventoryearmarks.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new earmark. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this earmark. | App · WebMCP · API · CLI |
| Cancel | cancel | Reverse the posted effect of this earmark. | App · WebMCP · API · CLI |
| Delete | delete | Delete this earmark and the data that belongs with it. This cannot be undone. | App · WebMCP · API · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.