API

API

Home  Expense Categories
How do I add an expense category?
 

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

Method type
POST

API description
Adds an expense category to your Zoho Invoice account.

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

Sample Request
Amounts displayed are in Customer currency. 

<ExpenseCategory>
         <CategoryName>Marketing</CategoryName>    <!-- Mandatory -->
         <Description>Online Marketing related expenses</Description>
</ExpenseCategory>

Sample Response 

<Response status="1">
    <ExpenseCategory uri="/api/expensecategories/3000000011037">
        <CategoryID>3000000011037</CategoryID>
        <CategoryName>Marketing</CategoryName>
        <Description>Online Marketing related expenses</Description>
        <Status>1</Status>    <!-- Status is 1 -> Active, Status is 2 -> Inactive -->
        <CreatedTime>2010-02-26 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-02-26 10:24:45 PST</LastModifiedTime>
    </ExpenseCategory>
</Response>

How do I update an expense category?
 

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

Method type
POST

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

  • CategoryName
  • Description
 

Parameters to be passed
authtoken, scope, XMLString, apikey

Sample Request 

<ExpenseCategory>
     <CategoryID>3000000011037</CategoryID>
     <CategoryName>Telephone</CategoryName>
     <Description>Telephone related expenses</Description>
</ExpenseCategory>

Sample Response 

<Response status="1">
    <ExpenseCategory uri="/api/expensecategories/3000000011037">
        <CategoryID>3000000011037</CategoryID>
        <CategoryName>Telephone</CategoryName>
        <Description>Telephone related expenses</Description>
        <Status>1</Status>
        <CreatedTime>2010-02-26 10:24:45 PST</CreatedTime>
        <LastModifiedTime>2010-02-26 10:34:45 PST</LastModifiedTime>
    </ExpenseCategory>
</Response>

How do I mark an expense category as inactive?
 

Method name
https://invoice.zoho.com/api/expensecategories/markasinactive/<Category ID>

Method type
POST

API description
Mark an expense category as inactive.

Parameters to be passed
authtoken, scope, apikey

Sample Response 

<Response status="1">

How do I delete an expense category?
 

Method name
https://invoice.zoho.com/api/expensecategories/delete/<Category ID>

Method type
POST

API description
Deletes an expense category from your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response 

<Response status="1">

How do I find an expense category?
 

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

Method type
GET

API description
Search for an expense category by passing either "Category Name" or "Category Description". Only active items will be listed.

Parameters to be passed
authtoken, scope, apikey, searchtext

Sample Response 

<Response status="1">
	<ExpenseCategories uri="/api/view/search/expensecategories/">
		<ExpenseCategory uri="/api/expensecategories/3000000000131">
			<CategoryID>3000000000131</CategoryID>
			<CategoryName>Travel</CategoryName>
			<Description/>
			<Status>1</Status>
		</ExpenseCategory>
	</ExpenseCategories>
	<PageContext Page="1" Per_Page="200" Total="1" Total_Pages="1"/>
</Response>

How do I customize the number of expense categories displayed on a page?

How do I view all my expense categories?
 

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

Method type
GET

API description
View list of all expense categories in your Zoho Invoice account.

Parameters to be passed
authtoken, scope, apikey

Sample Response 

<Response status="1">
	<ExpenseCategories uri="/api/expensecategories/">
		<ExpenseCategory uri="/api/expensecategories/3000000011037">
			<CategoryID>3000000011037</CategoryID>
			<CategoryName>Telephone</CategoryName>
			<Description>Online Marketing related expenses</Description>
			<Status>1</Status>
		</ExpenseCategory >
		<ExpenseCategory uri="/api/expensecategories/3000000000131">
			<CategoryID>3000000000131</CategoryID>
			<CategoryName>Travel</CategoryName>
			<Description/>
			<Status>1</Status>
		</ExpenseCategory >
		<ExpenseCategory uri="/api/expensecategories/3000000000135">
			<CategoryID>3000000000135</CategoryID>
			<CategoryName>Meals & Lodging</CategoryName>
			<Description/>
			<Status>1</Status>
		</ExpenseCategory >
		<ExpenseCategory uri="/api/expensecategories/3000000000139">
			<CategoryID>3000000000139</CategoryID>
			<CategoryName>Other</CategoryName>
			<Description/>
			<Status>2</Status>
		</ExpenseCategory >
    </ExpenseCategories>
    <PageContext Page="1" Per_Page="200" Total="1" Total_Pages="1"/>
</Response>

How do I customize the number of expense categories displayed on a page?

How do I view my active expense categories?
 

Method name
https://invoice.zoho.com/api/expensecategories/active

Method type
GET

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

Parameters to be passed
authtoken, scope, apikey

Sample Response 

<Response status="1">
	<ExpenseCategories uri="/api/expensecategories/active/">
		<ExpenseCategory uri="/api/expensecategories/3000000011037">
			<CategoryID>3000000011037</CategoryID>
			<CategoryName>Telephone</CategoryName>
			<Description>Online Marketing related expenses</Description>
			<Status>1</Status>
		</ExpenseCategory >
		<ExpenseCategory uri="/api/expensecategories/3000000000131">
			<CategoryID>3000000000131</CategoryID>
			<CategoryName>Travel</CategoryName>
			<Description/>
			<Status>1</Status>
		</ExpenseCategory >
		<ExpenseCategory uri="/api/expensecategories/3000000000135">
			<CategoryID>3000000000135</CategoryID>
			<CategoryName>Meals & Lodging</CategoryName>
			<Description/>
			<Status>1</Status>
		</ExpenseCategory>
    </ExpenseCategories>
    <PageContext Page="1" Per_Page="200" Total="1" Total_Pages="1"/>
</Response>

How do I customize the number of expense categories displayed on a page?

How do I view my inactive expense categories?
 

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

Method type
GET

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

Parameters to be passed
authtoken, scope, apikey

Sample Response 

<Response status="1">
	<ExpenseCategories uri="/api/expensecategories/inactive/">
		<ExpenseCategory uri="/api/expensecategories/3000000000139">
			<CategoryID>3000000000139</CategoryID>
			<CategoryName>Other</CategoryName>
			<Description/>
			<Status>2</Status>
		</ExpenseCategory>
	</ExpenseCategories >
	<PageContext Page="1" Per_Page="200" Total="1" Total_Pages="1"/>
</Response>

How do I customize the number of expense categories displayed on a page?

How do I view my expense category details?
 

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

Method type
GET

API description
View detailed information of a particular expense category.

Parameters to be passed
authtoken, scope, apikey

Sample Response 

<Response status="1">
	<ExpenseCategory uri="/api/expensecategories/3000000011037">
		<CategoryID>3000000011037</CategoryID>
		<CategoryName>Telephone</CategoryName>
		<Description>Online Marketing related expenses</Description>
		<Status>1</Status>
		<CreatedTime>2010-02-26  10:24:45 PST</CreatedTime>
		<LastModifiedTime>2010-02-26 10:34:45 PST</LastModifiedTime>
	</ExpenseCategory >
</Response>

How do I customize the number of expense categories displayed on a page?
 

Using "PageContext" tag you can customize the number of expenses 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.

Got more questions?

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

Zoho Invoice API

Quick Links
Features
Spread the Word