Estimates
An estimate is a quote or an approximation, of the prices, which a seller projects to a buyer. There can be different estimates to different buyers.
Possible error codes:
Error Code | Message |
---|---|
1001 | Estimate Number already exist |
1002 | Estimate does not exist |
2007 | Estimate cannot be raised for items that have been deleted or marked as inactive |
4041 | Estimate status cannot be changed to Draft |
9526 | Please enter a valid retainer percentage. It should be greater than 0 and less than or equal to 100 |
Attribute
place of contact
given for the contact will be taken) business_gst
, business_none
, overseas
, consumer
.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX.draft
, sent
, invoiced
, accepted
, declined
and expired
entity_level
and item_level
Create an Estimate
Create an estimate for your customer.
OAuth Scope : ZohoInvoice.estimates.CREATE
Arguments
place of contact
given for the contact will be taken) business_gst
, business_none
, overseas
, consumer
.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX.entity_level
and item_level
Maximum length [25]
Maximum length [25]
uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered
, if he resides outside of the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).Query Parameters
true
and false
List estimates
List all estimates with pagination.
OAuth Scope : ZohoInvoice.estimates.READ
Query Parameters
Update an Estimate
Update an existing estimate. To delete a line item just remove it from the line_items list.
OAuth Scope : ZohoInvoice.estimates.UPDATE
Arguments
place of contact
given for the contact will be taken) business_gst
, business_none
, overseas
, consumer
.home_country_mexico
,border_region_mexico
,non_mexico
supported only for MX.entity_level
and item_level
Maximum length [25]
Maximum length [25]
uk
. If the customer is in an EU country & VAT registered, you are resides in Northen Ireland and selling Goods then his VAT treatment is eu_vat_registered
, if he resides outside of the UK then his VAT treatment is overseas
(For Pre Brexit, this can be split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).Query Parameters
Get an estimate
Get the details of an estimate.
OAuth Scope : ZohoInvoice.estimates.READ
Query Parameters
json
, pdf
and html
Delete an Estimate
Delete an existing estimate.
OAuth Scope : ZohoInvoice.estimates.DELETE
Update custom field in existing estimates
Update the value of the custom field in existing estimates.
OAuth Scope : ZohoInvoice.estimates.UPDATE
Arguments
Mark an estimate as sent
Mark a draft estimate as sent.
OAuth Scope : ZohoInvoice.estimates.CREATE
Mark an estimate as accepted
Mark a sent estimate as accepted if the customer has accepted it.
OAuth Scope : ZohoInvoice.estimates.CREATE
Mark an estimate as declined
Mark a sent estimate as declined if the customer has rejected it.
OAuth Scope : ZohoInvoice.estimates.CREATE
Email an estimate
Email an estimate to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content.
OAuth Scope : ZohoInvoice.estimates.CREATE
Arguments
Query Parameters
Get estimate email content
Get the email content of an estimate.
OAuth Scope : ZohoInvoice.estimates.READ
Query Parameters
Email multiple estimates
Send estimates to your customers by email. Maximum of 10 estimates can be sent at once.
OAuth Scope : ZohoInvoice.estimates.CREATE
Query Parameters
Bulk export estimates
Maximum of 25 estimates can be exported in a single pdf.
OAuth Scope : ZohoInvoice.estimates.READ
Query Parameters
Bulk print estimates
Export estimates as pdf and print them. Maximum of 25 estimates can be printed.
OAuth Scope : ZohoInvoice.estimates.READ
Query Parameters
Update billing address
Updates the billing address for this estimate alone.
OAuth Scope : ZohoInvoice.estimates.UPDATE
Arguments
Update shipping address
Updates the shipping address for an existing estimate alone.
OAuth Scope : ZohoInvoice.estimates.UPDATE
Arguments
List estimate templates
Get all estimate pdf templates.
OAuth Scope : ZohoInvoice.estimates.READ
Update estimate template
Update the pdf template associated with the estimate.
OAuth Scope : ZohoInvoice.estimates.UPDATE
Add Comments
Add a comment for an estimate.
OAuth Scope : ZohoInvoice.estimates.CREATE
Arguments
List estimate comments & history
Get the complete history and comments of an estimate.
OAuth Scope : ZohoInvoice.estimates.READ
Update comment
Update an existing comment of an estimate.
OAuth Scope : ZohoInvoice.estimates.UPDATE
Arguments
Delete a comment
Delete an estimate comment.
OAuth Scope : ZohoInvoice.estimates.DELETE