Home  Invoices

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

Method type
POST

API description
Adds an invoice in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, XMLString, apikey

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

Sample Request

<Invoice>
    <CustomerID>3000000000330</CustomerID>   <!-- Mandatory -->
    <InvoiceDate>2009-12-21</InvoiceDate>
    <InvoiceNumber>INV-112</InvoiceNumber>   <!-- Invoice Number should be used only if invoice number auto-generation is disabled otherwise an error will be thrown -->
    <PONumber>121</PONumber>
    <ExchangeRate>10</ExchangeRate>   <!-- If not passed, default value is 1 -->	
    <Custom.Body>This is the mail content</Custom.Body>   <!-- If not passed, content from Invoice Notification will be used -->
    <Custom.Subject>This is mail subject</Custom.Subject>   <!-- If not passed, subject from Invoice Notification will be used -->
    <LFName>Flat fee daily</LFName>
    <PaymentGateways>
        <PayPal>1</PayPal>    <!-- Allowed values: 0 -> Not Selected, 1 -> PayPal Standard, 2 -> PayPal Business Payments -->
        <Authorize.Net>false</Authorize.Net>    <!-- Allowed values: true / false -->
        <GoogleCheckout>false</GoogleCheckout>    <!-- Allowed values: true / false -->
    </PaymentGateways>
    <InvoiceItems>
        <InvoiceItem>
            <ProductID>3000000000320</ProductID>   <!-- Already created Item ID -->
        </InvoiceItem>
        <InvoiceItem>
            <ItemName>Sample Item</ItemName>   <!-- The item created via this API will not be reflected in the "Sales By Item" reports. -->
            <ItemDescription>Item Created while rasing invoice</ItemDescription>
            <Price>24.76</Price>
            <Quantity>2</Quantity>
            <Discount>10</Discount>
            <Tax1Name>PST</Tax1Name>				
            <Tax2Name>VAT</Tax2Name>				
        </InvoiceItem>
    </InvoiceItems>
    <Comments>
        <Comment>
            <Description>Comment added to an invoice</Description>
        </Comment>
    </Comments>
    <Notes>Invoice Notes will be shown in PDF</Notes>
    <Terms>Terms and Conditions apply</Terms>
</Invoice>
                                                        

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Invoice uri="/api/invoices/3000000211033">
        <InvoiceID>3000000211033</InvoiceID>
        <CreatedTime>2010-02-02 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-02-02 10:24:45 PST</LastModifiedTime>
        <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/>
        <InvoiceNumber>INV-296</InvoiceNumber>
    	<PONumber>121</PONumber>
        <Status>4</Status>   <!-- 1-> Draft, 2-> Open, 3-> Closed, 4 -> Overdue 5 -> void -->
        <CustomerID>3000000000330</CustomerID>
        <CustomerName>Sample Customer</CustomerName>
        <InvoiceDate>2009-12-21</InvoiceDate>
        <PaymentsDue>0</PaymentsDue>  <!-- 0 -> Due on receipt -->
        <DueDate>2009-12-21</DueDate>
        <CurrencyCode>INR</CurrencyCode>
        <ExchangeRate>10.000000</ExchangeRate>
        <LFName>Flat fee daily</LFName>
        <LateFeeAmount>0.000</LateFeeAmount>
        <Total>57.380</Total>
        <InvoiceItemTotal>47.970</InvoiceItemTotal>
        <TaxTotal>9.410</TaxTotal>
        <Balance>57.380</Balance>
        <PaymentGateways>
            <PayPal>1</PayPal>    <!-- 0 -> Not Selected, 1 -> PayPal Standard, 2 -> PayPal Business Payments -->
        </PaymentGateways>
        <InvoiceItems>
            <InvoiceItem>
                <ProductID>3000000000320</ProductID>
                <ItemID>3000000211045</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>
            </InvoiceItem>
            <InvoiceItem>
                <ProductID/>
                <ItemID>3000000211047</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Item Created while rasing invoice</ItemDescription>
                <Price>24.760000</Price>
                <Quantity>2.000000</Quantity>
                <Discount>10.00</Discount>
                <Tax1Name>PST</Tax1Name>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage>8.000000</Tax1Percentage>
                <Tax2Name>VAT</Tax2Name>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage>12.500000</Tax2Percentage>
                <ItemTotal>44.570</ItemTotal>
            </InvoiceItem>
        </InvoiceItems>
        <Taxes>
            <Tax>
                <TaxName>PST (8%)</TaxName>
                <TaxAmount>3.840</TaxAmount>
            </Tax>
            <Tax>
                <TaxName>VAT (12.5%)</TaxName>
                <TaxAmount>5.570</TaxAmount>
            </Tax>
        </Taxes>
        <Payments/>
        <Comments>
            <Comment>
                <CommentID>3000000211041</CommentID>
                <InvoiceID>3000000211033</InvoiceID>
                <Description>Comment added to an invoice</Description>
            </Comment>
        </Comments>
        <Notes>Invoice Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Invoice>
</Response>
                                                        

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

Method type
POST

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

Parameters to be passed
authtoken, scope, XMLString, apikey

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

Sample Request

<Invoice>
    <CustomerID>5000000002010</CustomerID>   <!-- Mandatory -->
    <InvoiceDate>2010-05-18</InvoiceDate>
    <PONumber>122</PONumber>
    <ExchangeRate>10</ExchangeRate>   <!-- If not passed, default value is 1 -->
    <Custom.Body>This is the mail content</Custom.Body>   <!-- If not passed, content from Invoice Notification will be used -->
    <Custom.Subject>This is mail subject</Custom.Subject>   <!-- If not passed, subject from Invoice Notification will be used -->
    <PaymentGateways>
        <Authorize.Net>true</Authorize.Net>    <!-- Allowed values: true / false -->
    </PaymentGateways>
    <InvoiceItems>
        <InvoiceItem>
            <ProductID>5000000002008</ProductID>   <!-- Already created Item ID -->
        </InvoiceItem>
        <InvoiceItem>
            <ItemName>Sample Item</ItemName>   <!-- The item created via this API will not be reflected in the "Sales By Item" reports. -->
            <ItemDescription>Item Created while rasing invoice</ItemDescription>
            <Price>24.76</Price>
            <Quantity>2</Quantity>
            <Discount>10</Discount>
            <Tax1Name>PST</Tax1Name>
            <Tax2Name>VAT</Tax2Name>
        </InvoiceItem>
    </InvoiceItems>
    <Notes>Invoice Notes will be shown in PDF</Notes>
    <Terms>Terms and Conditions apply</Terms>
</Invoice>
                                                        

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Invoice uri="/api/view/invoices/2000000204251">
        <InvoiceID>5000000014005</InvoiceID>
        <CreatedTime>2010-05-18 18:52:32 PST</CreatedTime>
        <LastModifiedTime>2010-05-18 18:52:32 PST</LastModifiedTime>
        <LastSyncTime/>
        <Source>3</Source>
        <ReferenceID/>
        <InvoiceNumber>INV-293</InvoiceNumber>
        <PONumber>122</PONumber>
        <Status>Draft</Status>
        <CustomerID>5000000002010</CustomerID>
        <CustomerName>Paul Anderson</CustomerName>
        <InvoiceDate>18 May 2010</InvoiceDate>
        <PaymentsDue>Net 15</PaymentsDue>
        <DueDate>02 Jun 2010</DueDate>
        <CurrencyCode>USD</CurrencyCode>
        <ExchangeRate>10.000000</ExchangeRate>
        <LFName/>
        <LateFeeAmount>$0.00</LateFeeAmount>
        <Total>$66.82</Total>
        <InvoiceItemTotal>$ 56.57</InvoiceItemTotal>
        <TaxTotal>$10.25</TaxTotal>
        <Payment>$0.00</Payment>
        <CreditsApplied>$0.00</CreditsApplied>
        <Balance>$66.82</Balance>
        <PaymentGateways>
            <Authorize.Net>true</Authorize.Net>
        </PaymentGateways>
        <InvoiceItems>
            <InvoiceItem>
                <ProductID>5000000002008</ProductID>
                <ItemID>5000000014011</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>
            </InvoiceItem>
            <InvoiceItem>
                <ProductID/>
                <ItemID>5000000014013</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Item Created while rasing invoice</ItemDescription>
                <Price>$24.76</Price>
                <Quantity>2.000000</Quantity>
                <Discount>10.00</Discount>
                <Tax1Name>PST</Tax1Name>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage>7.500000</Tax1Percentage>
                <Tax2Name>VAT</Tax2Name>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage>15.500000</Tax2Percentage>
                <ItemTotal>$44.57</ItemTotal>
            </InvoiceItem>
        </InvoiceItems>
        <Taxes>
            <Tax>
                <TaxName>PST (7.5%)</TaxName>
                <TaxAmount>$3.34</TaxAmount>
            </Tax>
            <Tax>
                <TaxName>VAT (15.5%)</TaxName>
                <TaxAmount>$6.91</TaxAmount>
            </Tax>
        </Taxes>
        <Payments/>
        <Comments/>
        <Notes>Invoice Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Invoice>
</Response>
                                                        

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

Method type
POST

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

  • PaymentsDue
  • LFName
  • ExchangeRate
  • ItemDescription
  • Tax1Name
  • Tax2Name
  • Description - Payment Description
  • Notes

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Invoice>
    <InvoiceID>4000000004297</InvoiceID>
    <CustomerID>3000000000328</CustomerID>   <!-- Changes the customer associated with an invoice -->
    <LFName></LFName>   <!-- To reset a field, do not specify a value for the tag enclosing this field -->
    <InvoiceItems>
        <InvoiceItem>
            <ProductID>4000000003005</ProductID>   <!-- Adds an item to an existing Invoice -->	
        </InvoiceItem>
        <InvoiceItem delete="true">   <!-- Deletes an item associated with an existing Invoice. -->
            <ItemID>4000000003005</ItemID>
        </InvoiceItem>        
    </InvoiceItems>					
</Invoice>

                                                        

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Invoice uri="/api/invoices/4000000004297">
	<InvoiceID>4000000004297</InvoiceID>
        <CreatedTime>2010-01-28 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-02-02 10:24:45 PST</LastModifiedTime>
        <LastSyncTime>-</LastSyncTime>
        <Source>3</Source>
        <ReferenceID/>
        <InvoiceNumber>INV-291</InvoiceNumber>
    	<PONumber>121</PONumber>
        <Status>4</Status>
        <CustomerID>3000000000328</CustomerID>
        <CustomerName>Sample Customer 1</CustomerName>
        <InvoiceDate>2009-12-21</InvoiceDate>
        <PaymentsDue>0</PaymentsDue>
        <DueDate>2009-12-21</DueDate>
        <CurrencyCode>INR</CurrencyCode>
        <ExchangeRate>1.000000</ExchangeRate>
        <LFName/>
        <LateFeeAmount>0.000</LateFeeAmount>
        <Total>36.720</Total>
        <Balance>36.720</Balance>
        <PaymentGateways>
            <PayPal>1</PayPal>    <!-- 0 -> Not Selected, 1 -> PayPal Standard, 2 -> PayPal Business Payments -->
        </PaymentGateways>
        <InvoiceItems>
            <InvoiceItem>
                <ProductID>4000000003005</ProductID>
                <ItemID>4000000211051</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>
            </InvoiceItem>
        </InvoiceItems>
        <Payments/>
        <Comments/>
        <Notes>Invoice Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Invoice>
</Response>
                                                        

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

Method type
POST

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

  • PaymentsDue
  • LFName
  • ExchangeRate
  • ItemDescription
  • Tax1Name
  • Tax2Name
  • Description - Payment Description
  • Notes

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Invoice>
    <InvoiceID>5000000014005</InvoiceID>
    <InvoiceItems>        
        <InvoiceItem delete="true">   <!-- Deletes an item associated with an existing Invoice. -->
            <ItemID>5000000014013</ItemID>
        </InvoiceItem>
    </InvoiceItems>
</Invoice>

                                                        

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Invoice uri="/api/view/invoices/2000000204251">
        <InvoiceID>5000000014005</InvoiceID>
        <CreatedTime>2010-05-18 18:52:32 PST</CreatedTime>
        <LastModifiedTime>2010-05-19 12:02:13 PST</LastModifiedTime>
        <LastSyncTime/>
        <Source>3</Source>
        <ReferenceID/>
        <InvoiceNumber>INV-293</InvoiceNumber>
        <PONumber>122</PONumber>
        <Status>Draft</Status>
        <CustomerID>5000000002010</CustomerID>
        <CustomerName>Paul Anderson</CustomerName>
        <InvoiceDate>18 May 2010</InvoiceDate>
        <PaymentsDue>Net 15</PaymentsDue>
        <DueDate>02 Jun 2010</DueDate>
        <CurrencyCode>USD</CurrencyCode>
        <ExchangeRate>10.000000</ExchangeRate>
        <LFName/>
        <LateFeeAmount>$0.00</LateFeeAmount>
        <Total>$12.00</Total>
        <InvoiceItemTotal>$12.00</InvoiceItemTotal>
        <TaxTotal>$0.00</TaxTotal>
        <Payment>$0.00</Payment>
        <CreditsApplied>$0.00</CreditsApplied>
        <Balance>$12.00</Balance>
        <PaymentGateways>
            <PayPal>Standard</PayPal>
        </PaymentGateways>
        <InvoiceItems>
            <InvoiceItem>
                <ProductID>5000000002008</ProductID>
                <ItemID>5000000014011</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>
            </InvoiceItem>
        </InvoiceItems>
        <Taxes/>
        <Payments/>
        <Comments/>
        <Notes>Invoice Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Invoice>
</Response>
                                                        

Method name
https://invoice.zoho.com/api/invoices/delete/<Invoice ID>

Method type
POST

API description
Deletes an invoice 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/invoices/

Method type
GET

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

Parameters to be passed
authtoken, scope, apikey, searchtext

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Invoices uri="/api/view/search/invoices/">
    	<Invoice uri="/api/invoices/3000000004297">
            <InvoiceID>3000000004297</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>Open</Status>
            <InvoiceNumber>INV-295</InvoiceNumber>
            <PONumber>121</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2010</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.36.72</Total>
            <Balance>Rs.36.72</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/3000000204263">
            <InvoiceID>3000000204263</InvoiceID>
            <CustomerName>Sample Customer 1</CustomerName>
            <Status>Open</Status>
            <InvoiceNumber>INV-293</InvoiceNumber>
            <PONumber>122</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2010</DueDate>
            <CurrencyCode>JPY</CurrencyCode>
            <Total>JPY38.250</Total>
            <Balance>JPY38.250</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/3000000204251">
            <InvoiceID>3000000204251</InvoiceID>
            <CustomerName>Sample Customer 2</CustomerName>
            <Status>Overdue</Status>
            <InvoiceNumber>INV-292</InvoiceNumber>
            <PONumber>123</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2009</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.428.25</Total>
            <Balance>Rs.418.25</Balance>
        </Invoice>	
    </Invoices>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>
                                                        

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

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

Method type
POST

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

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

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

Sample Response

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

Method name
https://invoice.zoho.com/api/invoices/sendreminder

Method type
POST

API description
Sends a payment reminder for an invoice. If the payment is due, overdue reminder is sent

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

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

Sample Response

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

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

Method type
GET

API description
Generates a PDF for an invoice.

Parameters to be passed
authtoken, scope, apikey, InvoiceID

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/invoices/converttoopen/<Invoice ID>

Method type
POST

API description
Converts an invoice to open status.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response  status="1"/>
                                                        

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

Method type
GET

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

Parameters to be passed
authtoken, scope, apikey

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Invoices uri="/api/invoices/">
    	<Invoice uri="/api/invoices/200000204297">
            <InvoiceID>200000204297</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
	    <Status>2</Status>	 <!-- 1-> Draft, 2-> Open, 3 -> Closed, 4 -> Overdue, 5 -> Void -->
            <InvoiceNumber>INV-295</InvoiceNumber>
            <PONumber>121</PONumber>
            <InvoiceDate>2009-12-21</InvoiceDate>
            <DueDate>2010-12-21</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>36.720</Total>
            <Balance>36.720</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/2000000204263">
            <InvoiceID>2000000204263</InvoiceID>
            <CustomerName>Sample Customer 1</CustomerName>
            <Status>2</Status>
            <InvoiceNumber>INV-293</InvoiceNumber>
            <PONumber>122</PONumber>
            <InvoiceDate>2009-12-21</InvoiceDate>
            <DueDate>2010-12-21</DueDate>
            <CurrencyCode>JPY</CurrencyCode>
            <Total>38.250</Total>
            <Balance>38.250</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/2000000204251">
            <InvoiceID>2000000204251</InvoiceID>
            <CustomerName>Sample Customer 2</CustomerName>
            <Status>4</Status>
            <InvoiceNumber>INV-292</InvoiceNumber>
            <PONumber>123</PONumber>
            <InvoiceDate>2009-12-21</InvoiceDate>
            <DueDate>2009-12-21</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>438.250</Total>
            <Balance>428.250</Balance>
        </Invoice>	
    </Invoices>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>	
                                                        

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

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

Method type
GET

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

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Invoices uri="/api/view/invoices/">
	<Invoice uri="/api/invoices/2000000204297">
	    <InvoiceID>2000000204297</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
	    <Status>Open</Status>	 <!-- 1-> Draft, 2-> Open, 3 -> Closed, 4 -> Overdue, 5 -> Void -->
            <InvoiceNumber>INV-295</InvoiceNumber>
            <PONumber>121</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2010</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.36.72</Total>
            <Balance>Rs.36.72</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/2000000204263">
            <InvoiceID>2000000204263</InvoiceID>
            <CustomerName>Sample Customer 1</CustomerName>
            <Status>Open</Status>
            <InvoiceNumber>INV-293</InvoiceNumber>
            <PONumber>122</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2010</DueDate>
            <CurrencyCode>JPY</CurrencyCode>
            <Total>JPY38.250</Total>
            <Balance>JPY38.250</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/2000000204251">
            <InvoiceID>2000000204251</InvoiceID>
            <CustomerName>Sample Customer 2</CustomerName>
            <Status>Overdue</Status>
            <InvoiceNumber>INV-292</InvoiceNumber>
            <PONumber>123</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2009</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.438.25</Total>
            <Balance>Rs.428.25</Balance>
    </Invoice>	
    </Invoices>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>
                                                        

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

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

Method type
GET

API description
View detailed information of a particular invoice.

Parameters to be passed
authtoken, scope, apikey

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Invoice uri="/api/invoices/2000000204251">
	<InvoiceID>2000000204251</InvoiceID>
        <CreatedTime>2010-01-28 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-01-28 10:24:45 PST</LastModifiedTime>
        <LastSyncTime>-</LastSyncTime>
        <Source>3</Source>
        <ReferenceID/>
        <InvoiceNumber>INV-292</InvoiceNumber>
        <PONumber>121</PONumber>
        <Status>4</Status>
        <CustomerID>2000000204073</CustomerID>
        <CustomerName>Sample Customer</CustomerName>
        <InvoiceDate>2009-12-21</InvoiceDate>
        <PaymentsDue>0</PaymentsDue>
        <DueDate>2009-12-21</DueDate>
        <CurrencyCode>INR</CurrencyCode>
        <ExchangeRate>1.000000</ExchangeRate>
        <LFName>Flat fee daily</LFName>
        <LateFeeAmount>400.000</LateFeeAmount>
        <Total>438.250</Total>
        <Balance>428.250</Balance>
        <PaymentGateways/>
        <InvoiceItems>
            <InvoiceItem>
                <ProductID>2000000204081</ProductID>
                <ItemID>2000000204259</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Sample Description</ItemDescription>
                <Price>34.000000</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name>VAT</Tax1Name>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage>12.500000</Tax1Percentage>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage/>
                <ItemTotal>34.000</ItemTotal>
            </InvoiceItem>
        </InvoiceItems>
        <Payments>
            <Payment>
                <PaymentID>2000000204253</PaymentID>
                <InvoiceID>2000000204251</InvoiceID>
                <Mode>4</Mode>
                <Description>Payment made via Cash</Description>
                <Date>2009-12-23</Date>
                <ExchangeRate>2.000000</ExchangeRate>
                <Amount>10.000</Amount>
            </Payment>
        </Payments>
        <Comments/>
        <Notes>Invoice Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Invoice>
</Response>
                                                        

Method name
https://invoice.zoho.com/api/view/invoices/<Invoice ID>

Method type
GET

API description
View detailed information of a particular invoice.

Parameters to be passed
authtoken, scope, apikey

Sample Response
Amounts displayed are in Customer currency.

<Response status="1">
    <Invoice uri="/api/view/invoices/2000000204251">
        <InvoiceID>2000000204251</InvoiceID>
        <CreatedTime>2010-01-28 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-01-28 10:24:45 PST</LastModifiedTime>
        <LastSyncTime>-</LastSyncTime>
        <Source>3</Source>
        <ReferenceID/>
        <InvoiceNumber>INV-292</InvoiceNumber>
        <PONumber>121</PONumber>
        <Status>Overdue</Status>
        <CustomerID>2000000204073</CustomerID>
        <CustomerName>Sample Customer 2</CustomerName>
        <InvoiceDate>December 21, 2009</InvoiceDate>
        <PaymentsDue>Due On Receipt</PaymentsDue>
        <DueDate>December 21, 2009</DueDate>
        <CurrencyCode>INR</CurrencyCode>
        <ExchangeRate>1.000000</ExchangeRate>
        <LFName>Flat fee daily</LFName>
        <LateFeeAmount>Rs.400.00</LateFeeAmount>
        <Total>Rs.438.25</Total>
        <InvoiceItemTotal>Rs.34.00</InvoiceItemTotal>
        <TaxTotal>Rs.4.25</TaxTotal>
        <Payment>Rs.10.00</Payment>
        <CreditsApplied>$0.00</CreditsApplied>om
        <Balance>Rs.428.25</Balance>
        <PaymentGateways/>
        <InvoiceItems>
            <InvoiceItem>
                <ProductID>2000000204081</ProductID>
                <ItemID>2000000204259</ItemID>
                <ItemName>Sample Item</ItemName>
                <ItemDescription>Sample Description</ItemDescription>
                <Price>Rs 34.00</Price>
                <Quantity>1.000000</Quantity>
                <Discount>0.00</Discount>
                <Tax1Name>VAT</Tax1Name>
                <Tax1Type>0</Tax1Type>
                <Tax1Percentage>12.500000</Tax1Percentage>
                <Tax2Name/>
                <Tax2Type>0</Tax2Type>
                <Tax2Percentage/>
                <ItemTotal>Rs.34.00</ItemTotal>
            </InvoiceItem>
        </InvoiceItems>
        <Taxes>
            <Tax>
                <TaxName>VAT (12.5%)</TaxName>
                <TaxAmount>Rs.4.25</TaxAmount>
            </Tax>
        </Taxes>
        <Payments>
            <Payment>
                <PaymentID>2000000204253</PaymentID>
                <InvoiceID>2000000204251</InvoiceID>
                <Mode>4</Mode>
                <Description>Payment made via Cash</Description>
                <Date>December 23, 2009 03:45 PM</Date>
                <ExchangeRate>2.000000</ExchangeRate>
                <Amount>Rs.10.00</Amount>
            </Payment>
        </Payments>
        <Comments/>
        <Notes>Invoice Notes will be shown in PDF</Notes>
        <Terms>Terms and Conditions apply</Terms>
    </Invoice>
</Response>
                                                        

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

Method type
GET

API description
View the list of invoices 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">
    <Invoices uri="/api/invoices/customer/5000000002012">
    	<Invoice uri="/api/invoices/5000000015001">
            <InvoiceID>5000000015001</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
	    <Status>2</Status>	 <!-- 1-> Draft, 2-> Open, 3 -> Closed, 4 -> Overdue, 5 -> Void -->
            <InvoiceNumber>INV-295</InvoiceNumber>
            <PONumber>121</PONumber>
            <InvoiceDate>2009-12-21</InvoiceDate>
            <DueDate>2010-12-21</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>36.720</Total>
            <Balance>36.720</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/5000000013017">
            <InvoiceID>5000000013017</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>4</Status>
            <InvoiceNumber>INV-293</InvoiceNumber>
            <PONumber>122</PONumber>
            <InvoiceDate>2009-12-21</InvoiceDate>
            <DueDate>2009-12-21</DueDate>
            <CurrencyCode>JPY</CurrencyCode>
            <Total>38.250</Total>
            <Balance>38.250</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/5000000002018">
            <InvoiceID>5000000002018</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>1</Status>
            <InvoiceNumber>INV-292</InvoiceNumber>
            <PONumber>123</PONumber>
            <InvoiceDate>2009-12-21</InvoiceDate>
            <DueDate>2009-12-21</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>438.250</Total>
            <Balance>438.250</Balance>
        </Invoice>
    </Invoices>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>
                                                        

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

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

Method type
GET

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

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Invoices uri="/api/view/invoices/customer/5000000002012">
	<Invoice uri="/api/invoices/5000000015001">
	    <InvoiceID>2000000204297</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
	    <Status>Open</Status>	 <!-- 1-> Draft, 2-> Open, 3 -> Closed, 4 -> Overdue, 5 -> Void -->
            <InvoiceNumber>INV-295</InvoiceNumber>
            <PONumber>121</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2010</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.36.72</Total>
            <Balance>Rs.36.72</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/2000000204263">
            <InvoiceID>2000000204263</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>Overdue</Status>
            <InvoiceNumber>INV-293</InvoiceNumber>
            <PONumber>122</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2009</DueDate>
            <CurrencyCode>JPY</CurrencyCode>
            <Total>JPY 38.250</Total>
            <Balance>JPY 38.250</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/2000000204251">
            <InvoiceID>2000000204251</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>Draft</Status>
            <InvoiceNumber>INV-292</InvoiceNumber>
            <PONumber>123</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2009</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.438.25</Total>
            <Balance>Rs.438.25</Balance>
        </Invoice>
    </Invoices>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>
                                                        

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

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

Method type
GET

API description
View the list of unpaid invoices(open and overdue) of a given customer in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Invoices uri="/api/view/invoices/customer/5000000002012">
	<Invoice uri="/api/invoices/5000000015001">
	    <InvoiceID>2000000204297</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
	    <Status>Open</Status>	 <!-- 1-> Draft, 2-> Open, 3 -> Closed, 4 -> Overdue, 5 -> Void -->
            <InvoiceNumber>INV-295</InvoiceNumber>
            <PONumber>121</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2010</DueDate>
            <CurrencyCode>INR</CurrencyCode>
            <Total>Rs.36.72</Total>
            <Balance>Rs.36.72</Balance>
        </Invoice>
        <Invoice uri="/api/invoices/2000000204263">
            <InvoiceID>2000000204263</InvoiceID>
            <CustomerName>Sample Customer</CustomerName>
            <Status>Overdue</Status>
            <InvoiceNumber>INV-293</InvoiceNumber>
            <PONumber>122</PONumber>
            <InvoiceDate>December 21, 2009</InvoiceDate>
            <DueDate>December 21, 2009</DueDate>
            <CurrencyCode>JPY</CurrencyCode>
            <Total>JPY 38.250</Total>
            <Balance>JPY 38.250</Balance>
        </Invoice>
    </Invoices>
    <PageContext Page="1" Per_Page="200" Total="2" Total_Pages="1"/>
</Response>
                                                        

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

Using "PageContext" tag you can customize the number of invoices 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 invoices per page (Default value is 200).
Total Total invoices 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,