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
.draft
, sent
, invoiced
, accepted
, declined
and expired
entity_level
and item_level
{
"estimate_id": 982000000567011,
"estimate_number": "EST-00002",
"date": "2013-11-18",
"reference_number": "QRT-12346",
"is_pre_gst": false,
"place_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"status": "draft",
"customer_id": 982000000567001,
"customer_name": "Bowman & Co",
"contact_persons": [
"982000000567003",
"982000000567019"
],
"currency_id": 982000000000190,
"currency_code": "USD",
"exchange_rate": 1,
"expiry_date": "2013-11-30",
"discount": 0,
"is_discount_before_tax": true,
"discount_type": "item_level",
"is_inclusive_tax": false,
"line_items": [
{
"item_id": " ",
"name": "Hard Drive",
"description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.",
"item_order": 1,
"bcy_rate": 120,
"rate": 120,
"quantity": 1,
"unit": " ",
"discount_amount": 0,
"discount": 0,
"tax_id": 982000000557028,
"tax_name": "VAT",
"tax_type": "tax",
"tax_percentage": 12.5,
"item_total": 120
}
],
"shipping_charge": 0,
"adjustment": 0,
"adjustment_description": " ",
"sub_total": 153,
"total": 40.6,
"tax_total": 22.6,
"price_precision": 2,
"taxes": [
{
"tax_name": "VAT",
"tax_amount": 19.13
}
],
"billing_address": {
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": 1234
},
"shipping_address": {
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": 1234
},
"notes": "Looking forward for your business.",
"terms": "Terms & Conditions apply",
"custom_fields": [
{
"customfield_id": 439910000000236000,
"data_type": "number",
"index": 1,
"label": "Delivery Date",
"show_on_pdf": false,
"show_in_all_pdf": true,
"value": "15 Dec 2013"
}
],
"template_id": 982000000000143,
"template_name": "Service - Classic",
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T04:46:45-0500",
"salesperson_id": 982000000567003,
"salesperson_name": "Will smith",
"project": {
"project_id": 90300000087378,
"project_name": "Sample Project"
}
}
Create an Estimate
Create an estimate for your customer. oauthscope : ZohoInvoice.estimates.CREATE
Arguments
place of contact
given for the contact will be taken) business_gst
, business_none
, overseas
, consumer
.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
$ curl https://invoice.zoho.com/api/v3/estimates
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"customer_id": 982000000567001,
"contact_persons": [
"982000000567003",
"982000000567019"
],
"template_id": 982000000000143,
"place_of_supply": "TN",
"gst_treatment": "business_gst",
"gst_no": "22AAAAA0000A1Z5",
"estimate_number": "EST-00002",
"reference_number": "QRT-12346",
"date": "2013-11-18",
"expiry_date": "2013-11-30",
"exchange_rate": 1,
"discount": 0,
"is_discount_before_tax": true,
"discount_type": "item_level",
"is_inclusive_tax": false,
"custom_body": " ",
"custom_subject": " ",
"salesperson_name": "Will smith",
"custom_fields": [
{
"label": "Delivery Date",
"value": "15 Dec 2013"
}
],
"line_items": [
{
"item_id": " ",
"name": "Hard Drive",
"description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.",
"item_order": 1,
"rate": 120,
"product_type": "goods",
"hsn_or_sac": 80540,
"quantity": 1,
"unit": " ",
"discount_amount": 0,
"discount": 0,
"tax_id": 982000000557028,
"tax_exemption_id": 11149000000061054,
"avatax_tax_code": "string",
"avatax_use_code": "string",
"tax_name": "VAT",
"tax_type": "tax",
"tax_percentage": 12.5,
"item_total": 120
}
],
"notes": "Looking forward for your business.",
"terms": "Terms & Conditions apply",
"shipping_charge": 0,
"adjustment": 0,
"adjustment_description": " ",
"tax_id": 982000000557028,
"tax_exemption_id": 11149000000061054,
"tax_authority_id": 11149000000061052,
"avatax_use_code": "string",
"avatax_tax_code": "string",
"avatax_exempt_no": "string",
"vat_treatment": "string",
"project_id": 90300000087378
}
{
"code": 0,
"message": "The estimate has been created",
"estimate": {
"estimate_id": 982000000567011,
"estimate_number": "EST-00002",
"date": "2013-11-18",
"reference_number": "QRT-12346",
"is_pre_gst": false,
"place_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"status": "draft",
"customer_id": 982000000567001,
"customer_name": "Bowman & Co",
"contact_persons": [
"982000000567003",
"982000000567019"
],
"currency_id": 982000000000190,
"currency_code": "USD",
"exchange_rate": 1,
"expiry_date": "2013-11-30",
"discount": 0,
"is_discount_before_tax": true,
"discount_type": "item_level",
"is_inclusive_tax": false,
"line_items": [
{
"item_id": " ",
"name": "Hard Drive",
"description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.",
"item_order": 1,
"bcy_rate": 120,
"rate": 120,
"quantity": 1,
"unit": " ",
"discount_amount": 0,
"discount": 0,
"tax_id": 982000000557028,
"tax_name": "VAT",
"tax_type": "tax",
"tax_percentage": 12.5,
"item_total": 120
}
],
"shipping_charge": 0,
"adjustment": 0,
"adjustment_description": " ",
"sub_total": 153,
"total": 40.6,
"tax_total": 22.6,
"price_precision": 2,
"taxes": [
{
"tax_name": "VAT",
"tax_amount": 19.13
}
],
"billing_address": {
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": 1234
},
"shipping_address": {
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": 1234
},
"notes": "Looking forward for your business.",
"terms": "Terms & Conditions apply",
"custom_fields": [
{
"customfield_id": 439910000000236000,
"data_type": "number",
"index": 1,
"label": "Delivery Date",
"show_on_pdf": false,
"show_in_all_pdf": true,
"value": "15 Dec 2013"
}
],
"template_id": 982000000000143,
"template_name": "Service - Classic",
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T04:46:45-0500",
"salesperson_id": 982000000567003,
"salesperson_name": "Will smith",
"project": {
"project_id": 90300000087378,
"project_name": "Sample Project"
}
}
}
List estimates
List all estimates with pagination. oauthscope : ZohoInvoice.estimates.READ
$ curl https://invoice.zoho.com/api/v3/estimates
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"estimates": [
{
"estimate_id": 982000000567011,
"customer_name": "Bowman & Co",
"customer_id": 982000000567001,
"status": "draft",
"estimate_number": "EST-00002",
"reference_number": "QRT-12346",
"date": "2013-11-18",
"currency_id": 982000000000190,
"currency_code": "USD",
"total": 40.6,
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T04:46:45-0500",
"accepted_date": " ",
"declined_date": " ",
"expiry_date": "2013-11-30",
"has_attachment": false,
"is_viewed_by_client": true,
"client_viewed_time": "2016-06-19T05:49:12-0500"
},
{...},
{...}
]
}
Update an Estimate
Update an existing estimate. To delete a line item just remove it from the line_items list. oauthscope : ZohoInvoice.estimates.UPDATE
Arguments
place of contact
given for the contact will be taken) business_gst
, business_none
, overseas
, consumer
.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
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}
-X PUT
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"customer_id": 982000000567001,
"contact_persons": [
"982000000567003",
"982000000567019"
],
"template_id": 982000000000143,
"place_of_supply": "TN",
"gst_treatment": "business_gst",
"gst_no": "22AAAAA0000A1Z5",
"estimate_number": "EST-00002",
"reference_number": "QRT-12346",
"date": "2013-11-18",
"expiry_date": "2013-11-30",
"exchange_rate": 1,
"discount": 0,
"is_discount_before_tax": true,
"discount_type": "item_level",
"is_inclusive_tax": false,
"custom_body": " ",
"custom_subject": " ",
"salesperson_name": "Will smith",
"custom_fields": [
{
"label": "Delivery Date",
"value": "15 Dec 2013"
}
],
"line_items": [
{
"item_id": " ",
"name": "Hard Drive",
"description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.",
"item_order": 1,
"rate": 120,
"quantity": 1,
"product_type": "goods",
"hsn_or_sac": 80540,
"unit": " ",
"discount_amount": 0,
"discount": 0,
"tax_id": 982000000557028,
"tax_exemption_id": 11149000000061054,
"avatax_tax_code": "string",
"avatax_use_code": "string",
"tax_name": "VAT",
"tax_type": "tax",
"tax_percentage": 12.5,
"item_total": 120
}
],
"notes": "Looking forward for your business.",
"terms": "Terms & Conditions apply",
"shipping_charge": 0,
"adjustment": 0,
"adjustment_description": " ",
"tax_id": 982000000557028,
"tax_exemption_id": 11149000000061054,
"tax_authority_id": 11149000000061052,
"avatax_use_code": "string",
"avatax_tax_code": "string",
"avatax_exempt_no": "string",
"vat_treatment": "string",
"project_id": 90300000087378
}
{
"code": 0,
"message": "Estimate information has been updated.",
"estimate": {
"estimate_id": 982000000567011,
"estimate_number": "EST-00002",
"date": "2013-11-18",
"reference_number": "QRT-12346",
"is_pre_gst": false,
"place_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"status": "draft",
"customer_id": 982000000567001,
"customer_name": "Bowman & Co",
"contact_persons": [
"982000000567003",
"982000000567019"
],
"currency_id": 982000000000190,
"currency_code": "USD",
"exchange_rate": 1,
"expiry_date": "2013-11-30",
"discount": 0,
"is_discount_before_tax": true,
"discount_type": "item_level",
"is_inclusive_tax": false,
"line_items": [
{
"item_id": " ",
"name": "Hard Drive",
"description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.",
"item_order": 1,
"bcy_rate": 120,
"rate": 120,
"quantity": 1,
"unit": " ",
"discount_amount": 0,
"discount": 0,
"tax_id": 982000000557028,
"tax_name": "VAT",
"tax_type": "tax",
"tax_percentage": 12.5,
"item_total": 120
}
],
"shipping_charge": 0,
"adjustment": 0,
"adjustment_description": " ",
"sub_total": 153,
"total": 40.6,
"tax_total": 22.6,
"price_precision": 2,
"taxes": [
{
"tax_name": "VAT",
"tax_amount": 19.13
}
],
"billing_address": {
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": 1234
},
"shipping_address": {
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": 1234
},
"notes": "Looking forward for your business.",
"terms": "Terms & Conditions apply",
"custom_fields": [
{
"customfield_id": 439910000000236000,
"data_type": "number",
"index": 1,
"label": "Delivery Date",
"show_on_pdf": false,
"show_in_all_pdf": true,
"value": "15 Dec 2013"
}
],
"template_id": 982000000000143,
"template_name": "Service - Classic",
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T04:46:45-0500",
"salesperson_id": 982000000567003,
"salesperson_name": "Will smith",
"project": {
"project_id": 90300000087378,
"project_name": "Sample Project"
}
}
}
Get an estimate
Get the details of an estimate. oauthscope : ZohoInvoice.estimates.READ
Query Parameters
json
, pdf
and html
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"estimate": {
"estimate_id": 982000000567011,
"estimate_number": "EST-00002",
"date": "2013-11-18",
"reference_number": "QRT-12346",
"is_pre_gst": false,
"place_of_supply": "TN",
"gst_no": "22AAAAA0000A1Z5",
"gst_treatment": "business_gst",
"status": "draft",
"customer_id": 982000000567001,
"customer_name": "Bowman & Co",
"contact_persons": [
"982000000567003",
"982000000567019"
],
"currency_id": 982000000000190,
"currency_code": "USD",
"exchange_rate": 1,
"expiry_date": "2013-11-30",
"discount": 0,
"is_discount_before_tax": true,
"discount_type": "item_level",
"is_inclusive_tax": false,
"is_viewed_by_client": true,
"client_viewed_time": "2016-06-19T05:49:12-0500",
"line_items": [
{
"item_id": " ",
"name": "Hard Drive",
"description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.",
"item_order": 1,
"bcy_rate": 120,
"rate": 120,
"quantity": 1,
"unit": " ",
"discount_amount": 0,
"discount": 0,
"tax_id": 982000000557028,
"tax_name": "VAT",
"tax_type": "tax",
"tax_percentage": 12.5,
"item_total": 120
}
],
"shipping_charge": 0,
"adjustment": 0,
"adjustment_description": " ",
"sub_total": 153,
"total": 40.6,
"tax_total": 22.6,
"price_precision": 2,
"taxes": [
{
"tax_name": "VAT",
"tax_amount": 19.13
}
],
"billing_address": {
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": 1234
},
"shipping_address": {
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": 1234
},
"custom_fields": [
{
"customfield_id": 439910000000236000,
"data_type": "number",
"index": 1,
"label": "Delivery Date",
"show_on_pdf": false,
"show_in_all_pdf": true,
"value": "15 Dec 2013"
}
],
"template_id": 982000000000143,
"template_name": "Service - Classic",
"created_time": "2013-11-18T02:17:40-0800",
"last_modified_time": "2013-12-18T04:46:45-0500",
"salesperson_id": 982000000567003,
"salesperson_name": "Will smith",
"project": {
"project_id": 90300000087378,
"project_name": "Sample Project"
}
}
}
Delete an Estimate
Delete an existing estimate. oauthscope : ZohoInvoice.estimates.DELETE
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}
-X DELETE
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "The estimate has been deleted."
}
Mark an estimate as sent
Mark a draft estimate as sent. oauthscope : ZohoInvoice.estimates.CREATE
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/status/sent
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "Estimate status has been changed to Sent"
}
Mark an estimate as accepted
Mark a sent estimate as accepted if the customer has accepted it. oauthscope : ZohoInvoice.estimates.CREATE
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/status/accepted
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "Estimate status has been changed to Accepted."
}
Mark an estimate as declined
Mark a sent estimate as declined if the customer has rejected it. oauthscope : ZohoInvoice.estimates.CREATE
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/status/declined
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "Estimate status has been changed to Declined."
}
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. oauthscope : ZohoInvoice.estimates.CREATE
Arguments
Query Parameters
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/email
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"send_from_org_email_id": false,
"to_mail_ids": [
"test@zylker.org"
],
"cc_mail_ids": [
"test@zylker.org"
],
"subject": "Statement of transactions with Zillium Inc",
"body": "Dear Customer, Thanks for your business enquiry. The estimate EST-000002 is attached with this email. We can get started if you send us your consent. For any assistance you can reach us via email or phone. Looking forward to hearing back from you. Here's an overview of the estimate for your reference. Estimate Overview: Estimate : EST-000002 Date : 03 Oct 2013 Amount : $36.47 Regards<br>\\nZillium Inc<br>\\n\"\""
}
{
"code": 0,
"message": "Your estimate has been sent."
}
Get estimate email content
Get the email content of an estimate. oauthscope : ZohoInvoice.estimates.READ
Query Parameters
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/email
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"body": "Dear Customer, Thanks for your business enquiry. The estimate EST-000002 is attached with this email. We can get started if you send us your consent. For any assistance you can reach us via email or phone. Looking forward to hearing back from you. Here's an overview of the estimate for your reference. Estimate Overview: Estimate : EST-000002 Date : 03 Oct 2013 Amount : $36.47 Regards<br>\\nZillium Inc<br>\\n\"\"",
"error_list": [],
"subject": "Statement of transactions with Zillium Inc",
"emailtemplates": [
{
"selected": true,
"name": "Default",
"email_template_id": 982000000000079
}
],
"to_contacts": [
{
"first_name": "David",
"selected": true,
"phone": "1234",
"email": "string",
"last_name": "Sujin",
"salutation": ":Mr",
"contact_person_id": "982000000567003",
"mobile": "1234"
}
],
"file_name": "EST-00001.pdf",
"from_emails": [
{
"user_name": "John Smith",
"selected": true,
"email": "string"
}
],
"customer_id": 982000000567001
}
Email multiple estimates
Send estimates to your customers by email. Maximum of 10 estimates can be sent at once. oauthscope : ZohoInvoice.estimates.CREATE
Query Parameters
$ curl https://invoice.zoho.com/api/v3/estimates/email
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "Mission accomplished! We've sent all the estimates."
}
Bulk export estimates
Maximum of 25 estimates can be exported in a single pdf. oauthscope : ZohoInvoice.estimates.READ
Query Parameters
$ curl https://invoice.zoho.com/api/v3/estimates/pdf
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success"
}
Bulk print estimates
Export estimates as pdf and print them. Maximum of 25 estimates can be printed. oauthscope : ZohoInvoice.estimates.READ
Query Parameters
$ curl https://invoice.zoho.com/api/v3/estimates/print
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success"
}
Update billing address
Updates the billing address for this estimate alone. oauthscope : ZohoInvoice.estimates.UPDATE
Arguments
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/address/billing
-X PUT
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"address": "B-1104, 11F, \nHorizon International Tower, \nNo. 6, ZhiChun Road, HaiDian District,",
"city": "Beijing",
"state": "Beijing",
"zip": 1000881,
"country": "China",
"fax": "+86-10-82637827"
}
{
"code": 0,
"message": "Billing address updated"
}
Update shipping address
Updates the shipping address for an existing estimate alone. oauthscope : ZohoInvoice.estimates.UPDATE
Arguments
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/address/shipping
-X PUT
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"address": "4900 Hopyard Rd, Suite 310",
"city": "Pleasanton",
"state": "CA",
"zip": 94588,
"country": "U.S.A",
"fax": 1234
}
{
"code": 0,
"message": "Shipping address updated"
}
List estimate templates
Get all estimate pdf templates. oauthscope : ZohoInvoice.estimates.READ
$ curl https://invoice.zoho.com/api/v3/estimates/templates
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"templates": {
"template_name": "Service - Classic",
"template_id": 982000000000143,
"template_type": "classic"
}
}
Update estimate template
Update the pdf template associated with the estimate. oauthscope : ZohoInvoice.estimates.UPDATE
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/templates/{template_id}
-X PUT
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "Estimate information has been updated."
}
Add Comments
Add a comment for an estimate. oauthscope : ZohoInvoice.estimates.CREATE
Arguments
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/comments
-X POST
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"description": "Estimate marked as sent",
"show_comment_to_clients": true
}
{
"code": 0,
"message": "Comments added"
}
List estimate comments & history
Get the complete history and comments of an estimate. oauthscope : ZohoInvoice.estimates.READ
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/comments
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "success",
"comments": [
{
"comment_id": 982000000567019,
"estimate_id": 982000000567011,
"description": "Estimate created",
"commented_by_id": 982000000554041,
"commented_by": "David Sujin",
"comment_type": "system",
"date": "2013-11-18",
"date_description": "yesterday",
"time": "2:02 AM",
"operation_type": "Added",
"transaction_id": " ",
"transaction_type": "estimate"
},
{...},
{...}
]
}
Update comment
Update an existing comment of an estimate. oauthscope : ZohoInvoice.estimates.UPDATE
Arguments
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/comments/{comment_id}
-X PUT
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'
{
"description": "Estimate created",
"show_comment_to_clients": " "
}
{
"code": 0,
"message": "Comment has been updated successfully.",
"comment": {
"comment_id": 982000000567019,
"estimate_id": 982000000567011,
"description": "500GB, USB 2.0 interface 1400 rpm, protective hard case.",
"commented_by_id": 982000000554041,
"commented_by": "David Sujin",
"date": "2013-11-18",
"date_description": "yesterday",
"time": "2:02 AM",
"comment_type": "system"
}
}
Delete a comment
Delete an estimate comment. oauthscope : ZohoInvoice.estimates.DELETE
$ curl https://invoice.zoho.com/api/v3/estimates/{estimate_id}/comments/{comment_id}
-X DELETE
-H "X-com-zoho-invoice-organizationid: 10234695"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
{
"code": 0,
"message": "The comment has been deleted."
}