> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itspropel.com/llms.txt. > For full documentation content, see https://docs.itspropel.com/llms-full.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itspropel.com/_mcp/server. # Create Work Order POST https://work-orders Content-Type: multipart/form-data Create a new work order. **Required Permission:** `create_work_orders` ## Required Fields - `customer_id` - UUID (must exist in customers table) - `location_id` - UUID (customer location) - `service_id` - UUID (links work order to a service from the service catalog) - `category` - Enum: scheduled, emergency, warranty, contract, inspection, installation, repair, delivery, consultation, follow_up, recall, upgrade - `priority` - Enum: low, normal, high, urgent, emergency, critical - `source` - Enum: customer_request, scheduled_maintenance, emergency_call, contract, inspection, internal, warranty_claim, follow_up, system_generated, mobile_app, web_portal, call_center ## Optional Fields - `current_status` - Enum: draft, pending_approval, approved, scheduled, dispatched, en_route, arrived, in_progress, on_hold, completed, cancelled, rescheduled, requires_parts, requires_approval, quality_check, invoiced, closed - `scheduled_start` - datetime (Y-m-d H:i:s) - Scheduled start date and time - `scheduled_end` - datetime (Y-m-d H:i:s) - Scheduled end date and time (must be after scheduled_start) - `requested_completion_by` - datetime (Y-m-d H:i:s) - `completion_percentage` - integer (0-100) - `work_started_at` - datetime - `work_completed_at` - datetime - `special_instructions` - string - `completion_summary` - string - `primary_contact_id` - UUID - `customer_presence_required` - boolean - `customer_notification_sent` - boolean - `customer_notified_at` - datetime - `preferred_communication_methods` - array (phone, email, sms, app) - `estimated_labor_cost` - numeric, min:0 - `estimated_parts_cost` - numeric, min:0 - `actual_labor_cost` - numeric, min:0 - `actual_parts_cost` - numeric, min:0 - `customer_signature_required` - boolean - `customer_signature_received` - boolean - `customer_signed_at` - datetime - `quality_check_required` - boolean - `quality_check_passed` - boolean - `quality_checked_by` - UUID - `quality_checked_at` - datetime - `customer_satisfaction_score` - integer (1-5) - `customer_feedback` - string - `requires_follow_up` - boolean - `follow_up_date` - date - `follow_up_completed` - boolean - `warranty_applicable` - boolean - `warranty_days` - integer - `warranty_expires_at` - date - `assigned_supervisor_id` - UUID - `external_work_order_id` - string - `customer_po_number` - string - `contract_number` - string - `external_references` - array - `response_time_minutes` - integer - `resolution_time_minutes` - integer - `completed_on_time` - boolean - `completed_within_estimate` - boolean - `callback_count` - integer - `requires_manager_approval` - boolean - `approved_by` - UUID - `approved_at` - datetime - `approval_notes` - string - `risk_level` - Enum: low, medium, high, critical - `safety_incident_occurred` - boolean - `safety_requirements` - array - `permit_required` - boolean - `permit_number` - string ## Auto-Calculated Fields (do not send these) - `estimated_total` - Automatically calculated from estimated_labor_cost + estimated_parts_cost - `actual_total` - Automatically calculated from actual_labor_cost + actual_parts_cost - `actual_duration_minutes` - Automatically calculated from work_started_at and work_completed_at Reference: https://docs.itspropel.com/propel-biz/11-work-order/01-work-orders/create-work-order ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /work-orders: post: operationId: create-work-order summary: Create Work Order description: >- Create a new work order. **Required Permission:** `create_work_orders` ## Required Fields - `customer_id` - UUID (must exist in customers table) - `location_id` - UUID (customer location) - `service_id` - UUID (links work order to a service from the service catalog) - `category` - Enum: scheduled, emergency, warranty, contract, inspection, installation, repair, delivery, consultation, follow_up, recall, upgrade - `priority` - Enum: low, normal, high, urgent, emergency, critical - `source` - Enum: customer_request, scheduled_maintenance, emergency_call, contract, inspection, internal, warranty_claim, follow_up, system_generated, mobile_app, web_portal, call_center ## Optional Fields - `current_status` - Enum: draft, pending_approval, approved, scheduled, dispatched, en_route, arrived, in_progress, on_hold, completed, cancelled, rescheduled, requires_parts, requires_approval, quality_check, invoiced, closed - `scheduled_start` - datetime (Y-m-d H:i:s) - Scheduled start date and time - `scheduled_end` - datetime (Y-m-d H:i:s) - Scheduled end date and time (must be after scheduled_start) - `requested_completion_by` - datetime (Y-m-d H:i:s) - `completion_percentage` - integer (0-100) - `work_started_at` - datetime - `work_completed_at` - datetime - `special_instructions` - string - `completion_summary` - string - `primary_contact_id` - UUID - `customer_presence_required` - boolean - `customer_notification_sent` - boolean - `customer_notified_at` - datetime - `preferred_communication_methods` - array (phone, email, sms, app) - `estimated_labor_cost` - numeric, min:0 - `estimated_parts_cost` - numeric, min:0 - `actual_labor_cost` - numeric, min:0 - `actual_parts_cost` - numeric, min:0 - `customer_signature_required` - boolean - `customer_signature_received` - boolean - `customer_signed_at` - datetime - `quality_check_required` - boolean - `quality_check_passed` - boolean - `quality_checked_by` - UUID - `quality_checked_at` - datetime - `customer_satisfaction_score` - integer (1-5) - `customer_feedback` - string - `requires_follow_up` - boolean - `follow_up_date` - date - `follow_up_completed` - boolean - `warranty_applicable` - boolean - `warranty_days` - integer - `warranty_expires_at` - date - `assigned_supervisor_id` - UUID - `external_work_order_id` - string - `customer_po_number` - string - `contract_number` - string - `external_references` - array - `response_time_minutes` - integer - `resolution_time_minutes` - integer - `completed_on_time` - boolean - `completed_within_estimate` - boolean - `callback_count` - integer - `requires_manager_approval` - boolean - `approved_by` - UUID - `approved_at` - datetime - `approval_notes` - string - `risk_level` - Enum: low, medium, high, critical - `safety_incident_occurred` - boolean - `safety_requirements` - array - `permit_required` - boolean - `permit_number` - string ## Auto-Calculated Fields (do not send these) - `estimated_total` - Automatically calculated from estimated_labor_cost + estimated_parts_cost - `actual_total` - Automatically calculated from actual_labor_cost + actual_parts_cost - `actual_duration_minutes` - Automatically calculated from work_started_at and work_completed_at tags: - subpackage_11WorkOrder.subpackage_11WorkOrder/01WorkOrders parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/11 Work Order_01 Work Orders_Create Work Order_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: ' source': type: string description: >- Required: Enum - customer_request|scheduled_maintenance|emergency_call|contract|inspection|internal|warranty_claim|follow_up|system_generated|mobile_app|web_portal|call_center - Work order source ' category': type: string description: >- Required: Enum - scheduled|emergency|warranty|contract|inspection|installation|repair|delivery|consultation|follow_up|recall|upgrade - Work order category ' priority': type: string description: >- Required: Enum - low|normal|high|urgent|emergency|critical - Work order priority level ' service_id': type: string description: 'Required: UUID - Service UUID from service catalog' ' customer_id': type: string description: >- Required: UUID - Customer UUID (must exist in customers table) ' location_id': type: string description: 'Required: UUID - Customer location UUID' ' scheduled_end': type: string description: >- Optional: datetime - Scheduled end date and time (must be after scheduled_start) ' current_status': type: string description: >- Optional: Enum - scheduled|dispatched|en_route|arrived|in_progress|on_hold|completed|cancelled|rescheduled|requires_parts|invoiced|closed - Initial work order status ' scheduled_start': type: string description: 'Optional: datetime - Scheduled start date and time' required: - ' source' - ' category' - ' priority' - ' service_id' - ' customer_id' - ' location_id' - ' scheduled_end' - ' current_status' - ' scheduled_start' servers: - url: https:/ components: schemas: 11 Work Order_01 Work Orders_Create Work Order_Response_200: type: object properties: {} description: Empty response body title: 11 Work Order_01 Work Orders_Create Work Order_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/work-orders" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" source\"\r\n\r\ncustomer_request\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" category\"\r\n\r\nrepair\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" priority\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" service_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" customer_id\"\r\n\r\n9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" location_id\"\r\n\r\n1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_end\"\r\n\r\n2024-07-15 17:00:00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" current_status\"\r\n\r\nscheduled\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_start\"\r\n\r\n2024-07-15 09:00:00\r\n-----011000010111000001101001--\r\n" headers = { "{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}", "Content-Type": "multipart/form-data; boundary=---011000010111000001101001" } response = requests.post(url, data=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://https/work-orders'; const form = new FormData(); form.append(' source', 'customer_request'); form.append(' category', 'repair'); form.append(' priority', 'high'); form.append(' service_id', '3fa85f64-5717-4562-b3fc-2c963f66afa6'); form.append(' customer_id', '9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f'); form.append(' location_id', '1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d'); form.append(' scheduled_end', '2024-07-15 17:00:00'); form.append(' current_status', 'scheduled'); form.append(' scheduled_start', '2024-07-15 09:00:00'); const options = { method: 'POST', headers: {'{{tenant_key_name}}': '{{tenant_key_value1}}|{{tenant_key_value2}}'} }; options.body = form; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://https/work-orders" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" source\"\r\n\r\ncustomer_request\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" category\"\r\n\r\nrepair\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" priority\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" service_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" customer_id\"\r\n\r\n9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" location_id\"\r\n\r\n1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_end\"\r\n\r\n2024-07-15 17:00:00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" current_status\"\r\n\r\nscheduled\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_start\"\r\n\r\n2024-07-15 09:00:00\r\n-----011000010111000001101001--\r\n") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://https/work-orders") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["{{tenant_key_name}}"] = '{{tenant_key_value1}}|{{tenant_key_value2}}' request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" source\"\r\n\r\ncustomer_request\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" category\"\r\n\r\nrepair\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" priority\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" service_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" customer_id\"\r\n\r\n9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" location_id\"\r\n\r\n1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_end\"\r\n\r\n2024-07-15 17:00:00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" current_status\"\r\n\r\nscheduled\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_start\"\r\n\r\n2024-07-15 09:00:00\r\n-----011000010111000001101001--\r\n" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://https/work-orders") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" source\"\r\n\r\ncustomer_request\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" category\"\r\n\r\nrepair\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" priority\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" service_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" customer_id\"\r\n\r\n9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" location_id\"\r\n\r\n1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_end\"\r\n\r\n2024-07-15 17:00:00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" current_status\"\r\n\r\nscheduled\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_start\"\r\n\r\n2024-07-15 09:00:00\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/work-orders', [ 'multipart' => [ [ 'name' => ' source', 'contents' => 'customer_request' ], [ 'name' => ' category', 'contents' => 'repair' ], [ 'name' => ' priority', 'contents' => 'high' ], [ 'name' => ' service_id', 'contents' => '3fa85f64-5717-4562-b3fc-2c963f66afa6' ], [ 'name' => ' customer_id', 'contents' => '9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f' ], [ 'name' => ' location_id', 'contents' => '1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d' ], [ 'name' => ' scheduled_end', 'contents' => '2024-07-15 17:00:00' ], [ 'name' => ' current_status', 'contents' => 'scheduled' ], [ 'name' => ' scheduled_start', 'contents' => '2024-07-15 09:00:00' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/work-orders"); var request = new RestRequest(Method.POST); request.AddHeader("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}"); request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" source\"\r\n\r\ncustomer_request\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" category\"\r\n\r\nrepair\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" priority\"\r\n\r\nhigh\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" service_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" customer_id\"\r\n\r\n9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" location_id\"\r\n\r\n1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_end\"\r\n\r\n2024-07-15 17:00:00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" current_status\"\r\n\r\nscheduled\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\" scheduled_start\"\r\n\r\n2024-07-15 09:00:00\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["{{tenant_key_name}}": "{{tenant_key_value1}}|{{tenant_key_value2}}"] let parameters = [ [ "name": " source", "value": "customer_request" ], [ "name": " category", "value": "repair" ], [ "name": " priority", "value": "high" ], [ "name": " service_id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], [ "name": " customer_id", "value": "9b2d7f4e-8c3a-4f1a-9d2e-1a2b3c4d5e6f" ], [ "name": " location_id", "value": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d" ], [ "name": " scheduled_end", "value": "2024-07-15 17:00:00" ], [ "name": " current_status", "value": "scheduled" ], [ "name": " scheduled_start", "value": "2024-07-15 09:00:00" ] ] let boundary = "---011000010111000001101001" var body = "" var error: NSError? = nil for param in parameters { let paramName = param["name"]! body += "--\(boundary)\r\n" body += "Content-Disposition:form-data; name=\"\(paramName)\"" if let filename = param["fileName"] { let contentType = param["content-type"]! let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8) if (error != nil) { print(error as Any) } body += "; filename=\"\(filename)\"\r\n" body += "Content-Type: \(contentType)\r\n\r\n" body += fileContent } else if let paramValue = param["value"] { body += "\r\n\r\n\(paramValue)" } } let request = NSMutableURLRequest(url: NSURL(string: "https://https/work-orders")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```