Update template

PUT 
/invoices/template/:templateId

API to update an template by template id

Request

Version stringrequired

API Version

Available optionsv3

templateId stringrequired

Template Id

application/json

application/json

Body

Bodyrequired

altIdstringrequired

location Id / company Id based on altType

altTypestringrequired
Alt Type
Available optionslocation
internalboolean
namestringrequired

Name of the template

businessDetailsobjectrequired
currencystringrequired
itemsobject[]required
discountobject
termsNotesstring
titlestring

Template title

miscellaneousChargesobject

miscellaneous charges for the invoice

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "internal": true,
  "name": "New Template",
  "businessDetails": {
    "logoUrl": "https://example.com/logo.png",
    "name": "ABC Corp.",
    "phoneNo": "+1-214-559-6993",
    "address": "9931 Beechwood, TX",
    "website": "wwww.example.com",
    "customValues": [
      "string"
    ]
  },
  "currency": "string",
  "items": [
    {
      "name": "ABC Product",
      "description": "ABC Corp.",
      "productId": "6578278e879ad2646715ba9c",
      "priceId": "6578278e879ad2646715ba9c",
      "currency": "USD",
      "amount": 999,
      "qty": 1,
      "taxes": [
        {
          "_id": "string",
          "name": "string",
          "rate": 0,
          "calculation": "exclusive",
          "description": "string",
          "taxId": "string"
        }
      ],
      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",
      "isSetupFeeItem": true,
      "type": "one_time",
      "taxInclusive": true
    }
  ],
  "discount": {
    "value": 10,
    "type": "percentage",
    "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
  },
  "termsNotes": "string",
  "title": "New Template",
  "miscellaneousCharges": {
    "charges": [
      null
    ],
    "collectedMiscellaneousCharges": 10,
    "paidCharges": [
      {
        "name": "Processing Fee",
        "charge": 10,
        "amount": 10,
        "_id": "673d01d7d547648a8dab6211"
      }
    ]
  }
}

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