Skip to main content
POST
/
invoices
/
estimate
/
template
Create Estimate Template
curl --request POST \
  --url https://services.leadconnectorhq.com/invoices/estimate/template \
  --header 'Authorization: Bearer <token>' \
  --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"
  },
  "sendEstimateDetails": {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "action": "sms_and_email",
    "liveMode": true,
    "userId": "6578278e879ad2646715ba9c",
    "sentFrom": {
      "fromName": "Alex",
      "fromEmail": "alex@example.com"
    },
    "estimateName": "Estimate"
  },
  "estimateNumberPrefix": "EST-",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "<string>",
      "size": 10000
    }
  ],
  "miscellaneousCharges": {
    "charges": [
      "<array>"
    ],
    "collectedMiscellaneousCharges": 10,
    "paidCharges": [
      {
        "name": "Processing Fee",
        "charge": 10,
        "amount": 10,
        "_id": "673d01d7d547648a8dab6211"
      }
    ]
  }
}
EOF
{
  "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>"
}

Authorizations

Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Body

application/json
altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required
Available options:
location
name
string
required

Estimate Name

Example:

"Home Service Estimate Template"

businessDetails
object
required
currency
string
required

Currency code

Example:

"USD"

items
array[]
required

An array of items for the estimate.

discount
object
required
liveMode
boolean
default:true

livemode for estimate

Example:

true

termsNotes
string

Terms notes, Also supports HTML markups

Example:

"<p>This is a default terms.</p>"

title
string

Title for the estimate

Example:

"ESTIMATE"

automaticTaxesEnabled
boolean
default:false

Automatic taxes enabled for the Estimate

Example:

true

meta
object

Meta data for the estimate

Example:
{ "key": "value" }
sendEstimateDetails
object
estimateNumberPrefix
string
default:EST-

Prefix for the estimate number

Example:

"EST-"

attachments
object[]

attachments for the invoice

miscellaneousCharges
object

Response

Successfully created

altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required
Available options:
location
_id
string
required

Unique identifier

Example:

"67ac9a51106ee8311e911XXXX"

liveMode
boolean
required

Indicates if it is in live mode

Example:

true

deleted
boolean
required

Indicates if deleted

Example:

false

name
string
required

Name

Example:

"Estimate Name"

currency
string
required

Currency code

Example:

"USD"

businessDetails
object
required
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"
}
]
}
items
array[]
required

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"
}
]
discount
object
required
Example:
{ "type": "percentage", "value": 0 }
total
number
required

Total amount

Example:

1222.03

createdAt
string<date-time>
required

Timestamp when created

Example:

"2025-02-12T13:17:47.416Z"

updatedAt
string<date-time>
required

Timestamp when last updated

Example:

"2025-02-12T13:17:47.416Z"

__v
number
required

Version number

Example:

0

automaticTaxesEnabled
boolean
required

Indicates if automatic taxes are enabled for this estimate

Example:

false

title
string

Title

Example:

"ESTIMATE"

estimateNumberPrefix
string

Estimate number prefix

Example:

"EST-"

attachments
object[]

Attachments

updatedBy
string

User Id of who last updated

Example:

"3HIpOF9NIc5ltriQXXXX"

termsNotes
string

Terms and conditions for the estimate, supports HTML markup

Example:

"<p>All services are subject to availability.</p>"

Last modified on March 4, 2026