Project deliverables
A product delivered by a project, defined by a catalog item, a preferred bill of materials, and a validity period.
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 | |
| Position | rank | Order rank | Yes | |
| Name | label | Text | ||
| Quantity | quantity | Quantity | Quantity in the catalog unit after any unit conversion on the line. | |
| Catalog | catalog | Constant | Yes | Fixed option from the allowed set for this field. |
| Item | productitemId | Reference | ||
| Item | customitemId | Reference | ||
| Bill of materials | billofmaterialId | Reference | ||
| Product revision | productrevisionId | Reference | ||
| Valid from | dateFrom | Date | First calendar date this record applies. | |
| Valid to | dateTo | Date | Last calendar date this record applies, if any. | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Data | data | Data | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Confirmed by | confirmedBy | User | ||
| Confirmed at | confirmedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Retired by | retiredBy | User | ||
| Retired at | retiredAt | 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 |
|---|---|---|
Project projectId | Projects | owned by |
Bill of materials billofmaterialId | Bills of materials | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event projectdeliverables.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new deliverable. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this deliverable. | App · API · MCP · CLI |
| Issue | confirm | Create a manufacturing order to cover the quantity at the selected site. | App · API · MCP · CLI |
| Retire | retire | Take this project item out of use. You can restore it later. | App · API · CLI |
| Restore | unretire | Put this project item back in use. | App · API · CLI |
| Delete | delete | Delete this deliverable and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |
States
How a record moves from state to state. Archive and block can happen in any state.