Skip to main content
TemplateVersion: v3

Get an template

GET/invoices/template/{templateId}

API to get an template by template id

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:invoices/template.readonly
Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

templateIdstringrequired

Template Id

Example:6578278e879ad2646715ba9c

Query Parameters

altIdstringrequired

location Id / company Id based on altType

Example:6578278e879ad2646715ba9c
altTypestringrequired

Alt Type

Available optionslocation
Example:location

Response

Successful response

_idstringrequired

Template Id

Example:6578278e879ad2646715ba9c
altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
namestringrequired

Name of the Template

Example:New Template
businessDetailsobjectrequired

Business Details

currencystringrequired

Currency

Example:USD
discountobject

Discount

itemsstring[]required

Invoice Items

invoiceNumberPrefixstring

prefix for invoice number

Example:INV-
totalnumberrequired

Total Amount

Example:999
createdAtstringrequired

created at

Example:2023-12-12T09:27:42.355Z
updatedAtstringrequired

updated at

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