Service visits

A scheduled or actual on-site appointment for one service order, with location, window, and assigned crew.

Fields

The API name is what the API, MCP and the CLI use.

NameAPI nameTypeRequiredDescription
IDidRecord IDYes
OrderserviceorderIdReferenceYes
Window startdateStartDateYesCalendar date without time of date.
Window enddateEndDateYesCalendar date without time of date.
BranchcustomerbranchIdReference
EmployeeemployeeIdReference
Created bycreatedByUser
Created atcreatedAtDate and TimeYes
Updated byupdatedByUser
Updated atupdatedAtDate and TimeYes
Started bystartedByUser
Started atstartedAtDate and Time
Ended byendedByUser
Ended atendedAtDate and Time
Blocked byblockedByUser
Blocked atblockedAtDate and Time
Archived byarchivedByUser
Archived atarchivedAtDate and Time

Relations

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

Service visitsService orders
FieldPoints toKind
Order serviceorderIdService ordersowned by
Branch customerbranchIdCustomer branchesreference
Employee employeeIdEmployeesreference

Actions

What you can do with a record. Every action also sends the webhook event servicevisits.<action>. Reads (find, get, count) work on every table.

NameAPI nameDescriptionWhere
CreatecreateAdd a new visit.App · WebMCP · API · MCP · CLI
EditupdateSave changes to this visit.App · API · MCP · CLI
StartstartStart this visit and open the work.App · API · MCP · CLI
EndendEnd this action. The work stops. This cannot be undone.App · API · MCP · CLI
DeletedeleteDelete this visit 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.

StartEndCreatedStartedStarted · Ended