Skip to main content
EstimateVersion: v3

Send Estimate

POST/invoices/estimate/{estimateId}/send

API to send estimate by estimate id

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

Path Parameters

estimateIdstringrequired

Estimate Id

Example:5f9d6d8b1b2d2c001f2d9e4b

Body

application/json
altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
actionstringrequired
Available optionssms_and_emailsend_manuallyemailsms
liveModebooleanrequired

livemode for estimate

Example:true
userIdstringrequired

Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this location. This account will serve as the primary channel for all future communications and updates.

Example:6578278e879ad2646715ba9c
sentFromobject

sender details for invoice, valid only if invoice is not sent manually

estimateNamestring

estimate name

Example:Estimate

Response

application/json

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>
companyIdstringrequired

Company identifier associated with the estimate

Example:COMP12345
contactDetailsobjectrequired

Contact details for the estimate

issueDatestring<date-time>required

Date when the estimate was issued

Example:2023-06-15T00:00:00.000Z
expiryDatestring<date-time>required

Date when the estimate expires

Example:2023-07-15T00:00:00.000Z
sentBystring

User who sent the estimate

Example:[email protected]
automaticTaxesCalculatedbooleanrequired

Indicates if automatic taxes were calculated

Example:true
metaobjectrequired

Additional metadata associated with the estimate

estimateActionHistorystring[]required

History of actions taken on the estimate

sentToobjectrequired

Recipient details for the estimate

frequencySettingsobjectrequired

Frequency settings for recurring estimates

lastVisitedAtstring<date-time>required

Timestamp when the estimate was last visited

Example:2023-06-20T08:30:00.000Z
totalamountInUSDnumberrequired

Total amount in USD

Example:1500.75
autoInvoiceobject

Auto-invoice settings for the estimate

traceIdstringrequired

Trace ID for logging and debugging

Example:010c7a01-857f-4619-970d-xyxyxyxy