> 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 Estimate POST https://estimates Content-Type: multipart/form-data Reference: https://docs.itspropel.com/propel-biz/18-estimates/18-estimates-estimates/create-estimate ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: PropelBiz version: 1.0.0 paths: /estimates: post: operationId: create-estimate summary: Create Estimate tags: - subpackage_18Estimates.subpackage_18Estimates/18EstimatesEstimates parameters: - name: '{{tenant_key_name}}' in: header required: false schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: >- #/components/schemas/18 Estimates_18 Estimates > Estimates_Create Estimate_Response_200 requestBody: content: multipart/form-data: schema: type: object properties: customer_id: type: string description: 'Required: Customer UUID - must exist in customers table' valid_until: type: string description: >- Optional: Expiry date - must be after estimate_date - YYYY-MM-DD estimate_date: type: string description: >- Optional: Estimate date - YYYY-MM-DD format - defaults to today work_order_id: type: string description: >- Optional: Link to existing work order - must exist in work_orders table customer_notes: type: string description: 'Optional: Notes visible to customer - max 2000 chars' internal_notes: type: string description: >- Optional: Internal notes not visible to customer - max 2000 chars billing_location_id: type: string description: >- Optional: Billing location UUID - must exist in customer_locations table line_items[0][notes]: type: string description: 'Optional: Line item notes - max 1000 chars' line_items[0][quantity]: type: string description: 'Required with line_items: Quantity - numeric min 0.01' line_items[0][is_taxable]: type: string description: 'Optional: Whether item is taxable - boolean - default true' line_items[0][unit_price]: type: string description: 'Required with line_items: Unit price - numeric min 0' line_items[0][description]: type: string description: >- Required with line_items: Line item description - max 500 chars line_items[0][is_optional]: type: string description: 'Optional: Whether item is optional - boolean - default false' customer_signature_required: type: string description: >- Optional: Whether customer signature is required - boolean - false line_items[0][line_item_type]: type: string description: >- Required with line_items: Type - labor|parts|equipment_rental|service_fee|travel|discount|ad_hoc line_items[0][discount_amount]: type: string description: 'Optional: Discount amount - numeric min 0' line_items[0][pricebook_item_id]: type: string description: >- Optional: PriceBook item UUID - must exist in pricebook_items table required: - customer_id - valid_until - estimate_date - work_order_id - customer_notes - internal_notes - billing_location_id - line_items[0][notes] - line_items[0][quantity] - line_items[0][is_taxable] - line_items[0][unit_price] - line_items[0][description] - line_items[0][is_optional] - customer_signature_required - line_items[0][line_item_type] - line_items[0][discount_amount] - line_items[0][pricebook_item_id] servers: - url: https:/ components: schemas: 18 Estimates_18 Estimates > Estimates_Create Estimate_Response_200: type: object properties: {} description: Empty response body title: 18 Estimates_18 Estimates > Estimates_Create Estimate_Response_200 ``` ## SDK Code Examples ```python import requests url = "https://https/estimates" payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_until\"\r\n\r\n2024-07-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"estimate_date\"\r\n\r\n2024-07-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\n7b9c9f1e-8d3a-4f2a-9c1e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_notes\"\r\n\r\nPlease review the estimate and approve by the valid until date.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"internal_notes\"\r\n\r\nPriority customer, apply standard discount.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"billing_location_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-23456789abcd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][notes]\"\r\n\r\nIncludes installation and setup.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][quantity]\"\r\n\r\n3\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_taxable]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][unit_price]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][description]\"\r\n\r\nPremium air conditioning unit\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_optional]\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_signature_required\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][line_item_type]\"\r\n\r\nparts\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][discount_amount]\"\r\n\r\n20.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][pricebook_item_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\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/estimates'; const form = new FormData(); form.append('customer_id', '3fa85f64-5717-4562-b3fc-2c963f66afa6'); form.append('valid_until', '2024-07-31'); form.append('estimate_date', '2024-07-01'); form.append('work_order_id', '7b9c9f1e-8d3a-4f2a-9c1e-123456789abc'); form.append('customer_notes', 'Please review the estimate and approve by the valid until date.'); form.append('internal_notes', 'Priority customer, apply standard discount.'); form.append('billing_location_id', 'd4e5f6a7-b8c9-4d0e-9f1a-23456789abcd'); form.append('line_items[0][notes]', 'Includes installation and setup.'); form.append('line_items[0][quantity]', '3'); form.append('line_items[0][is_taxable]', 'true'); form.append('line_items[0][unit_price]', '150.00'); form.append('line_items[0][description]', 'Premium air conditioning unit'); form.append('line_items[0][is_optional]', 'false'); form.append('customer_signature_required', 'true'); form.append('line_items[0][line_item_type]', 'parts'); form.append('line_items[0][discount_amount]', '20.00'); form.append('line_items[0][pricebook_item_id]', 'a1b2c3d4-e5f6-7890-abcd-ef1234567890'); 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/estimates" payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_until\"\r\n\r\n2024-07-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"estimate_date\"\r\n\r\n2024-07-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\n7b9c9f1e-8d3a-4f2a-9c1e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_notes\"\r\n\r\nPlease review the estimate and approve by the valid until date.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"internal_notes\"\r\n\r\nPriority customer, apply standard discount.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"billing_location_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-23456789abcd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][notes]\"\r\n\r\nIncludes installation and setup.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][quantity]\"\r\n\r\n3\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_taxable]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][unit_price]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][description]\"\r\n\r\nPremium air conditioning unit\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_optional]\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_signature_required\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][line_item_type]\"\r\n\r\nparts\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][discount_amount]\"\r\n\r\n20.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][pricebook_item_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\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/estimates") 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=\"customer_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_until\"\r\n\r\n2024-07-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"estimate_date\"\r\n\r\n2024-07-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\n7b9c9f1e-8d3a-4f2a-9c1e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_notes\"\r\n\r\nPlease review the estimate and approve by the valid until date.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"internal_notes\"\r\n\r\nPriority customer, apply standard discount.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"billing_location_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-23456789abcd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][notes]\"\r\n\r\nIncludes installation and setup.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][quantity]\"\r\n\r\n3\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_taxable]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][unit_price]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][description]\"\r\n\r\nPremium air conditioning unit\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_optional]\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_signature_required\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][line_item_type]\"\r\n\r\nparts\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][discount_amount]\"\r\n\r\n20.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][pricebook_item_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\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/estimates") .header("{{tenant_key_name}}", "{{tenant_key_value1}}|{{tenant_key_value2}}") .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_until\"\r\n\r\n2024-07-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"estimate_date\"\r\n\r\n2024-07-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\n7b9c9f1e-8d3a-4f2a-9c1e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_notes\"\r\n\r\nPlease review the estimate and approve by the valid until date.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"internal_notes\"\r\n\r\nPriority customer, apply standard discount.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"billing_location_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-23456789abcd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][notes]\"\r\n\r\nIncludes installation and setup.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][quantity]\"\r\n\r\n3\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_taxable]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][unit_price]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][description]\"\r\n\r\nPremium air conditioning unit\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_optional]\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_signature_required\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][line_item_type]\"\r\n\r\nparts\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][discount_amount]\"\r\n\r\n20.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][pricebook_item_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\r\n-----011000010111000001101001--\r\n") .asString(); ``` ```php request('POST', 'https://https/estimates', [ 'multipart' => [ [ 'name' => 'customer_id', 'contents' => '3fa85f64-5717-4562-b3fc-2c963f66afa6' ], [ 'name' => 'valid_until', 'contents' => '2024-07-31' ], [ 'name' => 'estimate_date', 'contents' => '2024-07-01' ], [ 'name' => 'work_order_id', 'contents' => '7b9c9f1e-8d3a-4f2a-9c1e-123456789abc' ], [ 'name' => 'customer_notes', 'contents' => 'Please review the estimate and approve by the valid until date.' ], [ 'name' => 'internal_notes', 'contents' => 'Priority customer, apply standard discount.' ], [ 'name' => 'billing_location_id', 'contents' => 'd4e5f6a7-b8c9-4d0e-9f1a-23456789abcd' ], [ 'name' => 'line_items[0][notes]', 'contents' => 'Includes installation and setup.' ], [ 'name' => 'line_items[0][quantity]', 'contents' => '3' ], [ 'name' => 'line_items[0][is_taxable]', 'contents' => 'true' ], [ 'name' => 'line_items[0][unit_price]', 'contents' => '150.00' ], [ 'name' => 'line_items[0][description]', 'contents' => 'Premium air conditioning unit' ], [ 'name' => 'line_items[0][is_optional]', 'contents' => 'false' ], [ 'name' => 'customer_signature_required', 'contents' => 'true' ], [ 'name' => 'line_items[0][line_item_type]', 'contents' => 'parts' ], [ 'name' => 'line_items[0][discount_amount]', 'contents' => '20.00' ], [ 'name' => 'line_items[0][pricebook_item_id]', 'contents' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890' ] ] 'headers' => [ '{{tenant_key_name}}' => '{{tenant_key_value1}}|{{tenant_key_value2}}', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://https/estimates"); 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=\"customer_id\"\r\n\r\n3fa85f64-5717-4562-b3fc-2c963f66afa6\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"valid_until\"\r\n\r\n2024-07-31\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"estimate_date\"\r\n\r\n2024-07-01\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"work_order_id\"\r\n\r\n7b9c9f1e-8d3a-4f2a-9c1e-123456789abc\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_notes\"\r\n\r\nPlease review the estimate and approve by the valid until date.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"internal_notes\"\r\n\r\nPriority customer, apply standard discount.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"billing_location_id\"\r\n\r\nd4e5f6a7-b8c9-4d0e-9f1a-23456789abcd\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][notes]\"\r\n\r\nIncludes installation and setup.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][quantity]\"\r\n\r\n3\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_taxable]\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][unit_price]\"\r\n\r\n150.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][description]\"\r\n\r\nPremium air conditioning unit\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][is_optional]\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"customer_signature_required\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][line_item_type]\"\r\n\r\nparts\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][discount_amount]\"\r\n\r\n20.00\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"line_items[0][pricebook_item_id]\"\r\n\r\na1b2c3d4-e5f6-7890-abcd-ef1234567890\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": "customer_id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], [ "name": "valid_until", "value": "2024-07-31" ], [ "name": "estimate_date", "value": "2024-07-01" ], [ "name": "work_order_id", "value": "7b9c9f1e-8d3a-4f2a-9c1e-123456789abc" ], [ "name": "customer_notes", "value": "Please review the estimate and approve by the valid until date." ], [ "name": "internal_notes", "value": "Priority customer, apply standard discount." ], [ "name": "billing_location_id", "value": "d4e5f6a7-b8c9-4d0e-9f1a-23456789abcd" ], [ "name": "line_items[0][notes]", "value": "Includes installation and setup." ], [ "name": "line_items[0][quantity]", "value": "3" ], [ "name": "line_items[0][is_taxable]", "value": "true" ], [ "name": "line_items[0][unit_price]", "value": "150.00" ], [ "name": "line_items[0][description]", "value": "Premium air conditioning unit" ], [ "name": "line_items[0][is_optional]", "value": "false" ], [ "name": "customer_signature_required", "value": "true" ], [ "name": "line_items[0][line_item_type]", "value": "parts" ], [ "name": "line_items[0][discount_amount]", "value": "20.00" ], [ "name": "line_items[0][pricebook_item_id]", "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ] ] 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/estimates")! 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() ```