Maintenance orders

A preventive or corrective maintenance work order for a work center, a vehicle, or 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.
Reported date	`date`	Date	Yes	Calendar date for this value.
User	`userId`	User
Object	`object`	Constant	Yes	Fixed option from the allowed set for this field.
Work center	`workcenterId`	Reference
Vehicle	`vehicleId`	Reference
Maintenance plan	`maintenanceplanId`	Reference
Kind	`kind`	Constant	Yes	Fixed option from the allowed set for this field.
Due date	`dateDue`	Date	Yes	Calendar date without time of date.
Hours	`hours`	Decimal	Yes	Numeric value stored with decimal precision.
Malfunction start	`datetimeMalfunctionStart`	Date and Time
Malfunction end	`datetimeMalfunctionEnd`	Date and Time
Breakdown	`isBreakdown`	Boolean	Yes	Yes when this condition applies to the record.
Failure reason	`failureReason`	Constant		Value from the table catalog for this field.
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
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

Owned records (solid line) are deleted with their owner. Grouped records (dashed line) can exist alone.

Field	Points to	Kind
User `userId`	Users	reference
Maintenance plan `maintenanceplanId`	Maintenance plans	reference
Tags `tagIds`	Tags	reference

What you can do with a record. Every action also sends the webhook event maintenanceorders.<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`	End this action. The work stops. This cannot be undone.	App · API · MCP · CLI
Close	`close`	Stop new references to this order. It stays, and existing documents stay. Unclose to allow new references again.	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
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 · CLI

How a record moves from state to state. Archive and block can happen in any state.