Skip to main content
GET
/
invoices
/
estimate
/
template
/
preview
Preview Estimate Template
curl --request GET \
  --url https://services.leadconnectorhq.com/invoices/estimate/template/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'
{
  "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

Query Parameters

​
altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

​
altType
enum<string>
required
Available options:
location
​
templateId
string
required

Template Id

Example:

"5f9d6d8b1b2d2c001f2d9e4b"

Response

Successful response

​
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