Skip to main content
GET
/
invoices
/
template
/
{templateId}
Get an template
curl --request GET \
  --url https://services.leadconnectorhq.com/invoices/template/{templateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'
{
  "_id": "6578278e879ad2646715ba9c",
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Template",
  "businessDetails": {
    "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"
  },
  "currency": "USD",
  "items": [
    {
      "taxes": [],
      "_id": "c6tZZU0rJBf30ZXx9Gli",
      "productId": "c6tZZU0rJBf30ZXx9Gli",
      "priceId": "c6tZZU0rJBf30ZXx9Gli",
      "currency": "USD",
      "name": "Macbook Pro",
      "qty": 1,
      "amount": 999
    }
  ],
  "total": 999,
  "createdAt": "2023-12-12T09:27:42.355Z",
  "updatedAt": "2023-12-12T09:27:42.355Z",
  "discount": {
    "type": "percentage",
    "value": 0
  },
  "invoiceNumberPrefix": "INV-"
}

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

Path Parameters

​
templateId
string
required

Template Id

Example:

"6578278e879ad2646715ba9c"

Query Parameters

​
altId
string
required

location Id / company Id based on altType

Example:

"6578278e879ad2646715ba9c"

​
altType
enum<string>
required

Alt Type

Available options:
location
Example:

"location"

Response

Successful response

​
_id
string
required

Template Id

Example:

"6578278e879ad2646715ba9c"

​
altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

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

Name of the Template

Example:

"New Template"

​
businessDetails
object
required
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"
}
​
currency
string
required

Currency

Example:

"USD"

​
items
string[]
required

Invoice Items

Example:
[
  {
    "taxes": [],
    "_id": "c6tZZU0rJBf30ZXx9Gli",
    "productId": "c6tZZU0rJBf30ZXx9Gli",
    "priceId": "c6tZZU0rJBf30ZXx9Gli",
    "currency": "USD",
    "name": "Macbook Pro",
    "qty": 1,
    "amount": 999
  }
]
​
total
number
required

Total Amount

Example:

999

​
createdAt
string
required

created at

Example:

"2023-12-12T09:27:42.355Z"

​
updatedAt
string
required

updated at

Example:

"2023-12-12T09:27:42.355Z"

​
discount
object
Example:
{ "type": "percentage", "value": 0 }
​
invoiceNumberPrefix
string

prefix for invoice number

Example:

"INV-"

Last modified on March 4, 2026