altIdstringrequired
Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
_idstringrequired
Example:67ac9a51106ee8311e911XXXX
liveModebooleanrequired
Indicates if it is in live mode
Example:true
deletedbooleanrequired
Example:false
namestringrequired
Example:Estimate Name
currencystringrequired
Example:USD
businessDetailsobjectrequired
Business details associated with the estimate
discountobjectrequired
Discount details for the estimate template
discount.valuenumber
Default:0
Example:10
discount.typestringrequired
Available optionspercentagefixed
Example:percentage
discount.validOnProductIdsstring[]
Product Ids on which discount is applicable
Example:[ '6579751d56f60276e5bd4154' ]
titlestring
Example:ESTIMATE
estimateNumberPrefixstring
Example:EST-
attachmentsobject[]
attachments[].idstringrequired
Example:6241712be68f7a98102ba272
attachments[].namestringrequired
Example:Electronics.pdf
attachments[].urlstringrequired
Example:https://example.com/digital-delivery
attachments[].typestringrequired
attachments[].sizenumberrequired
Example:10000
updatedBystring
User Id of who last updated
Example:3HIpOF9NIc5ltriQXXXX
totalnumberrequired
Example:1222.03
createdAtstring<date-time>required
Example:2025-02-12T13:17:47.416Z
updatedAtstring<date-time>required
Timestamp when last updated
Example:2025-02-12T13:17:47.416Z
__vnumberrequired
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
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
frequencySettings.enabledbooleanrequired
enabled for the frequency settings
Example:true
frequencySettings.scheduleobjectrequired
schedule setting for the estimate
frequencySettings.schedule.executeAtstring
frequencySettings.schedule.rruleobject
frequencySettings.schedule.rrule.intervalTypestringrequired
Available optionsyearlymonthlyweeklydailyhourlyminutelysecondly
Example:monthly
frequencySettings.schedule.rrule.intervalnumberrequired
Example:2
frequencySettings.schedule.rrule.startDatestringrequired
Start date in YYYY-MM-DD format
Example:2023-01-01
frequencySettings.schedule.rrule.startTimestring
Start time in HH:mm:ss format
Example:20:45:00
frequencySettings.schedule.rrule.endDatestring
End date in YYYY-MM-DD format
Example:2029-11-01
frequencySettings.schedule.rrule.endTimestring
End time in HH:mm:ss format
Example:18:45:00
frequencySettings.schedule.rrule.dayOfMonthnumber
Example:15
frequencySettings.schedule.rrule.dayOfWeekstring
Available optionsmotuwethfrsasu
Example:mo
frequencySettings.schedule.rrule.numOfWeeknumber
Example:-1
frequencySettings.schedule.rrule.monthOfYearstring
Available optionsjanfebmaraprmayjunjulaugsepoctnovdec
Example:jan
frequencySettings.schedule.rrule.countnumber
Max number of task executions
Example:10
frequencySettings.schedule.rrule.daysBeforenumber
Execute task number of days before
Example:5
frequencySettings.schedule.rrule.useStartAsPrimaryUserAcceptedboolean
Start as primary user accepted date
Example:true
frequencySettings.schedule.rrule.endTypestring
End type like after, by, count
Example:by
lastVisitedAtstring<date-time>required
Timestamp when the estimate was last visited
Example:2023-06-20T08:30:00.000Z
totalamountInUSDnumberrequired
Example:1500.75
autoInvoiceobject
Auto-invoice settings for the estimate
traceIdstringrequired
Trace ID for logging and debugging
Example:010c7a01-857f-4619-970d-xyxyxyxy