Update Estimate Template

PUT 
/invoices/estimate/template/:templateId

Update an existing estimate template

Request

Version stringrequired

API Version

Available optionsv3

templateId stringrequired

Template Id

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
namestringrequired

Estimate Name

businessDetailsobjectrequired
currencystringrequired

Currency code

itemsarray[]required

An array of items for the estimate.

liveModeboolean
livemode for estimate
Default value: true
discountobjectrequired
termsNotesstring

Terms notes, Also supports HTML markups

titlestring

Title for the estimate

automaticTaxesEnabledboolean
Automatic taxes enabled for the Estimate
Default value: false
metaobject

Meta data for the estimate

sendEstimateDetailsobject

When sending estimate directly while saving

estimateNumberPrefixstring
Prefix for the estimate number
Default value: EST-
attachmentsobject[]

attachments for the invoice

miscellaneousChargesobject

miscellaneous charges for the estimate

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "Home Service Estimate 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": "USD",
  "items": [
    null
  ],
  "liveMode": true,
  "discount": {
    "value": 10,
    "type": "percentage",
    "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
  },
  "termsNotes": "<p>This is a default terms.</p>",
  "title": "ESTIMATE",
  "automaticTaxesEnabled": true,
  "meta": {
    "key": "value"
  },
  "sendEstimateDetails": {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "action": "sms_and_email",
    "liveMode": true,
    "userId": "6578278e879ad2646715ba9c",
    "sentFrom": {
      "fromName": "Alex",
      "fromEmail": "[email protected]"
    },
    "estimateName": "Estimate"
  },
  "estimateNumberPrefix": "EST-",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "string",
      "size": 10000
    }
  ],
  "miscellaneousCharges": {
    "charges": [
      null
    ],
    "collectedMiscellaneousCharges": 10,
    "paidCharges": [
      {
        "name": "Processing Fee",
        "charge": 10,
        "amount": 10,
        "_id": "673d01d7d547648a8dab6211"
      }
    ]
  }
}

application/json

Successfully updated

application/json

Schema

Schema

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
_idstringrequired

Unique identifier

liveModebooleanrequired

Indicates if it is in live mode

deletedbooleanrequired

Indicates if deleted

namestringrequired

Name

currencystringrequired

Currency code

businessDetailsobjectrequired

Business details associated with the estimate

itemsarray[]required

An array of items

discountobjectrequired

Discount details for the estimate template

titlestring

Title

estimateNumberPrefixstring

Estimate number prefix

attachmentsobject[]

Attachments

updatedBystring

User Id of who last updated

totalnumberrequired

Total amount

createdAtstring<date-time>required

Timestamp when created

updatedAtstring<date-time>required

Timestamp when last updated

__vnumberrequired

Version number

automaticTaxesEnabledbooleanrequired

Indicates if automatic taxes are enabled for this estimate

termsNotesstring

Terms and conditions for the estimate, supports HTML markup

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "_id": "67ac9a51106ee8311e911XXXX",
  "liveMode": true,
  "deleted": false,
  "name": "Estimate Name",
  "currency": "USD",
  "businessDetails": {
    "logoUrl": "your_image-url",
    "name": "Business name",
    "address": {
      "addressLine1": "address line 1",
      "city": "Test City",
      "state": "State Name",
      "countryCode": "US",
      "postalCode": "12345"
    },
    "phoneNo": "+1 1234567890",
    "website": "www.example.com",
    "customValues": [
      {
        "name": "Test",
        "fieldKey": "{{custom_values.test}}",
        "id": "5DYTWoiQvWiIJZXX44XXX",
        "value": "Test's Custom Value"
      }
    ]
  },
  "items": [
    {
      "taxes": [],
      "taxInclusive": false,
      "_id": "67ac9a51106ee8311e911XXXX",
      "description": "<p>Futuristic anti-gravity racing</p>",
      "currency": "USD",
      "productId": "67ac9a51106ee8311e911XXXX",
      "priceId": "67ac9a51106ee8311e911XXXX",
      "amount": 9.99,
      "qty": 1,
      "name": "TEST",
      "type": "one_time"
    },
    {
      "taxes": [
        {
          "_id": "67ac9a51106ee8311e911XXXX",
          "name": "TaxTwo",
          "rate": 8.5,
          "calculation": "exclusive"
        }
      ],
      "taxInclusive": true,
      "_id": "67ac9a51106ee8311e911XXXX",
      "productId": "67ac9a51106ee8311e911XXXX",
      "priceId": "67ac9a51106ee8311e911XXXX",
      "currency": "USD",
      "name": "TEST2",
      "qty": 1,
      "amount": 500,
      "description": "",
      "type": "recurring"
    }
  ],
  "discount": {
    "type": "percentage",
    "value": 0
  },
  "title": "ESTIMATE",
  "estimateNumberPrefix": "EST-",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "string",
      "size": 10000
    }
  ],
  "updatedBy": "3HIpOF9NIc5ltriQXXXX",
  "total": 1222.03,
  "createdAt": "2025-02-12T13:17:47.416Z",
  "updatedAt": "2025-02-12T13:17:47.416Z",
  "__v": 0,
  "automaticTaxesEnabled": false,
  "termsNotes": "<p>All services are subject to availability.</p>"
}