List templates

GET 
/invoices/template

API to get list of templates

Request

Version stringrequired

API Version

Available optionsv3

altId stringrequired

location Id / company Id based on altType

altType stringrequired

Alt Type

Available optionslocation

status string

status to be filtered

startAt string

startAt in YYYY-MM-DD format

endAt string

endAt in YYYY-MM-DD format

search string

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

paymentMode string

payment mode

Available optionsdefaultlivetest

limit stringrequired

Limit the number of items to return

offset stringrequired

Number of items to skip

application/json

Successful response

application/json

Schema

Schema

dataobject[]required
totalCountnumberrequired

Total number of Templates

Example (auto)

{
  "data": [
    {
      "_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"
    }
  ],
  "totalCount": 100
}