# Create Invoice from Estimate POST https://services.leadconnectorhq.com/invoices/estimate/{estimateId}/invoice Create a new invoice from an existing estimate ## Authentication Send `Authorization: Bearer ` using any one of: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `invoices/estimate.write` - **Agency token: OAuth access token or Private Integration Token.** Scopes: `invoices/estimate.write` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `estimateId` | string | Yes | Estimate Id | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "LeadConnector API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/invoices/estimate/{estimateId}/invoice": { "post": { "summary": "Create Invoice from Estimate", "operationId": "createInvoiceFromEstimate", "description": "Create a new invoice from an existing estimate", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } }, { "name": "estimateId", "required": true, "in": "path", "description": "Estimate Id", "schema": { "example": "5f9d6d8b1b2d2c001f2d9e4b", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceFromEstimateDto" } } } }, "responses": { "200": { "description": "Successfully Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceFromEstimateResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } } }, "security": [ { "Location-Access": [ "invoices/estimate.write" ] }, { "Agency-Access": [ "invoices/estimate.write" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "CreateInvoiceFromEstimateDto": { "type": "object", "properties": { "altId": { "type": "string", "description": "Location Id or Agency Id", "example": "6578278e879ad2646715ba9c" }, "altType": { "type": "string", "enum": [ "location" ] }, "markAsInvoiced": { "type": "boolean", "description": "Mark Estimate as Invoiced", "example": true }, "version": { "type": "string", "description": "Version of the update request", "example": "v2", "enum": [ "v1", "v2" ] } }, "required": [ "altId", "altType", "markAsInvoiced" ], "title": "CreateInvoiceFromEstimateDto" }, "CreateInvoiceFromEstimateResponseDTO": { "type": "object", "properties": { "estimate": { "description": "Estimate details", "allOf": [ { "type": "object", "properties": { "altId": { "type": "string", "description": "Location Id or Agency Id", "example": "6578278e879ad2646715ba9c" }, "altType": { "type": "string", "enum": [ "location" ] }, "_id": { "type": "string", "description": "Unique identifier", "example": "67ac9a51106ee8311e911XXXX" }, "liveMode": { "type": "boolean", "description": "Indicates if it is in live mode", "example": true }, "deleted": { "type": "boolean", "description": "Indicates if deleted", "example": false }, "name": { "type": "string", "description": "Name", "example": "Estimate Name" }, "currency": { "type": "string", "description": "Currency code", "example": "USD" }, "businessDetails": { "description": "Business details associated with the estimate", "example": { "logoUrl": "your_image-url", "name": "Business name", "address": { "addressLine1": "address line 1", "city": "Test City", "state": "State Name", "countryCode": "US", "postalCode": "12345" }, "phoneNo": "+1 1234567890", "website": "www.example.com", "customValues": [ { "name": "Test", "fieldKey": "{{custom_values.test}}", "id": "5DYTWoiQvWiIJZXX44XXX", "value": "Test's Custom Value" } ] }, "allOf": [ { "type": "object", "properties": {}, "title": "BusinessDetails" } ] }, "items": { "description": "An array of items", "example": [ { "taxes": [], "taxInclusive": false, "_id": "67ac9a51106ee8311e911XXXX", "description": "

Futuristic anti-gravity racing

", "currency": "USD", "productId": "67ac9a51106ee8311e911XXXX", "priceId": "67ac9a51106ee8311e911XXXX", "amount": 9.99, "qty": 1, "name": "TEST", "type": "one_time" }, { "taxes": [ { "_id": "67ac9a51106ee8311e911XXXX", "name": "TaxTwo", "rate": 8.5, "calculation": "exclusive" } ], "taxInclusive": true, "_id": "67ac9a51106ee8311e911XXXX", "productId": "67ac9a51106ee8311e911XXXX", "priceId": "67ac9a51106ee8311e911XXXX", "currency": "USD", "name": "TEST2", "qty": 1, "amount": 500, "description": "", "type": "recurring" } ], "type": "array", "items": { "type": "array" } }, "discount": { "description": "Discount details for the estimate template", "example": { "type": "percentage", "value": 0 }, "allOf": [ { "type": "object", "properties": { "value": { "type": "number", "description": "Discount Value", "example": 10, "default": 0 }, "type": { "type": "string", "description": "Discount type", "enum": [ "percentage", "fixed" ], "example": "percentage", "default": "percentage" }, "validOnProductIds": { "description": "Product Ids on which discount is applicable", "example": "[ '6579751d56f60276e5bd4154' ]", "type": "array", "items": { "type": "string" } } }, "required": [ "type" ], "title": "DiscountDto" } ] }, "title": { "type": "string", "description": "Title", "example": "ESTIMATE" }, "estimateNumberPrefix": { "type": "string", "description": "Estimate number prefix", "example": "EST-" }, "attachments": { "description": "Attachments", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the file selected", "example": "6241712be68f7a98102ba272" }, "name": { "type": "string", "description": "Name of the file ", "example": "Electronics.pdf" }, "url": { "type": "string", "description": "URL of the file", "example": "https://example.com/digital-delivery" }, "type": { "type": "string", "description": "Type of the file" }, "size": { "type": "number", "description": "Size of the file", "example": 10000 } }, "required": [ "id", "name", "url", "type", "size" ], "title": "AttachmentsDto" } }, "updatedBy": { "type": "string", "description": "User Id of who last updated", "example": "3HIpOF9NIc5ltriQXXXX" }, "total": { "type": "number", "description": "Total amount", "example": 1222.03 }, "createdAt": { "format": "date-time", "type": "string", "description": "Timestamp when created", "example": "2025-02-12T13:17:47.416Z" }, "updatedAt": { "format": "date-time", "type": "string", "description": "Timestamp when last updated", "example": "2025-02-12T13:17:47.416Z" }, "__v": { "type": "number", "description": "Version number", "example": 0 }, "automaticTaxesEnabled": { "type": "boolean", "description": "Indicates if automatic taxes are enabled for this estimate", "example": false }, "termsNotes": { "type": "string", "description": "Terms and conditions for the estimate, supports HTML markup", "example": "

All services are subject to availability.

" }, "companyId": { "type": "string", "description": "Company identifier associated with the estimate", "example": "COMP12345" }, "contactDetails": { "description": "Contact details for the estimate", "example": { "id": "jvzfKTNdE7OYXXXXXX", "name": "Contact Name", "phoneNo": "+911111111114", "email": "email@test.com", "address": { "countryCode": "US" } }, "allOf": [ { "type": "object", "properties": {}, "title": "ContactDetails" } ] }, "issueDate": { "format": "date-time", "type": "string", "description": "Date when the estimate was issued", "example": "2023-06-15T00:00:00.000Z" }, "expiryDate": { "format": "date-time", "type": "string", "description": "Date when the estimate expires", "example": "2023-07-15T00:00:00.000Z" }, "sentBy": { "type": "string", "description": "User who sent the estimate", "example": "user@example.com" }, "automaticTaxesCalculated": { "type": "boolean", "description": "Indicates if automatic taxes were calculated", "example": true }, "meta": { "type": "object", "description": "Additional metadata associated with the estimate", "example": { "key": "value" } }, "estimateActionHistory": { "description": "History of actions taken on the estimate", "example": [ { "action": "Created", "timestamp": "2023-06-15T10:00:00.000Z" } ], "type": "array", "items": { "type": "string" } }, "sentTo": { "description": "Recipient details for the estimate", "example": { "email": [ "test@example.com" ], "phoneNo": [ "+1 99444444444" ] }, "allOf": [ { "type": "object", "properties": {}, "title": "SentTo" } ] }, "frequencySettings": { "description": "Frequency settings for recurring estimates", "examples": [ { "enabled": false }, { "enabled": true, "schedule": { "rrule": { "intervalType": "monthly", "numOfWeek": 0, "dayOfMonth": 1, "interval": 1, "startDate": "2025-02-12", "endType": "after", "count": "5" } } }, { "enabled": true, "schedule": { "rrule": { "intervalType": "monthly", "numOfWeek": 0, "dayOfMonth": 1, "interval": 1, "startDate": "2025-02-12", "endType": "by", "endDate": "2025-02-24" } } }, { "enabled": true, "schedule": { "rrule": { "intervalType": "monthly", "numOfWeek": 0, "dayOfMonth": 1, "interval": 1, "startDate": "2025-02-12", "endType": "never" } } } ], "allOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "enabled for the frequency settings", "example": true }, "schedule": { "description": "schedule setting for the estimate", "allOf": [ { "type": "object", "properties": { "executeAt": { "type": "string" }, "rrule": { "type": "object", "properties": { "intervalType": { "type": "string", "enum": [ "yearly", "monthly", "weekly", "daily", "hourly", "minutely", "secondly" ], "example": "monthly" }, "interval": { "type": "number", "example": 2 }, "startDate": { "type": "string", "description": "Start date in YYYY-MM-DD format", "example": "2023-01-01" }, "startTime": { "type": "string", "description": "Start time in HH:mm:ss format", "example": "20:45:00" }, "endDate": { "type": "string", "description": "End date in YYYY-MM-DD format", "example": "2029-11-01" }, "endTime": { "type": "string", "description": "End time in HH:mm:ss format", "example": "18:45:00" }, "dayOfMonth": { "type": "number", "description": "-1, 1, 2, 3, ..., 27, 28", "example": 15 }, "dayOfWeek": { "type": "string", "enum": [ "mo", "tu", "we", "th", "fr", "sa", "su" ], "example": "mo" }, "numOfWeek": { "type": "number", "description": "-1, 1, 2, 3, 4", "example": -1 }, "monthOfYear": { "type": "string", "enum": [ "jan", "feb", "mar", "apr", "may", "jun", "jul", "aug", "sep", "oct", "nov", "dec" ], "example": "jan" }, "count": { "type": "number", "description": "Max number of task executions", "example": 10 }, "daysBefore": { "type": "number", "description": "Execute task number of days before", "example": 5 }, "useStartAsPrimaryUserAccepted": { "type": "boolean", "description": "Start as primary user accepted date", "example": true }, "endType": { "type": "string", "description": "End type like after, by, count", "example": "by" } }, "required": [ "intervalType", "interval", "startDate" ], "title": "CustomRRuleOptionsDto" } }, "title": "ScheduleOptionsDto" } ] } }, "required": [ "enabled", "schedule" ], "title": "FrequencySettingsDto" } ] }, "lastVisitedAt": { "format": "date-time", "type": "string", "description": "Timestamp when the estimate was last visited", "example": "2023-06-20T08:30:00.000Z" }, "totalamountInUSD": { "type": "number", "description": "Total amount in USD", "example": 1500.75 }, "autoInvoice": { "description": "Auto-invoice settings for the estimate", "example": { "enabled": true, "directPayments": false }, "allOf": [ { "type": "object", "properties": {}, "title": "AutoInvoice" } ] }, "traceId": { "type": "string", "description": "Trace ID for logging and debugging", "example": "010c7a01-857f-4619-970d-xyxyxyxy" } }, "required": [ "altId", "altType", "_id", "liveMode", "deleted", "name", "currency", "businessDetails", "items", "discount", "total", "createdAt", "updatedAt", "__v", "automaticTaxesEnabled", "companyId", "contactDetails", "issueDate", "expiryDate", "automaticTaxesCalculated", "meta", "estimateActionHistory", "sentTo", "frequencySettings", "lastVisitedAt", "totalamountInUSD", "traceId" ], "title": "EstimateResponseDto" } ] }, "invoice": { "description": "Invoice details", "allOf": [ { "type": "object", "properties": { "_id": { "type": "string", "description": "Invoice Id", "example": "6578278e879ad2646715ba9c" }, "status": { "type": "string", "description": "Invoice Status", "example": "draft", "enum": [ "draft", "sent", "payment_processing", "paid", "void", "partially_paid" ] }, "liveMode": { "type": "boolean", "description": "Live Mode", "example": false }, "amountPaid": { "type": "number", "description": "Amount Paid", "example": 0 }, "altId": { "type": "string", "description": "Location Id or Agency Id", "example": "6578278e879ad2646715ba9c" }, "altType": { "type": "string", "enum": [ "location" ] }, "name": { "type": "string", "description": "Name of the invoice", "example": "New Invoice" }, "businessDetails": { "type": "object", "description": "Business Details", "example": { "name": "Alex", "address": { "addressLine1": "9931 Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "USA", "postalCode": "559-6993" }, "phoneNo": "+1-214-559-6993", "website": "www.example.com" } }, "invoiceNumber": { "type": "number", "description": "Invoice Number", "example": "19" }, "currency": { "type": "string", "description": "Currency", "example": "USD" }, "contactDetails": { "type": "object", "description": "Contact Details", "example": { "id": "c6tZZU0rJBf30ZXx9Gli", "phoneNo": "+1-214-559-6993", "email": "alex@example.com", "customFields": [], "name": "Alex", "address": { "countryCode": "US" } } }, "issueDate": { "type": "string", "description": "Issue date in YYYY-MM-DD format", "example": "2023-01-01" }, "dueDate": { "type": "string", "description": "Due date in YYYY-MM-DD format", "example": "2023-01-01" }, "discount": { "type": "object", "description": "Discount", "example": { "type": "percentage", "value": 0 } }, "invoiceItems": { "description": "Invoice Items", "example": [ { "taxes": [], "_id": "c6tZZU0rJBf30ZXx9Gli", "productId": "c6tZZU0rJBf30ZXx9Gli", "priceId": "c6tZZU0rJBf30ZXx9Gli", "currency": "USD", "name": "Macbook Pro", "qty": 1, "amount": 999 } ], "type": "array", "items": { "type": "string" } }, "total": { "type": "number", "description": "Total Amount", "example": 999 }, "title": { "type": "string", "description": "Title", "example": "INVOICE" }, "amountDue": { "type": "number", "description": "Total Amount Due", "example": 999 }, "createdAt": { "type": "string", "description": "created at", "example": "2023-12-12T09:27:42.355Z" }, "updatedAt": { "type": "string", "description": "updated at", "example": "2023-12-12T09:27:42.355Z" }, "automaticTaxesEnabled": { "type": "boolean", "description": "Automatic taxes enabled for the Invoice", "example": true }, "automaticTaxesCalculated": { "type": "boolean", "description": "Is Automatic taxes calculated for the Invoice items", "example": true }, "paymentSchedule": { "type": "object", "description": "split invoice into payment schedule summing up to full invoice amount" } }, "required": [ "_id", "status", "liveMode", "amountPaid", "altId", "altType", "name", "businessDetails", "invoiceNumber", "currency", "contactDetails", "issueDate", "dueDate", "invoiceItems", "total", "title", "amountDue", "createdAt", "updatedAt" ], "title": "DefaultInvoiceResponseDto" } ] } }, "required": [ "estimate", "invoice" ], "title": "CreateInvoiceFromEstimateResponseDTO" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X POST 'https://services.leadconnectorhq.com/invoices/estimate//invoice' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' \ -H 'Content-Type: application/json' \ --data-raw '{ "altId": "6578278e879ad2646715ba9c", "markAsInvoiced": true, "version": "v2" }' ``` **Node.js** ```javascript const options = { method: 'POST', headers: { Authorization: 'Bearer ', Version: 'v3', 'Content-Type': 'application/json' }, body: JSON.stringify({ "altId": "6578278e879ad2646715ba9c", "markAsInvoiced": true, "version": "v2" }) }; try { const response = await fetch('https://services.leadconnectorhq.com/invoices/estimate//invoice', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/invoices/estimate/{estimateId}/invoice" headers = { "Authorization": "Bearer ", "Version": "v3" } payload = { "altId": "6578278e879ad2646715ba9c", "markAsInvoiced": true, "version": "v2" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/invoices/estimate//invoice', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => '{ "altId": "6578278e879ad2646715ba9c", "markAsInvoiced": true, "version": "v2" }', ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .post("https://services.leadconnectorhq.com/invoices/estimate//invoice") .header("Authorization", "Bearer ") .header("Version", "v3") .header("Content-Type", "application/json") .body("{\"altId\":\"6578278e879ad2646715ba9c\",\"markAsInvoiced\":true,\"version\":\"v2\"}") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" "strings" ) func main() { url := "https://services.leadconnectorhq.com/invoices/estimate//invoice" payload := strings.NewReader(`{ "altId": "6578278e879ad2646715ba9c", "markAsInvoiced": true, "version": "v2" }`) req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/invoices/estimate//invoice") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" request["Content-Type"] = "application/json" request.body = '{ "altId": "6578278e879ad2646715ba9c", "markAsInvoiced": true, "version": "v2" }' response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $body = '{ "altId": "6578278e879ad2646715ba9c", "markAsInvoiced": true, "version": "v2" }' $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/invoices/estimate//invoice' -Method 'POST' -Headers $headers -Body $body -ContentType 'application/json' $response | ConvertTo-Json ```