EstimateVersion: v3
Preview Estimate Template
GET/invoices/estimate/template/preview
Get a preview of an estimate template
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
invoices/Auth methods:
OAuthPrivate IntegrationToken types:
Sub-Account TokenAgency TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Query Parameters
altIdstringrequired
Location Id or Agency Id
Example:
6578278e879ad2646715ba9caltTypestringrequired
Available options
locationtemplateIdstringrequired
Template Id
Example:
5f9d6d8b1b2d2c001f2d9e4bResponse
Successful response
altIdstringrequired
Location Id or Agency Id
Example:
6578278e879ad2646715ba9caltTypestringrequired
Available options
location_idstringrequired
Unique identifier
Example:
67ac9a51106ee8311e911XXXXliveModebooleanrequired
Indicates if it is in live mode
Example:
truedeletedbooleanrequired
Indicates if deleted
Example:
falsenamestringrequired
Name
Example:
Estimate Namecurrencystringrequired
Currency code
Example:
USDbusinessDetailsobjectrequired
Business details associated with the estimate
itemsarray[]required
An array of items
discountobjectrequired
Discount details for the estimate template
titlestring
Title
Example:
ESTIMATEestimateNumberPrefixstring
Estimate number prefix
Example:
EST-attachmentsobject[]
Attachments
updatedBystring
User Id of who last updated
Example:
3HIpOF9NIc5ltriQXXXXtotalnumberrequired
Total amount
Example:
1222.03createdAtstring<date-time>required
Timestamp when created
Example:
2025-02-12T13:17:47.416ZupdatedAtstring<date-time>required
Timestamp when last updated
Example:
2025-02-12T13:17:47.416Z__vnumberrequired
Version number
Example:
0automaticTaxesEnabledbooleanrequired
Indicates if automatic taxes are enabled for this estimate
Example:
falsetermsNotesstring
Terms and conditions for the estimate, supports HTML markup
Example:
<p>All services are subject to availability.</p>