API ReferenceWork Order
workOrder.create
Type: Mutation · Auth: Workspace-aware
Input
| 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 |
Example
{
"ticketId": null,
"projectId": null,
"pmScheduleId": null,
"customerId": "550e8400-e29b-41d4-a716-446655440000",
"siteId": "550e8400-e29b-41d4-a716-446655440000",
"workType": "service_call",
"dispatchStatus": "unscheduled",
"billableStatus": "not_billable",
"laborStatus": "not_started",
"materialsStatus": "none_needed",
"customerSignoffStatus": "not_required",
"followUpRequired": false,
"isRevisit": false
}