API

API

Home  Items
How do I add an item?
 

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

Method type
POST

API description
Adds an item to your Zoho Invoice account.

Parameters to be passed
authtoken, scope, XMLString, apikey.

Sample Request

<Item>
    <Name>Sample item</Name>   <!-- (Mandatory) -->
    <Description>Sample description</Description>
    <Rate>34</Rate>   <!-- (Mandatory) -->
    <Tax1Name>GST</Tax1Name>   <!-- Add these taxes in Zoho Invoice before you invoke this API -->
    <Tax2Name>PST</Tax2Name>
</Item>

Sample Response
Amounts displayed are in Customer currency. 

<Response  status="1">
   <Item  uri="/api/items/4000000002020">
        <ItemID>4000000002020</ItemID>
        <Name>Sample Item</Name>
        <Status>1</Status>   <!-- 1-> Item is active, 2-> Item is Inactive -->
        <Description>Sample Description</Description>
        <Rate>34.00</Rate>
        <Tax1Name>GST</Tax1Name>
        <Tax1Percentage>7</Tax1Percentage>
        <Tax1Type>0</Tax1Type>
        <Tax2Name>PST</Tax2Name>
        <Tax2Percentage>8</Tax2Percentage>
        <Tax2Type>0</Tax2Type>   <!-- 0-> Non stacked 1-> Stacked (Apply on Item amount + Tax1) -->
   </Item>
</Response>

How do I add a zero cost item?
 

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

Method type
POST

API description
Adds a zero cost item to your Zoho Invoice account

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Item>
    <Name>Sample Item </Name>
    <Description>Sample Description</Description>
    <Rate>0</Rate>
</Item>

Sample Response
Amounts displayed are in Customer currency. 

<Response  status="1">
   <Item  uri="/api/items/1000000000342">
        <ItemID>1000000000342</ItemID>
        <Name>Sample Item</Name>
        <Status>1</Status>
        <Description>Sample Description</Description>
        <Rate>0.00</Rate>
        <Tax1Name/>
        <Tax1Percentage/>
        <Tax1Type/>
        <Tax2Name/>
        <Tax2Percentage/>
        <Tax2Type/>
    </Item>
</Response>

How do I update an item?
 

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

Method type
POST

API description
Updates an item in your Zoho Invoice account. You can change the values of the following fields of an item.

  • Description
  • Tax1Name
  • Tax2Name

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request

<Item>
    <ItemID>4000000002026</ItemID>   <!-- (Mandatory) -->
    <Name>Sample item 3</Name>   <!-- Updates item name -->
    <Description>New description</Description>   <!-- Updates the existing item description with new details -->
    <Rate>43</Rate>   <!-- Updates the existing item rate with a new value -->		
    <Tax1Name></Tax1Name>   <!--To reset a field,do not specify a value for the tag enclosing this field -->
    <Tax2Name>GST</Tax2Name>   <!-- Change the tax associated to an item -->
</Item>

Sample Response

<Response  status="1">
   <Item  uri="/api/items/4000000002026">
       <ItemID>4000000002026</ItemID>
       <Name>Sample item 3</Name>
       <Status>1</Status>
       <Description>New description</Description>
       <Rate>43.00</Rate>
       <Tax1Name/>
       <Tax1Percentage/>
       <Tax1Type/>
       <Tax2Name>GST</Tax2Name>
       <Tax2Percentage>7</Tax2Percentage>
       <Tax2Type>0</Tax2Type>
   </Item>
</Response>

How do I mark an item as inactive?
 

Method name
https://invoice.zoho.com/api/items/markasinactive/<item ID>

Method type
POST

API description
Mark an item as inactive.

Parameters to be passed
authtoken, scope, apikey

Sample Response
Amounts displayed are in Customer currency. 

<Response  status="1"/>

How do I delete an item?
 

Method name
https://invoice.zoho.com/api/items/delete/<item ID>

Method type
POST

API description
Deletes an item from your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response  status="1"/>

How do I find an item?
 

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

Method type
GET

API description
Search for an item by passing either "Item Name" or "Item Description". Only active items will be listed.

Parameters to be passed
authtoken, scope, apikey, searchtext

Sample Response

<Response  status="1">
    <Items uri="/api/view/search/items/">
        <Item uri="/api/items/1000000000354"">
            <ItemID>1000000000354</ItemID>
            <Name>New item 3</Name>
            <Description>Sample description</Description>
            <Rate>Rs34.00</Rate>
            <Tax1Name/>
            <Tax1Percentage/>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
        <Item uri="/api/items/1000000000352"">
            <ItemID>1000000000352</ItemID>
            <Name>New item 2</Name>
            <Description>Sample description</Description>
            <Rate>Rs32.00</Rate>
            <Tax1Name/>
            <Tax1Percentage/>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
        <Item uri="/api/items/1000000000350"">
            <ItemID>1000000000350</ItemID>
            <Name>New item 1</Name>
            <Description>Sample description</Description>
            <Rate>Rs23.00</Rate>
            <Tax1Name/>
            <Tax1Percentage/>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
    </Items>
    <PageContext Page="1" Per_Page="200" Total="3" Total_Pages="1"/>
</Response>

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

How do I view my active items (Unformatted)?
 

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

Method type
GET

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

Parameters to be passed
authtoken, scope, apikey

Sample Response 

<Response  status="1">
    <Items uri="/api/items/">
        <Item uri="/api/items/4000000002011">
            <ItemID>4000000002011</ItemID>
            <Name>Sample Item1</Name>
            <Description>Sample Description</Description>
            <Rate>34.00</Rate>
            <Tax1Name>PST</Tax1Name>
            <Tax1Percentage>8</Tax1Percentage>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
        <Item uri="/api/items/4000000002005">
            <ItemID>4000000002005</ItemID>
            <Name>Sample Item</Name>
            <Description>Sample Description</Description>
            <Rate>25.00</Rate>
            <Tax1Name>PST</Tax1Name>
            <Tax1Percentage>8</Tax1Percentage>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
        <Item uri="/api/items/4000000000334">
            <ItemID>4000000000334</ItemID>
            <Name>Hard Drive (Sample)</Name>
            <Description>500GB, USB 2.0 interface 1400 rpm, protective hard case.</Description>
            <Rate>120.00</Rate>
            <Tax1Name/>
            <Tax1Percentage/>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
        <Item uri="/api/items/4000000000332">
            <ItemID>4000000000332</ItemID>
            <Name>Premium Plan - Web hosting (Sample)</Name>
            <Description>10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases</Description>
            <Rate>33.00</Rate>
            <Tax1Name/>
            <Tax1Percentage/>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
    </Items>
    <PageContext Page="1" Per_Page="200" Total="4" Total_Pages="1"/>
</Response>

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

How do I view my active items (formatted)?
 

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

Method type
GET

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

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Items uri="/api/view/items/">
    	<Item uri="/api/items/4000000002005">
            <ItemID>4000000002005</ItemID>
            <Name>Sample Item</Name>
            <Description>Sample Description</Description>
            <Rate>Rs.25.00</Rate>
            <Tax1Name>PST</Tax1Name>
            <Tax1Percentage>8</Tax1Percentage>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
    	<Item uri="/api/items/4000000000334">
            <ItemID>4000000000334</ItemID>
            <Name>Hard Drive (Sample)</Name>
            <Description>500GB, USB 2.0 interface 1400 rpm, protective hard case.</Description>
            <Rate>Rs.120.00</Rate>
            <Tax1Name/>
            <Tax1Percentage/>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
    </Items>
    <PageContext Page="1" Per_Page="200" Total="2" Total_Pages="1"/>
</Response>

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

How do I view my inactive items (Unformatted)?
 

Method name
https://invoice.zoho.com/api/items/inactive/

Method type
GET

API description
View list of inactive items in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Items uri="/api/items/inactive/">
     	<Item uri="/api/items/4000000002011">
            <ItemID>4000000002011</ItemID>
            <Name>Sample Item1</Name>
            <Description>Sample Description</Description>
            <Rate>34.00</Rate>
            <Tax1Name>PST</Tax1Name>
            <Tax1Percentage>8</Tax1Percentage>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
     	<Item uri="/api/items/4000000000332">
            <ItemID>4000000000332</ItemID>
            <Name>Premium Plan - Web hosting (Sample)</Name>
            <Description>10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases</Description>
            <Rate>33.00</Rate>
            <Tax1Name/>
            <Tax1Percentage/>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
    </Items>
    <PageContext Page="1" Per_Page="200" Total="2" Total_Pages="1"/>
</Response>

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

How do I view my inactive items (formatted)?
 

Method name
https://invoice.zoho.com/api/view/items/inactive

Method type
GET

API description
View list of inactive items in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Items uri="/api/view/items/inactive">
    	<Item uri="/api/items/4000000002011">
            <ItemID>4000000002011</ItemID>
            <Name>Sample Item1</Name>
            <Description>Sample Description</Description>
            <Rate>Rs34.00</Rate>
            <Tax1Name>PST</Tax1Name>
            <Tax1Percentage>8</Tax1Percentage>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
    	<Item uri="/api/items/4000000000332">
            <ItemID>4000000000332</ItemID>
            <Name>Premium Plan - Web hosting (Sample)</Name>
            <Description>10 GB Space, 300 GB Transfer 100 Email Accounts 10 MySQL Databases</Description>
            <Rate>Rs33.00</Rate>
            <Tax1Name/>
            <Tax1Percentage/>
            <Tax2Name/>
            <Tax2Percentage/>
        </Item>
     </Items>
    <PageContext Page="1" Per_Page="200" Total="2" Total_Pages="1"/>
</Response>

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

How do I view my item details (unformatted)?
 

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

Method type
GET

API description
View detailed information of a particular item.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Item uri="/api/items/4000000002005">
        <ItemID>4000000002005</ItemID>
        <Name>Sample Item</Name>
        <Status>1</Status>
        <Description>Sample Description</Description>
        <Rate>25.00</Rate>
        <Tax1Name>PST</Tax1Name>
        <Tax1Percentage>8</Tax1Percentage>
        <Tax2Name/>
        <Tax2Percentage/>
    </Item>
</Response>

How do I view my item details (formatted)?
 

Method name
https://invoice.zoho.com/api/view/items/<item ID>

Method type
GET

API description
View the detailed information of a particular item.

Parameters to be passed
authtoken, scope, apikey

Sample Response

<Response status="1">
    <Item uri="/api/items/1000000000342">
        <ItemID>1000000000342</ItemID>
        <Name>Sample Item</Name>
        <Status>Active</Status>
        <Description>Sample Description</Description>
        <Rate>Rs32.00</Rate>
        <Tax1Name>GST</Tax1Name>
        <Tax1Percentage>7</Tax1Percentage>
        <Tax1Type>0</Tax1Type>
        <Tax2Name>PST</Tax2Name>
        <Tax2Percentage>8</Tax2Percentage>
        <Tax2Type>0</Tax2Type>
    </Item>
</Response>

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

Using "PageContext" tag you can customize the number of items 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 items per page (Default value is 200).
Total Total items present.
What is the difference between unformatted and formatted API?
 

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

Quick Links
Features
Zoho services
Recent Blogs
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,