Vehicles
A motor vehicle registered to a legal entity of the organization.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Model | model | Text | ||
| Name | label | Text | Yes | |
| Make | make | Text | ||
| Year | year | Year | ||
| Body color | colorBody | Text | Exterior or body color for this record. | |
| License plate | licensePlate | Text | ||
| Plate country | plateCountry | Constant | Country that issued the plate (ISO 3166-1). A plate is unique per country, state and number. | |
| Plate state | plateSubdivision | Text | ||
| Weight unit | weightunit | Constant | Yes | Fixed option from the allowed set for this field. |
| Max weight | maxWeight | Decimal | Numeric value stored with decimal precision. | |
| Max volume | maxVolume | Decimal | Numeric value stored with decimal precision. | |
| Max pallets | maxPallets | Whole Number | Whole number without fractional part. | |
| Image | image | Image | ||
| Tags | tagIds | Tags | ||
| 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 | |
| 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 |
|---|---|---|
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event vehicles.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new vehicle. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this vehicle. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this vehicle. 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 vehicle again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this vehicle 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 vehicle to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this vehicle and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |