Skip to main content
GET
Preview Estimate Template

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Query Parameters

altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required
Available options:
location
templateId
string
required

Template Id

Example:

"5f9d6d8b1b2d2c001f2d9e4b"

Response

Successful response

altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required
Available options:
location
_id
string
required

Unique identifier

Example:

"67ac9a51106ee8311e911XXXX"

liveMode
boolean
required

Indicates if it is in live mode

Example:

true

deleted
boolean
required

Indicates if deleted

Example:

false

name
string
required

Name

Example:

"Estimate Name"

currency
string
required

Currency code

Example:

"USD"

businessDetails
object
required
Example:
items
array[]
required

An array of items

Example:
discount
object
required
Example:
total
number
required

Total amount

Example:

1222.03

createdAt
string<date-time>
required

Timestamp when created

Example:

"2025-02-12T13:17:47.416Z"

updatedAt
string<date-time>
required

Timestamp when last updated

Example:

"2025-02-12T13:17:47.416Z"

__v
number
required

Version number

Example:

0

automaticTaxesEnabled
boolean
required

Indicates if automatic taxes are enabled for this estimate

Example:

false

title
string

Title

Example:

"ESTIMATE"

estimateNumberPrefix
string

Estimate number prefix

Example:

"EST-"

attachments
object[]

Attachments

updatedBy
string

User Id of who last updated

Example:

"3HIpOF9NIc5ltriQXXXX"

termsNotes
string

Terms and conditions for the estimate, supports HTML markup

Example:

"<p>All services are subject to availability.</p>"

Last modified on March 8, 2026