Home  Estimates

Method name
https://invoice.zoho.com/api/estimates/create

Method type
POST

API description
Adds an estimate in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, XMLString, apikey

Send=true   <!--Optional for sending this estimate to customer-->
                                                            

Sample Request

<Estimate>
    <CustomerID>3000000000338</CustomerID>    <!-- Mandatory -->
    <EstimateDate>2009-09-06</EstimateDate>
    <EstimateNumber>EST 4</EstimateNumber>	
    <!-- Estimate Number will be used only if estimate number auto-generation is disabled otherwise an error will be thrown -->
    <ReferenceNumber>121</ReferenceNumber>
    <ExchangeRate>10</ExchangeRate>	 <!-- Optional	If not passed, default value is 1 -->	
    <Custom.Body>This is the mail content</Custom.Body>	<!-- Optional If not passed, content from Invoice Notification will be used -->
    <Custom.Subject>This is mail subject</Custom.Subject>	  <!-- Optional If not passed, subject from Invoice Notification will be used -->
    <EstimateItems>
        <EstimateItem>
            <ProductID>3000000000332</ProductID>   <!-- Already created Item ID -->
        </EstimateItem>
        <EstimateItem>
            <ItemName>Sample Item</ItemName>	<!-- The item created via the API will not be reflected in the "Sales By Item" reports. -->
            <ItemDescription>Sample Description</ItemDescription>
            <Price>34</Price>    <!-- Price in Customer's Currency -->
            <Tax1Name>PST</Tax1Name>
        </EstimateItem>
    </EstimateItems>
    <Comments>
        <Comment>
            <Description>Comment added to an invoice</Description>    <!-- Optional -->	
        </Comment>
    </Comments>
    <Notes>Estimate Notes will be shown in PDF</Notes>    <!-- Optional -->
    <Terms>Terms and Conditions apply</Terms>    <!-- Optional -->
</Estimate>

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Estimate uri="/api/estimates/3000000211001">
        <EstimateID>3000000211001</EstimateID>
        <CreatedTime>2010-02-02 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-02-02 10:24:45 PST</LastModifiedTime>
        <LastSyncTime>-</LastSyncTime>
        <Source>3</Source>
        <!-- 1-> By user, 2-> Imported, 3-> Via API, 4-> From Zoho Projects, 5-> From Zoho CRM, 6-> From third party services, 7-> Via Recurring profile -->
        <ReferenceID/>
        <EstimateNumber>EST6</EstimateNumber>
        <ReferenceNumber>121</ReferenceNumber>
        <Status>1</Status>   <!-- 1-> Draft, 2-> Sent -->
        <CustomerID>3000000000338</CustomerID>
        <CustomerName>Sample Customer</CustomerName>
        <EstimateDate>2009-09-06</EstimateDate>
        <CurrencyCode>CNY</CurrencyCode>
        <ExchangeRate>10.000000</ExchangeRate>
        <Total>40.390</Total>
        <EstimateItemTotal>37.400</EstimateItemTotal>
        <TaxTotal>2.990</TaxTotal>
        <EstimateItems>
            <EstimateItem>
                <ProductID>3000000000332</ProductID>
                <ItemID>3000000211007</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Sample Description</ItemDescription>
                <Price>3.400000</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name/>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage/>
                <Tax2Name>PST</Tax2Name>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage>8.000000</Tax2Percentage>
                <ItemTotal>3.400</ItemTotal>
            </EstimateItem>
            <EstimateItem>

                <ProductID/>
                <ItemID>3000000211009</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Sample Description</ItemDescription>
                <Price>34.000000</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name>PST</Tax1Name>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage>8.000000</Tax1Percentage>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage/>
                <ItemTotal>34.000</ItemTotal>
            </EstimateItem>
        </EstimateItems>
        <Taxes>
            <Tax>
                <TaxName>PST (8%)</TaxName>
                <TaxAmount>2.990</TaxAmount>
            </Tax>            
        </Taxes>
        <Comments>
            <Comment>
                <CommentID>3000000211005</CommentID>
                <InvoiceID>3000000211001</InvoiceID>
                <Description>Comment added to an invoice</Description>
            </Comment>
        </Comments>
        <Notes>Estimate Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Estimate>
</Response>

Method name
https://invoice.zoho.com/api/view/estimates/create

Method type
POST

API description
Adds an estimate in your Zoho Invoice account and gives a formatted response.

Parameters to be passed
authtoken, scope, XMLString, apikey, Send=true (Optional for sending this estimate to customer)

Sample Request

<Estimate>
    <CustomerID>5000000002010</CustomerID>    <!-- Mandatory -->
    <EstimateDate>2010-05-19</EstimateDate>    
    <ReferenceNumber>125</ReferenceNumber>
    <ExchangeRate>10</ExchangeRate>	 <!-- Optional	If not passed, default value is 1 -->
    <Custom.Body>This is the mail content</Custom.Body>	<!-- Optional If not passed, content from Invoice Notification will be used -->
    <Custom.Subject>This is mail subject</Custom.Subject>	  <!-- Optional If not passed, subject from Invoice Notification will be used -->
    <EstimateItems>
        <EstimateItem>
            <ProductID>5000000002008</ProductID>   <!-- Already created Item ID -->
        </EstimateItem>
        <EstimateItem>
            <ItemName>Sample Item</ItemName>	<!-- The item created via the API will not be reflected in the "Sales By Item" reports. -->
            <ItemDescription>Sample Description</ItemDescription>
            <Price>34</Price>    <!-- Price in Customer's Currency -->
            <Tax1Name>PST</Tax1Name>
        </EstimateItem>
    </EstimateItems>
    <Comments>
        <Comment>
            <Description>Comment added to an invoice</Description>    <!-- Optional -->
        </Comment>
    </Comments>
    <Notes>Estimate Notes will be shown in PDF</Notes>    <!-- Optional -->
    <Terms>Terms and Conditions apply</Terms>    <!-- Optional -->
</Estimate>
                                                        

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Estimate uri="/api/view/estimates/5000000017001">
        <EstimateID>5000000017001</EstimateID>
        <CreatedTime>2010-05-19 19:26:50 PST</CreatedTime>
        <LastModifiedTime>2010-05-19 19:26:50 PST</LastModifiedTime>
        <LastSyncTime/>
        <Source>3</Source>
        <ReferenceID/>
        <EstimateNumber>EST-7</EstimateNumber>
        <EstimateNumber>125</EstimateNumber>
        <Status>Draft</Status>
        <CustomerID>5000000002010</CustomerID>
        <CustomerName>Paul Anderson</CustomerName>
        <EstimateDate>19 May 2010</EstimateDate>        
        <CurrencyCode>USD</CurrencyCode>
        <ExchangeRate>10.000000</ExchangeRate>        
        <Total>$48.55</Total>
        <EstimateItemTotal>$46.00</EstimateItemTotal>
        <TaxTotal>$2.55</TaxTotal>        
        <EstimateItems>
            <EstimateItem>
                <ProductID>5000000002008</ProductID>
                <ItemID>5000000017007</ItemID>
                <ItemName>Hard Drive (Sample)</ItemName>
                <ItemDescription>500GB, USB 2.0 interface 1400 rpm, protective hard case.</ItemDescription>
                <Price>$12.00</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name/>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage/>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage/>
                <ItemTotal>$12.00</ItemTotal>
            </EstimateItem>
            <EstimateItem>
                <ProductID/>
                <ItemID>5000000017009</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Item Created while rasing invoice</ItemDescription>
                <Price>$34.76</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name>PST</Tax1Name>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage>7.500000</Tax1Percentage>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage/>
                <ItemTotal>$34.00</ItemTotal>
            </EstimateItem>
        </EstimateItems>
        <Taxes>
            <Tax>
                <TaxName>PST (7.5%)</TaxName>
                <TaxAmount>$2.55</TaxAmount>
            </Tax>            
        </Taxes>        
        <Comments>
            <Comment>
                <CommentID>5000000017005</CommentID>
                <InvoiceID>5000000017001</InvoiceID>
                <Description>Comment added to an invoice</Description>
            </Comment>
        </Comments>
        <Notes>Estimate Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Estimate>
</Response>
                                                        

Method name
https://invoice.zoho.com/api/estimates/update

Method type
POST

API description
Updates an Estimate. You can change the values of the following fields of an Estimate -

  • ExchangeRate
  • ItemDescription
  • Tax1Name
  • Tax2Name
  • Notes

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Estimate>
    <EstimateID>4000000004297</EstimateID>
    <CustomerID>3000000000328</CustomerID>   <!-- Changes the customer associated with an invoice -->	
    <EstimateItems>
        <EstimateItem>
            <ProductID>3000000000332</ProductID>	 <!-- Adds an item to an existing Estimate -->
        </EstimateItem>
        <EstimateItem delete="true">   <!-- Deletes an item associated with an existing Estimate -->
            <ItemID>3000000000332</ItemID>
        </EstimateItem>
        <Notes></Notes>	<!-- To reset a field, do not specify a value for the tag enclosing this field -->
    </EstimateItems>
</Estimate>

Sample Response
Amounts displayed are in Customer currency.

<Response  status="1">
    <Estimate uri="/api/estimates/3000000209037">
        <EstimateID>3000000209037</EstimateID>
        <CreatedTime>2010-01-31 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-02-02 10:24:45 PST</LastModifiedTime>
        <LastSyncTime>-</LastSyncTime>
        <Source>3</Source>
        <ReferenceID/>
        <EstimateNumber>EST 5</EstimateNumber>
        <ReferenceNumber>121</ReferenceNumber>
        <Status>2</Status>
        <CustomerID>3000000000328</CustomerID>
        <CustomerName>Sample Customer</CustomerName>
        <EstimateDate>2009-09-06</EstimateDate>
        <CurrencyCode>INR</CurrencyCode>
        <ExchangeRate>1.000000</ExchangeRate>
        <Total>70.720</Total>
        <EstimateItems>
            <EstimateItem>
                <ProductID>3000000000332</ProductID>
                <ItemID>3000000204319</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Sample Description</ItemDescription>
                <Price>34.000000</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name/>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage>0.000000</Tax1Percentage>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage>0.000000</Tax2Percentage>
                <ItemTotal>34.000</ItemTotal>
            </EstimateItem>
            <EstimateItem>
                <ProductID>3000000204081</ProductID>
                <ItemID>3000000211031</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Sample Description</ItemDescription>
                <Price>34.000000</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name/>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage/>
                <Tax2Name>PST</Tax2Name>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage>8.000000</Tax2Percentage>
                <ItemTotal>34.000</ItemTotal>
            </EstimateItem>
        </EstimateItems>
        <Comments/>
        <Notes/>
        <Terms>Terms and Conditions apply</Terms>
    </Estimate>
</Response>

Method name
https://invoice.zoho.com/api/view/estimates/update

Method type
POST

API description
Updates an Estimate and gives a formatted response. You can change the values of the following fields of an Invoice.

  • ExchangeRate
  • ItemDescription
  • Tax1Name
  • Tax2Name
  • Notes

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Estimate>
    <EstimateID>5000000017001</EstimateID>
    <EstimateItems>        
        <EstimateItem delete="true">   <!-- Deletes an item associated with an existing Estimate -->
            <ItemID>5000000017009</ItemID>
        </EstimateItem>        
    </EstimateItems>
</Estimate>
                                                        

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Estimate uri="/api/view/estimates/5000000017001">
        <EstimateID>5000000017001</EstimateID>
        <CreatedTime>2010-05-19 19:26:50 PST</CreatedTime>
        <LastModifiedTime>2010-05-19 20:10:45 PST</LastModifiedTime>
        <LastSyncTime/>
        <Source>3</Source>
        <ReferenceID/>
        <EstimateNumber>EST-7</EstimateNumber>
        <EstimateNumber>125</EstimateNumber>
        <Status>Draft</Status>
        <CustomerID>5000000002010</CustomerID>
        <CustomerName>Paul Anderson</CustomerName>
        <EstimateDate>19 May 2010</EstimateDate>
        <CurrencyCode>USD</CurrencyCode>
        <ExchangeRate>10.000000</ExchangeRate>
        <Total>$12.00</Total>
        <EstimateItemTotal>$12.00</EstimateItemTotal>
        <TaxTotal>$0.00</TaxTotal>
        <EstimateItems>
            <EstimateItem>
                <ProductID>5000000002008</ProductID>
                <ItemID>5000000017007</ItemID>
                <ItemName>Hard Drive (Sample)</ItemName>
                <ItemDescription>500GB, USB 2.0 interface 1400 rpm, protective hard case.</ItemDescription>
                <Price>$12.00</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name/>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage/>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage/>
                <ItemTotal>$12.00</ItemTotal>
            </EstimateItem>           
        </EstimateItems>
        </Taxes>
        <Comments>
            <Comment>
                <CommentID>5000000017005</CommentID>
                <InvoiceID>5000000017001</InvoiceID>
                <Description>Comment added to an invoice</Description>
            </Comment>
        </Comments>
        <Notes>Estimate Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Estimate>
</Response>
                                                        

Method name
https://invoice.zoho.com/api/estimates/delete/<Estimate ID>

Method type
POST

API description
Deletes an estimate from your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response  status="1"/>

Method name
https://invoice.zoho.com/api/view/search/estimates/

Method type
GET

API description
Search for an invoice by passing either "Estimate Number" or "Customer Name".Only active estimates will be listed.

Parameters to be passed
authtoken, scope, apikey, searchtext

Sample Response
Amounts displayed are in Customer currency.

<Response  status="1">
    <Estimates uri="/api/view/search/estimates/">
        <Estimate uri="/api/estimates/5000000209037">
            <EstimateID>5000000209037</EstimateID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>Draft</Status>
            <EstimateNumber>EST 5</EstimateNumber>
            <ReferenceNumber>121</ReferenceNumber>
            <EstimateDate>September 06, 2009</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.34.00</Total>
        </Estimate>
        <Estimate uri="/api/estimates/5000000209027">
            <EstimateID>5000000209027</EstimateID>
            <CustomerName>Sample Customer 1</CustomerName>
            <Status>Draft</Status>
            <EstimateNumber>EST 4</EstimateNumber>
            <ReferenceNumber>122</ReferenceNumber>
            <EstimateDate>September 06, 2009</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.73.44</Total>
        </Estimate>
        <Estimate uri="/api/estimates/5000000209019">
            <EstimateID>5000000209019</EstimateID>
            <CustomerName>Sample Customer 2</CustomerName>
            <Status>Draft</Status>
            <EstimateNumber>EST 3</EstimateNumber>
            <ReferenceNumber>123</ReferenceNumber>
            <EstimateDate>September 06, 2009</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.7.34</Total>
        </Estimate>
        <Estimate uri="/api/estimates/5000000182217">
            <EstimateID>5000000182217</EstimateID>
            <CustomerName>Sample Customer 3</CustomerName>
            <Status>Draft</Status>
            <EstimateNumber>EST 2</EstimateNumber>
            <ReferenceNumber>124</ReferenceNumber>
            <EstimateDate>November 23, 2009</EstimateDate>
            <CurrencyCode>CAD</CurrencyCode>
            <Total>$8.000</Total>
        </Estimate>
    </Estimates>
    <PageContext Page="1" Per_Page="200" Total="4" Total_Pages="1"/>
</Response>

How to customize the number of estimates to be shown on a page?

Method name
https://invoice.zoho.com/api/estimates/send

Method type
POST

API description
Sends an estimate to the Customer for whom the estimate was raised.

Parameters to be passed
authtoken, scope, apikey, Custom.Subject, Custom.Body, EstimateID, ToEMailIDs, CCEMailIDs

EMailIDs must be comma separated if there are more than one.

Sample Response

<Response  status="1">
    <Code/>
    <Message>Estimate sent successfully</Message>
</Response>

Method name
https://invoice.zoho.com/api/estimates/pdf

Method type
GET

API description
Generates a PDF for an estimate.

Parameters to be passed
authtoken, scope, apikey, EstimateID

Response
In case of success, you can get the PDF content from the Input Stream of the request. PDF will be written in the Input Stream with content type "application/pdf". Whereas in case of failure, an error response in the form of XML containing both error code and error message will be returned.

Method name
https://invoice.zoho.com/api/estimates/markassent/<Estimate ID>

Method type
POST

API description
Marks an estimate as sent.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response  status="1"/>

Method name
https://invoice.zoho.com/api/estimates/

Method type
GET

API description
View list of active estimates in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response
Amounts displayed are in Customer currency.

<Response  status="1">
    <Estimates uri="/api/estimates/">
        <Estimate uri="/api/estimates/3000000209037">
            <EstimateID>3000000209037</EstimateID>
            <CustomerName>Sample Customer</CustomerName>
	    <Status>2</Status>	<!-- 1-> Draft, 2-> Sent -->
            <EstimateNumber>EST 5</EstimateNumber>
            <ReferenceNumber>121</ReferenceNumber>
            <EstimateDate>2009-09-06</EstimateDate>
            <CurrencyCode>CAD</CurrencyCode>
            <Total>34.000</Total>
        </Estimate>
        <Estimate uri="/api/estimates/3000000209027">
            <EstimateID>3000000209027</EstimateID>
            <CustomerName>Sample Customer 1</CustomerName>
            <Status>1</Status>
            <EstimateNumber>EST 4</EstimateNumber>
            <ReferenceNumber>122</ReferenceNumber>
            <EstimateDate>2009-09-06</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>73.440</Total>
        </Estimate>
        <Estimate uri="/api/estimates/3000000209019">
            <EstimateID>3000000209019</EstimateID>
            <CustomerName>Sample Customer 2</CustomerName>
            <Status>1</Status>
            <EstimateNumber>EST 3</EstimateNumber>
            <ReferenceNumber>123</ReferenceNumber>
            <EstimateDate>2009-09-06</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>7.340</Total>
        </Estimate>
    </Estimates>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>

How to customize the number of estimates to be shown on a page?

Method name
https://invoice.zoho.com/api/view/estimates/

Method type
GET

API description
View list of active estimates in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Estimates uri="/api/view/estimates/">
        <Estimate uri="/api/estimates/3000000209037">
            <EstimateID>3000000209037</EstimateID>
            <CustomerName>Sample Customer</CustomerName>
	    <Status>Sent</Status>	<!-- 1-> Draft, 2-> Sent -->
            <EstimateNumber>EST 5</EstimateNumber>
            <ReferenceNumber>121</ReferenceNumber>
            <EstimateDate>September 06, 2009</EstimateDate>
            <CurrencyCode>GBP</CurrencyCode>
            <Total>GBP34.000</Total>
        </Estimate>
        <Estimate uri="/api/estimates/4000000209027">
            <EstimateID>4000000209027</EstimateID>
            <CustomerName>Sample Customer 1</CustomerName>
            <Status>Draft</Status>
            <EstimateNumber>EST 4</EstimateNumber>
            <ReferenceNumber>122</ReferenceNumber>
            <EstimateDate>September 06, 2009</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.73.44</Total>
        </Estimate>
        <Estimate uri="/api/estimates/5000000209019">
            <EstimateID>5000000209019</EstimateID>
            <CustomerName>Sample Customer 2</CustomerName>
            <Status>Draft</Status>
            <EstimateNumber>EST 3</EstimateNumber>
            <ReferenceNumber>123</ReferenceNumber>
            <EstimateDate>September 06, 2009</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.7.34</Total>
        </Estimate>
    </Estimates>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>

How to customize the number of estimates to be shown on a page?

Method name
https://invoice.zoho.com/api/estimates/<Estimate ID>

Method type
GET

API description
View detailed information of a particular estimate.

Parameters to be passed
authtoken, scope, apikey

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Estimate uri="/api/estimates/3000000209037">
        <EstimateID>3000000209037</EstimateID>
        <CreatedTime>2010-01-31 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-02-01 10:24:45 PST</LastModifiedTime>
        <LastSyncTime>-</LastSyncTime>
        <Source>3</Source>
        <ReferenceID/>
        <EstimateNumber>EST 5</EstimateNumber>
        <ReferenceNumber>121</ReferenceNumber>
        <Status>2</Status>
        <CustomerID>3000000120021</CustomerID>
        <CustomerName>Sample Customer</CustomerName>
        <EstimateDate>2009-09-06</EstimateDate>
        <CurrencyCode>CAD</CurrencyCode>
        <ExchangeRate>1.000000</ExchangeRate>
        <Total>34.000</Total>
        <EstimateItems>
            <EstimateItem>
                <ProductID>3000000204081</ProductID>
                <ItemID>3000000204319</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Sample Description</ItemDescription>
                <Price>34.000000</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name/>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage/>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage/>
                <ItemTotal>34.000</ItemTotal>
            </EstimateItem>
        </EstimateItems>
        <Comments/>
        <Notes>Estimate Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Estimate>
</Response>

Method name
https://invoice.zoho.com/api/view/estimates/<Estimate ID>

Method type
GET

API description
View detailed information of a particular estimate.

Parameters to be passed
authtoken, scope, apikey

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Estimate uri="/api/view/estimates/3000000209037">
        <EstimateID>3000000209037</EstimateID>
        <CreatedTime>2010-02-25 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-02-25 10:24:45 PST</LastModifiedTime>
        <LastSyncTime>-</LastSyncTime>
        <Source>3</Source>
        <ReferenceID/>
        <EstimateNumber>EST 5</EstimateNumber>
        <ReferenceNumber>121</ReferenceNumber>
        <Status>Sent</Status>
        <CustomerID>3000000120021</CustomerID>
        <CustomerName>Sample Customer</CustomerName>
        <EstimateDate>September 06, 2009</EstimateDate>
        <CurrencyCode>CNY</CurrencyCode>
        <ExchangeRate>1.000000</ExchangeRate>
        <Total>CNY71.310</Total>
        <EstimateItemTotal>CNY68.760</EstimateItemTotal>
        <TaxTotal>CNY0.000</TaxTotal>
        <EstimateItems>
            <EstimateItem>
                <ProductID>3000000204081</ProductID>
                <ItemID>3000000204319</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Sample Description</ItemDescription>
                <Price>CNY 34.000</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name/>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage/>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage/>
                <ItemTotal>CNY34.000</ItemTotal>
            </EstimateItem>
            <EstimateItem>
                <ProductID/>
                <ItemID>5000000017009</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Item Created while rasing invoice</ItemDescription>
                <Price>CNY 34.76</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name>PST</Tax1Name>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage>7.500000</Tax1Percentage>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage/>
                <ItemTotal>CNY34.76</ItemTotal>
            </EstimateItem>
        </EstimateItems>
        <Taxes>
            <Tax>
                <TaxName>PST (7.5%)</TaxName>
                <TaxAmount>CNY2.55</TaxAmount>
            </Tax>
        </Taxes>    
        <Comments/>
        <Notes>Estimate Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Estimate>
</Response>

Method name
https://invoice.zoho.com/api/estimates/customer/<Customer ID>

Method type
GET

API description
View list of estimates for a given customer in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response
Amounts displayed are in Customer currency.

<Response  status="1">
    <Estimates uri="/api/estimates/customer/5000000007007">
        <Estimate uri="/api/estimates/3000000209037">
            <EstimateID>3000000209037</EstimateID>
            <CustomerName>Sample Customer</CustomerName>
	    <Status>2</Status>	<!-- 1-> Draft, 2-> Sent -->
            <EstimateNumber>EST 5</EstimateNumber>
            <ReferenceNumber>121</ReferenceNumber>
            <EstimateDate>2009-09-06</EstimateDate>
            <CurrencyCode>CAD</CurrencyCode>
            <Total>34.000</Total>
        </Estimate>
        <Estimate uri="/api/estimates/3000000209027">
            <EstimateID>3000000209027</EstimateID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>1</Status>
            <EstimateNumber>EST 4</EstimateNumber>
            <ReferenceNumber>122</ReferenceNumber>
            <EstimateDate>2009-09-06</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>73.440</Total>
        </Estimate>
        <Estimate uri="/api/estimates/3000000209019">
            <EstimateID>3000000209019</EstimateID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>1</Status>
            <EstimateNumber>EST 3</EstimateNumber>
            <ReferenceNumber>123</ReferenceNumber>
            <EstimateDate>2009-09-06</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>7.340</Total>
        </Estimate>
    </Estimates>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>
                                                        

How to customize the number of estimates to be shown on a page?

Method name
https://invoice.zoho.com/api/view/estimates/customer/<Customer ID>

Method type
GET

API description
View list of estimates of a given customer in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Estimates uri="/api/view/estimates/customer/5000000007007">
        <Estimate uri="/api/estimates/3000000209037">
            <EstimateID>3000000209037</EstimateID>
            <CustomerName>Sample Customer</CustomerName>
	    <Status>Sent</Status>	<!-- 1-> Draft, 2-> Sent -->
            <EstimateNumber>EST 5</EstimateNumber>
            <ReferenceNumber>121</ReferenceNumber>
            <EstimateDate>September 06, 2009</EstimateDate>
            <CurrencyCode>GBP</CurrencyCode>
            <Total>GBP34.000</Total>
        </Estimate>
        <Estimate uri="/api/estimates/4000000209027">
            <EstimateID>4000000209027</EstimateID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>Draft</Status>
            <EstimateNumber>EST 4</EstimateNumber>
            <ReferenceNumber>122</ReferenceNumber>
            <EstimateDate>September 06, 2009</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.73.44</Total>
        </Estimate>
        <Estimate uri="/api/estimates/5000000209019">
            <EstimateID>5000000209019</EstimateID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>Draft</Status>
            <EstimateNumber>EST 3</EstimateNumber>
            <ReferenceNumber>123</ReferenceNumber>
            <EstimateDate>September 06, 2009</EstimateDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.7.34</Total>
        </Estimate>
    </Estimates>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>
                                                        

How to customize the number of estimates to be shown on a page?

Using "PageContext" tag you can customize the number of estimates you would like to view per page. Pass "Per_Page" parameter in the request.

    <PageContext Page="1" Per_Page="200" Total="2" Total_Pages="1"/>

For navigating to next page, pass "Page" parameter in the request

In the above example,

Page The current page you are viewing.
Total_Pages Total pages present.
Per_Page Number of estimates per page (Default value is 200).
Total Total estimates present.

In Zoho Invoice, the View APIs are of two types - Formatted and Unformatted.

Formatted APIs are used to display the values in the client. The date shown will be formatted based on the date format selected in the settings page. Currency code will be appended to the Invoice Total, balance, Item Total, Price, Payment Amount shown and the amount will also be formatted based on the currency format selected in the Currency settings page.

Unformatted APIs are used for processing values in the program. The date will be shown in the default format "yyyy-MM-dd". The amounts shown will not be formatted.

Got more questions?

Submit your request to us and we will help you out.

Zoho Invoice API

Spread the Word

© 2013, ZOHO Corp. Invoice Software 4900 Hopyard Rd, Suite 310, Pleasanton, CA 94588, USA Support: +1 888-900-9646 | Sales: +1 888-204-3539,