Get an template

GET 
/invoices/template/:templateId

API to get an template by template id

Request

Version stringrequired

API Version

Available optionsv3

templateId stringrequired

Template Id

altId stringrequired

location Id / company Id based on altType

altType stringrequired

Alt Type

Available optionslocation

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

Template Id

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
namestringrequired

Name of the Template

businessDetailsobjectrequired

Business Details

currencystringrequired

Currency

discountobject

Discount

itemsstring[]required

Invoice Items

invoiceNumberPrefixstring

prefix for invoice number

totalnumberrequired

Total Amount

createdAtstringrequired

created at

updatedAtstringrequired

updated at

Example (auto)

{
  "_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",
  "discount": {
    "type": "percentage",
    "value": 0
  },
  "items": [
    {
      "taxes": [],
      "_id": "c6tZZU0rJBf30ZXx9Gli",
      "productId": "c6tZZU0rJBf30ZXx9Gli",
      "priceId": "c6tZZU0rJBf30ZXx9Gli",
      "currency": "USD",
      "name": "Macbook Pro",
      "qty": 1,
      "amount": 999
    }
  ],
  "invoiceNumberPrefix": "INV-",
  "total": 999,
  "createdAt": "2023-12-12T09:27:42.355Z",
  "updatedAt": "2023-12-12T09:27:42.355Z"
}