List templates

GEThttps://services.leadconnectorhq.com/invoices/template
API to get list of templates
Request

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

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

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

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Query Parameters
endAt
string

endAt in YYYY-MM-DD format

Examples:
2023-01-01
paymentMode
string

payment mode

Allowed values:
defaultlivetest
Examples:
live
search
string

To search for an invoice by id / name / email / phoneNo

Examples:
Alex
startAt
string

startAt in YYYY-MM-DD format

Examples:
2023-01-01
status
string

status to be filtered

altId
string
required

location Id / company Id based on altType

Examples:
6578278e879ad2646715ba9c
altType
string
required

Alt Type

Allowed value:
location
Examples:
location
limit
string
required

Limit the number of items to return

Examples:
10
offset
string
required

Number of items to skip

Examples:
10
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

data
array[object]
required
_id
string
required

Template Id

Example:
6578278e879ad2646715ba9c
altId
string
required

Location Id or Agency Id

Example:
6578278e879ad2646715ba9c
altType
string
required
Allowed value:
location
name
string
required

Name of the Template

Example:
New Template
businessDetails
object
required

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"}
logoUrl
string

Business Logo URL

Example:
https://example.com/logo.png
name
string

Business Name

Example:
ABC Corp.
phoneNo
string

Business Phone Number

Example:
+1-214-559-6993
address
object

Business Address

Example:
9931 Beechwood, TX
addressLine1
string

Address Line 1

Example:
9931 Beechwood
addressLine2
string

Address Line 2

Example:
Beechwood
city
string

City

Example:
St. Houston
state
string

State

Example:
TX
countryCode
string

Country Code

Example:
US
postalCode
string

Postal Code

Example:
559-6993
website
string

Business Website Link

Example:
wwww.example.com
customValues
array[string]

Custom Values

currency
string
required

Currency

Example:
USD
discount
object

Discount

Example:
{"type":"percentage","value":0}
value
number

Discount Value

Default:
0
Example:
10
type
string
required

Discount type

Allowed values:
percentagefixed
Default:
percentage
Example:
percentage
validOnProductIds
array[string]

Product Ids on which discount is applicable

Example:
[ '6579751d56f60276e5bd4154' ]
items
array[string]
required

Invoice Items

Example:
[{"taxes":[],"_id":"c6tZZU0rJBf30ZXx9Gli","productId":"c6tZZU0rJBf30ZXx9Gli","priceId":"c6tZZU0rJBf30ZXx9Gli","currency":"USD","name":"Macbook Pro","qty":1,"amount":999}]
invoiceNumberPrefix
string

prefix for invoice number

Example:
INV-
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
totalCount
number
required

Total number of Templates

Example:
100

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request