Manufacturing orders
A work order that states what to produce and by when, with its materials, operations and output.
- API name:
manufacturingorders - Domain: Manufacturing
- Modules: Manufacturing analytics, Sales, Stores, Manufacturing
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 | ||
| Order number | uid | Text | The number is a human-readable, unique identifier for the record. | |
| Day | date | Date | Yes | Calendar date for this value. |
| Project | projectId | Reference | ||
| User | userId | User | ||
| Quantity | quantity | Quantity | Yes | Units the order must make. |
| Planned quantity | quantityPlanned | Quantity | Yes | Units captured when the order is created. |
| Quantity completed | quantityCompleted | Quantity | Yes | Good units received from production. |
| Quantity scrapped | quantityScrapped | Quantity | Yes | Units scrapped. |
| Catalog | catalog | Constant | Yes | Fixed option from the allowed set for this field. |
| Item | productitemId | Reference | ||
| Item | customitemId | Reference | ||
| Product revision | productrevisionId | Reference | ||
| Bill of materials | billofmaterialId | Reference | ||
| Production version | productproductionversionId | Reference | ||
| Line item | salesorderitemId | Reference | ||
| Transformation | salesorderitemtransformationId | Reference | ||
| Class | class | Constant | Yes | Primary class of the record within its table, as defined by the applicable option list. |
| Allow overproduction | allowOverproduction | Boolean | Yes | When enabled, the related rule or behavior applies to this record. |
| Reservations | reservationDisposition | Constant | Yes | On pause: Release cancels open material reservations; Retain keeps them (requires permission and a reason). |
| Review date | datePauseReview | Date | Calendar date for this value. | |
| Amount | amount | Unit price | Monetary amount in the applicable currency for this record. | |
| Pause reason | pauseReason | Constant | Value from the table catalog for this field. | |
| Cancel reason | cancelReason | Text Area | Required explanation when canceling this record. | |
| 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 | |
| Started by | startedBy | User | ||
| Started at | startedAt | Date and Time | ||
| Ended by | endedBy | User | ||
| Ended at | endedAt | Date and Time | ||
| Closed by | closedBy | User | ||
| Closed at | closedAt | Date and Time | ||
| Canceled by | canceledBy | User | ||
| Canceled at | canceledAt | Date and Time | ||
| Paused by | heldBy | User | ||
| Paused at | heldAt | 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 | reference |
User userId | Users | reference |
Product revision productrevisionId | Product revisions | reference |
Bill of materials billofmaterialId | Bills of materials | reference |
Production version productproductionversionId | Production versions | reference |
Line item salesorderitemId | Sales order line items | reference |
Transformation salesorderitemtransformationId | Sales order line transformations | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event manufacturingorders.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new order. | App · API · MCP · CLI |
| Edit | update | Save changes to this order. | App · API · MCP · CLI |
| Start | start | Start this order and open the work. | App · API · MCP · CLI |
| End | end | Post the final production cost. This action is irreversible. | App · API · MCP · CLI |
| Close | close | Complete the order and post the remaining work in process. | App · API · MCP · CLI |
| Reopen | unclose | Allow new references to this order again. | App · API · MCP · CLI |
| Cancel | cancel | Reverse the posted effect of this order. | App · API · MCP · CLI |
| Pause | hold | Pause the order. Choose to release or retain its open material reservations; consumed material is not reversed. | App · API · MCP · CLI |
| Unpause | unhold | Continue a paused order. Material is not re-reserved automatically. | App · API · MCP · CLI |
| Block | block | Stop edits and deletion of this order. It stays visible and can still appear on existing documents. Unblock to edit again. | App · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this order again. | App · API · MCP · CLI |
| Archive | archive | Retire this order 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 order to active lists and actions. | App · API · MCP · CLI |
| Delete | delete | Delete this order 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.
| Action | API name |
|---|---|
| Start | start |
| End | end |
| Cancel | cancel |
| Pause | hold |
| Close | close |
| Unpause | unhold |
| Reopen | unclose |
Events
Moments the record reaches on its own. Subscribe to them with a webhook.
| Name | Webhook event | Description |
|---|---|---|
| Late | manufacturingorders.late | The order passed its due date (plus grace days) without completing its quantity. |