Service orders
A work document to perform a sold or goodwill service for a customer or at a site.
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. |
| Order | salesorderId | Reference | ||
| Customer | customerId | Reference | ||
| Branch | customerbranchId | Reference | ||
| User | userId | User | ||
| Employee | employeeId | Reference | ||
| Requested date | dateRequested | Date | Calendar date without time of date. | |
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Comments | comments | Text Area | ||
| 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 | ||
| Confirmed by | confirmedBy | User | ||
| Confirmed at | confirmedAt | Date and Time | ||
| Closed by | closedBy | User | ||
| Closed at | closedAt | Date and Time | ||
| 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
Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.
| Field | Points to | Kind |
|---|---|---|
Order salesorderId | Sales orders | reference |
Customer customerId | Customers | reference |
Branch customerbranchId | Customer branches | reference |
User userId | Users | reference |
Employee employeeId | Employees | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event serviceorders.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add an new order. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this order. | App · WebMCP · API · MCP · CLI |
| Start | start | Start this order and open the work. | App · WebMCP · API · MCP · CLI |
| End | end | End this action. The work stops. This cannot be undone. | App · WebMCP · API · MCP · CLI |
| Close | close | Stop new references to this order. It stays, and existing documents stay. Unclose to allow new references again. | App · WebMCP · API · MCP · CLI |
| Reopen | unclose | Allow new references to this order again. | App · WebMCP · API · MCP · CLI |
| Cancel | cancel | Cancel the started service order when it has no approved confirmations. | App · WebMCP · API · MCP · CLI |
| Confirm | confirm | Confirm your own planned or selected work so the next step can start. Not an approval: no second person is required. | 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 · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this order again. | App · WebMCP · 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 · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this order to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this order 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.