Skip to main content
EstimateVersion: v3

Create Estimate Template

POST/invoices/estimate/template

Create a new estimate template

Authorizations

Authorizationstringheaderrequired

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

Scope:invoices/estimate.write
Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Body

application/json
altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
namestringrequired

Estimate Name

Example:Home Service Estimate Template
businessDetailsobjectrequired
currencystringrequired

Currency code

Example:USD
itemsarray[]required

An array of items for the estimate.

liveModeboolean

livemode for estimate

Default:true
Example:true
discountobjectrequired
termsNotesstring

Terms notes, Also supports HTML markups

Example:<p>This is a default terms.</p>
titlestring

Title for the estimate

Example:ESTIMATE
automaticTaxesEnabledboolean

Automatic taxes enabled for the Estimate

Default:false
Example:true
metaobject

Meta data for the estimate

sendEstimateDetailsobject

When sending estimate directly while saving

estimateNumberPrefixstring

Prefix for the estimate number

Default:EST-
Example:EST-
attachmentsobject[]

attachments for the invoice

miscellaneousChargesobject

miscellaneous charges for the estimate

Response

application/json

Successfully created

altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
_idstringrequired

Unique identifier

Example:67ac9a51106ee8311e911XXXX
liveModebooleanrequired

Indicates if it is in live mode

Example:true
deletedbooleanrequired

Indicates if deleted

Example:false
namestringrequired

Name

Example:Estimate Name
currencystringrequired

Currency code

Example:USD
businessDetailsobjectrequired

Business details associated with the estimate

itemsarray[]required

An array of items

discountobjectrequired

Discount details for the estimate template

titlestring

Title

Example:ESTIMATE
estimateNumberPrefixstring

Estimate number prefix

Example:EST-
attachmentsobject[]

Attachments

updatedBystring

User Id of who last updated

Example:3HIpOF9NIc5ltriQXXXX
totalnumberrequired

Total amount

Example:1222.03
createdAtstring<date-time>required

Timestamp when created

Example:2025-02-12T13:17:47.416Z
updatedAtstring<date-time>required

Timestamp when last updated

Example:2025-02-12T13:17:47.416Z
__vnumberrequired

Version number

Example:0
automaticTaxesEnabledbooleanrequired

Indicates if automatic taxes are enabled for this estimate

Example:false
termsNotesstring

Terms and conditions for the estimate, supports HTML markup

Example:<p>All services are subject to availability.</p>