Create Estimate Template
Create a new estimate template
POST
/
invoices
/
estimate
/
template
Create Estimate Template
curl --request POST \
--url https://services.leadconnectorhq.com/invoices/estimate/template \
--header 'Content-Type: application/json' \
--header 'Version: <version>' \
--data @- <<EOF
{
"altId": "6578278e879ad2646715ba9c",
"altType": "location",
"name": "Home Service Estimate Template",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"<string>"
]
},
"currency": "USD",
"items": [
"<array>"
],
"discount": {
"type": "percentage",
"value": 10,
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"liveMode": true,
"termsNotes": "<p>This is a default terms.</p>",
"title": "ESTIMATE",
"automaticTaxesEnabled": true,
"meta": {
"key": "value"
},
"estimateNumberPrefix": "EST-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "<string>",
"size": 10000
}
]
}
EOFconst options = {
method: 'POST',
headers: {Version: '<version>', 'Content-Type': 'application/json'},
body: JSON.stringify({
altId: '6578278e879ad2646715ba9c',
altType: 'location',
name: 'Home Service Estimate Template',
businessDetails: {
logoUrl: 'https://example.com/logo.png',
name: 'ABC Corp.',
phoneNo: '+1-214-559-6993',
address: '9931 Beechwood, TX',
website: 'wwww.example.com',
customValues: ['<string>']
},
currency: 'USD',
items: ['<array>'],
discount: {
type: 'percentage',
value: 10,
validOnProductIds: '[ \'6579751d56f60276e5bd4154\' ]'
},
liveMode: true,
termsNotes: '<p>This is a default terms.</p>',
title: 'ESTIMATE',
automaticTaxesEnabled: true,
meta: {key: 'value'},
estimateNumberPrefix: 'EST-',
attachments: [
{
id: '6241712be68f7a98102ba272',
name: 'Electronics.pdf',
url: 'https://example.com/digital-delivery',
type: '<string>',
size: 10000
}
]
})
};
fetch('https://services.leadconnectorhq.com/invoices/estimate/template', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://services.leadconnectorhq.com/invoices/estimate/template"
payload = {
"altId": "6578278e879ad2646715ba9c",
"altType": "location",
"name": "Home Service Estimate Template",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": ["<string>"]
},
"currency": "USD",
"items": ["<array>"],
"discount": {
"type": "percentage",
"value": 10,
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"liveMode": True,
"termsNotes": "<p>This is a default terms.</p>",
"title": "ESTIMATE",
"automaticTaxesEnabled": True,
"meta": { "key": "value" },
"estimateNumberPrefix": "EST-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "<string>",
"size": 10000
}
]
}
headers = {
"Version": "<version>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"altId": "6578278e879ad2646715ba9c",
"altType": "location",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"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"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "<p>Futuristic anti-gravity racing</p>",
"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"
}
],
"discount": {
"type": "percentage",
"value": 0
},
"total": 1222.03,
"createdAt": "2025-02-12T13:17:47.416Z",
"updatedAt": "2025-02-12T13:17:47.416Z",
"__v": 0,
"automaticTaxesEnabled": false,
"title": "ESTIMATE",
"estimateNumberPrefix": "EST-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "<string>",
"size": 10000
}
],
"updatedBy": "3HIpOF9NIc5ltriQXXXX",
"termsNotes": "<p>All services are subject to availability.</p>"
}{
"statusCode": 400,
"message": "Bad Request"
}{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}Body
application/json
Response
Successfully created
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" } ] }
An array of items
Example:
[ { "taxes": [], "taxInclusive": false, "_id": "67ac9a51106ee8311e911XXXX", "description": "<p>Futuristic anti-gravity racing</p>", "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" } ]
Last modified on March 8, 2026
Was this page helpful?
Create Estimate Template
curl --request POST \
--url https://services.leadconnectorhq.com/invoices/estimate/template \
--header 'Content-Type: application/json' \
--header 'Version: <version>' \
--data @- <<EOF
{
"altId": "6578278e879ad2646715ba9c",
"altType": "location",
"name": "Home Service Estimate Template",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": [
"<string>"
]
},
"currency": "USD",
"items": [
"<array>"
],
"discount": {
"type": "percentage",
"value": 10,
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"liveMode": true,
"termsNotes": "<p>This is a default terms.</p>",
"title": "ESTIMATE",
"automaticTaxesEnabled": true,
"meta": {
"key": "value"
},
"estimateNumberPrefix": "EST-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "<string>",
"size": 10000
}
]
}
EOFconst options = {
method: 'POST',
headers: {Version: '<version>', 'Content-Type': 'application/json'},
body: JSON.stringify({
altId: '6578278e879ad2646715ba9c',
altType: 'location',
name: 'Home Service Estimate Template',
businessDetails: {
logoUrl: 'https://example.com/logo.png',
name: 'ABC Corp.',
phoneNo: '+1-214-559-6993',
address: '9931 Beechwood, TX',
website: 'wwww.example.com',
customValues: ['<string>']
},
currency: 'USD',
items: ['<array>'],
discount: {
type: 'percentage',
value: 10,
validOnProductIds: '[ \'6579751d56f60276e5bd4154\' ]'
},
liveMode: true,
termsNotes: '<p>This is a default terms.</p>',
title: 'ESTIMATE',
automaticTaxesEnabled: true,
meta: {key: 'value'},
estimateNumberPrefix: 'EST-',
attachments: [
{
id: '6241712be68f7a98102ba272',
name: 'Electronics.pdf',
url: 'https://example.com/digital-delivery',
type: '<string>',
size: 10000
}
]
})
};
fetch('https://services.leadconnectorhq.com/invoices/estimate/template', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://services.leadconnectorhq.com/invoices/estimate/template"
payload = {
"altId": "6578278e879ad2646715ba9c",
"altType": "location",
"name": "Home Service Estimate Template",
"businessDetails": {
"logoUrl": "https://example.com/logo.png",
"name": "ABC Corp.",
"phoneNo": "+1-214-559-6993",
"address": "9931 Beechwood, TX",
"website": "wwww.example.com",
"customValues": ["<string>"]
},
"currency": "USD",
"items": ["<array>"],
"discount": {
"type": "percentage",
"value": 10,
"validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
},
"liveMode": True,
"termsNotes": "<p>This is a default terms.</p>",
"title": "ESTIMATE",
"automaticTaxesEnabled": True,
"meta": { "key": "value" },
"estimateNumberPrefix": "EST-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "<string>",
"size": 10000
}
]
}
headers = {
"Version": "<version>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"altId": "6578278e879ad2646715ba9c",
"altType": "location",
"_id": "67ac9a51106ee8311e911XXXX",
"liveMode": true,
"deleted": false,
"name": "Estimate Name",
"currency": "USD",
"businessDetails": {
"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"
}
]
},
"items": [
{
"taxes": [],
"taxInclusive": false,
"_id": "67ac9a51106ee8311e911XXXX",
"description": "<p>Futuristic anti-gravity racing</p>",
"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"
}
],
"discount": {
"type": "percentage",
"value": 0
},
"total": 1222.03,
"createdAt": "2025-02-12T13:17:47.416Z",
"updatedAt": "2025-02-12T13:17:47.416Z",
"__v": 0,
"automaticTaxesEnabled": false,
"title": "ESTIMATE",
"estimateNumberPrefix": "EST-",
"attachments": [
{
"id": "6241712be68f7a98102ba272",
"name": "Electronics.pdf",
"url": "https://example.com/digital-delivery",
"type": "<string>",
"size": 10000
}
],
"updatedBy": "3HIpOF9NIc5ltriQXXXX",
"termsNotes": "<p>All services are subject to availability.</p>"
}{
"statusCode": 400,
"message": "Bad Request"
}{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}