Create template

POSThttps://services.leadconnectorhq.com/invoices/template
API to create a template
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
Body
altId
string
required

location Id / company Id based on altType

Example:
6578278e879ad2646715ba9c
altType
string
required

Alt Type

Allowed value:
location
Example:
location
internal
boolean
name
string
required

Name of the template

Example:
New Template
businessDetails
object
required
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
items
array[object]
required
name
string
required

Invoice Item Name

Example:
ABC Product
description
string

Invoice descriptions

Example:
ABC Corp.
productId
string

Product Id

Example:
6578278e879ad2646715ba9c
priceId
string

Price Id

Example:
6578278e879ad2646715ba9c
currency
string
required

Currency

Example:
USD
amount
number
required

Product amount

Example:
999
qty
number
required

Product Quantity

Example:
1
taxes
array[object]

Tax

_id
string
required
name
string
required
rate
number
required
calculation
string
required
Allowed value:
exclusive
description
string
taxId
string
automaticTaxCategoryId
string

Tax category id for calculating automatic tax

Example:
6578278e879ad2646715ba9c
isSetupFeeItem
boolean

Setupfee item, only created when 1st invoice of recurring schedule is generated

type
string

Price type of the item

Allowed values:
one_timerecurring
Example:
one_time
taxInclusive
boolean

true if item amount is tax inclusive

Default:
false
Example:
true
automaticTaxesEnabled
boolean

Automatic taxes enabled for the Invoice

Example:
true
discount
object
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' ]
termsNotes
string
title
string

Template title

Example:
New Template
tipsConfiguration
object

Configuration for tips on invoices

tipsPercentage
array[string]
required

Percentage of tips allowed

Example:
[5,10,15]
tipsEnabled
boolean
required

Tips enabled status

Example:
true
lateFeesConfiguration
object

Late fees configuration for the invoices

enable
boolean
required

Enable late fees

Example:
true
value
number
required

Late Fees Value

Example:
10
type
string
required

Late Fees Type

Allowed values:
fixedpercentage
Example:
fixed
frequency
object
required

Late Fees Frequency

intervalCount
number

Late fees interval count

Example:
10
interval
string
required

Late fees interval

Allowed values:
minutehourdayweekmonthone_time
Example:
day
grace
object

Late Fees Grace

intervalCount
number
required

Late fees grace interval count

Example:
10
interval
string
required

Late fees grace interval

Allowed value:
day
Example:
day
maxLateFees
object

Max late fees payable

type
string
required
Allowed value:
fixed
Example:
fixed
value
number
required

10

Example:
Max late fees to pay
invoiceNumberPrefix
string

prefix for invoice number

Example:
INV-
paymentMethods
object

Payment Methods for Invoices

stripe
object
required

Payment Method

enableBankDebitOnly
boolean
required

Enable Bank Debit Only

Example:
false
attachments
array[string]

attachments for the invoice

Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

responses
/
200
_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
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

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