Domain Model
Work Order
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| ticketId | string | No | — | ID of the associated ticket |
| number | integer | Yes | — | Number |
| projectId | string | No | — | ID of the associated project |
| pmScheduleId | string | No | — | ID of the associated pm schedule |
| customerId | string | Yes | — | ID of the associated customer |
| siteId | string | Yes | — | ID of the associated site |
| workType | enum(service_call, installation, inspection, preventive_maintenance, emergency, other) | Yes | — | Work type |
| serviceTypeId | unknown | No | — | ID of the associated service type |
| dispatchStatus | enum(unscheduled, scheduled, dispatched, en_route, on_site, completed, canceled) | Yes | — | Dispatch status |
| scheduledStart | string.date-time | No | — | Scheduled start |
| scheduledEnd | string.date-time | No | — | Scheduled end |
| technicianUserIds | string[] | No | — | Technician user ids |
| leadTechnicianUserId | unknown | No | — | ID of the associated lead technician user |
| billableStatus | enum(not_billable, billable, invoiced) | Yes | — | Billable status |
| laborStatus | enum(not_started, in_progress, completed) | Yes | — | Labor status |
| materialsStatus | enum(none_needed, pending, fulfilled) | Yes | — | Materials status |
| customerSignoffStatus | enum(not_required, pending, signed, disputed) | Yes | — | Customer signoff status |
| workSummary | string | No | — | Work summary |
| recommendedFollowup | string | No | — | Recommended followup |
| priority | unknown | No | — | Priority |
| estimatedLaborHours | unknown | No | — | Estimated labor hours |
| actualLaborHours | unknown | No | — | Actual labor hours |
| estimatedMaterialCost | unknown | No | — | Estimated material cost |
| actualMaterialCost | unknown | No | — | Actual material cost |
| actualLaborCost | unknown | No | — | Actual labor cost |
| totalCost | unknown | No | — | Total cost |
| laborEfficiency | number,null | No | — | Labor efficiency |
| costVariance | number,null | No | — | Cost variance |
| checkInAt | unknown | No | — | Check in at |
| checkOutAt | unknown | No | — | Check out at |
| gpsCheckIn | unknown | No | — | Gps check in |
| gpsCheckOut | unknown | No | — | Gps check out |
| customerSignatureS3Key | string,null | No | — | Customer signature s3key |
| customerSignatureName | string,null | No | — | Customer signature name |
| customerSignatureSignedAt | unknown | No | — | Customer signature signed at |
| customerSignatureGps | unknown | No | — | Customer signature gps |
| customerSignatureIp | string,null | No | — | Customer signature ip |
| completionNotes | string,null | No | — | Completion notes |
| followUpRequired | boolean,null | No | — | Follow up required |
| isRevisit | boolean,null | No | — | Is revisit |
| requiredSkills | unknown | No | — | Required skills |
| invoiceId | unknown | No | — | ID of the associated invoice |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| ticketId | unknown | No | — | ID of the associated ticket |
| projectId | unknown | No | — | ID of the associated project |
| pmScheduleId | unknown | No | — | ID of the associated pm schedule |
| customerId | string | Yes | — | ID of the associated customer |
| siteId | string | Yes | — | ID of the associated site |
| workType | enum(service_call, installation, inspection, preventive_maintenance, emergency, other) | Yes | — | Work type |
| serviceTypeId | unknown | No | — | ID of the associated service type |
| dispatchStatus | enum(unscheduled, scheduled, dispatched, en_route, on_site, completed, canceled) | Yes | "unscheduled" | Dispatch status |
| scheduledStart | unknown | No | — | Scheduled start |
| scheduledEnd | unknown | No | — | Scheduled end |
| technicianUserIds | string[] | No | — | Technician user ids |
| billableStatus | enum(not_billable, billable, invoiced) | Yes | "not_billable" | Billable status |
| laborStatus | enum(not_started, in_progress, completed) | Yes | "not_started" | Labor status |
| materialsStatus | enum(none_needed, pending, fulfilled) | Yes | "none_needed" | Materials status |
| customerSignoffStatus | enum(not_required, pending, signed, disputed) | Yes | "not_required" | Customer signoff status |
| workSummary | unknown | No | — | Work summary |
| recommendedFollowup | unknown | No | — | Recommended followup |
| priority | unknown | No | "medium" | Priority |
| estimatedLaborHours | unknown | No | — | Estimated labor hours |
| estimatedMaterialCost | unknown | No | — | Estimated material cost |
| checkInAt | unknown | No | — | Check in at |
| checkOutAt | unknown | No | — | Check out at |
| gpsCheckIn | object | No | — | Gps check in |
| gpsCheckOut | object | No | — | Gps check out |
| completionNotes | unknown | No | — | Completion notes |
| followUpRequired | boolean | Yes | false | Follow up required |
| isRevisit | boolean | Yes | false | Is revisit |
| requiredSkills | string[] | No | — | Required skills |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| ticketId | unknown | No | — | ID of the associated ticket |
| projectId | unknown | No | — | ID of the associated project |
| pmScheduleId | unknown | No | — | ID of the associated pm schedule |
| customerId | string | No | — | ID of the associated customer |
| siteId | string | No | — | ID of the associated site |
| workType | enum(service_call, installation, inspection, preventive_maintenance, emergency, other) | No | — | Work type |
| serviceTypeId | unknown | No | — | ID of the associated service type |
| dispatchStatus | enum(unscheduled, scheduled, dispatched, en_route, on_site, completed, canceled) | No | — | Dispatch status |
| scheduledStart | unknown | No | — | Scheduled start |
| scheduledEnd | unknown | No | — | Scheduled end |
| technicianUserIds | string[] | No | — | Technician user ids |
| billableStatus | enum(not_billable, billable, invoiced) | No | — | Billable status |
| laborStatus | enum(not_started, in_progress, completed) | No | — | Labor status |
| materialsStatus | enum(none_needed, pending, fulfilled) | No | — | Materials status |
| customerSignoffStatus | enum(not_required, pending, signed, disputed) | No | — | Customer signoff status |
| workSummary | unknown | No | — | Work summary |
| recommendedFollowup | unknown | No | — | Recommended followup |
| priority | unknown | No | — | Priority |
| estimatedLaborHours | unknown | No | — | Estimated labor hours |
| estimatedMaterialCost | unknown | No | — | Estimated material cost |
| checkInAt | unknown | No | — | Check in at |
| checkOutAt | unknown | No | — | Check out at |
| gpsCheckIn | object | No | — | Gps check in |
| gpsCheckOut | object | No | — | Gps check out |
| completionNotes | unknown | No | — | Completion notes |
| followUpRequired | boolean | No | — | Follow up required |
| isRevisit | boolean | No | — | Is revisit |
| requiredSkills | string[] | No | — | Required skills |
| leadTechnicianUserId | unknown | No | — | ID of the associated lead technician user |