API Docs
/
No Results Found
Transition Guide
FAQ
Help Docs
All Resources
Projects

Projects

A project entity allows you to maintain information about a project.

End Points
Create a project
List of all projects
Update the details of a project
Retrieve details of a project
Delete a project
Make a project active
Make a project inactive

Attribute

project_id
long
Unique ID for the project generated by the server. This is used as identifier.
project_name
string
Name of the project.
customer_id
long
Unique ID of the customer.
customer_name
string
Name of the customer.
currency_code
string
Base currency for the project.
description
string
Description about the project.
status
string
Status of the project. It can either be active or inactive.
billing_type
string
Type of billing for the project. Give based_on_task_hours as default.
budget_type
string
Type of budget of the project. Possible values are hours_per_staff or hours_per_task or total_project_hours or total_project_cost.
show_to_all_users
boolean
Whether the Project is shown to all users.
project_head_id
long
Unique ID of Project Head.
project_head_name
string
Name of the Project Head.
created_time
string
Time of project creation.
users
array
Associated user details list.
Show Sub-Attributes arrow
user_id
long
Unique ID of the user.
is_current_user
boolean
Whether he/she is the current user. It can either be true or false.
name
string
Name of the user.
email
string
Email ID of the user.
user_role
string
Role of the user.
role_id
long
Unique ID for the role.
status
string
Status of the project. It can either be active or inactive.
rate
double
Fixed rate for user.

Example

{ "project_id": "16367000000096055", "project_name": "Brochure Design - Spa", "customer_id": "16367000000096001", "customer_name": "Kenny Digital", "currency_code": "USD", "description": "8.5 x 11 Pet Hotel and Spa brochure template", "status": "active", "billing_type": "based_on_task_hours", "budget_type": "hours_per_task", "show_to_all_users": true, "project_head_id": "16367000000073071", "project_head_name": "Tricia", "created_time": "2017-02-28T12:30:34+0530", "users": [ { "user_id": "16367000000073001", "is_current_user": true, "name": "Will Smith", "email": "will.smith@gmail.com", "user_role": "admin", "role_id": "16367000000030001", "status": "active", "rate": 0 } ] }

Create a project

Create a new project.

Arguments

project_name
string
(Required)
Name of the project.
customer_id
long
(Required)
Unique ID of the customer.
description
string
Description about the project.
billing_type
string
Type of billing for the project. Give based_on_task_hours as default.
show_to_all_users
boolean
Whether the Project is shown to all users.
project_head_id
long
Unique ID of Project Head.
users
array
Associated user details list.
Show Sub-Attributes arrow
user_id
long
Unique ID of the user.
is_current_user
boolean
Whether he/she is the current user. It can either be true or false.
name
string
Name of the user.
email
string
Email ID of the user.
user_role
string
Role of the user.
role_id
long
Unique ID for the role.
status
string
Status of the project. It can either be active or inactive.
rate
double
Fixed rate for user.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/projects -X POST -H "X-com-zoho-expense-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "project_name": "Brochure Design - Spa", "customer_id": "16367000000096001", "description": "8.5 x 11 Pet Hotel and Spa brochure template", "billing_type": "based_on_task_hours", "show_to_all_users": true, "project_head_id": "16367000000073071", "users": [ { "user_id": "16367000000073001", "is_current_user": true, "name": "Will Smith", "email": "will.smith@gmail.com", "user_role": "admin", "role_id": "16367000000030001", "status": "active", "rate": 0 } ] }

Response Example

{ "code": 0, "message": "The project has been created.", "project": { "project_id": "16367000000096055", "project_name": "Brochure Design - Spa", "customer_id": "16367000000096001", "customer_name": "Kenny Digital", "currency_code": "USD", "description": "8.5 x 11 Pet Hotel and Spa brochure template", "status": "active", "billing_type": "based_on_task_hours", "budget_type": "hours_per_task", "show_to_all_users": true, "project_head_id": "16367000000073071", "project_head_name": "Tricia", "created_time": "2017-02-28T12:30:34+0530", "users": [ { "user_id": "16367000000073001", "is_current_user": true, "name": "Will Smith", "email": "will.smith@gmail.com", "user_role": "admin", "role_id": "16367000000030001", "status": "active", "rate": 0 } ] } }

List of all projects

List of all projects.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/projects -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "projects": [ { "project_id": "16367000000096055", "project_name": "Brochure Design - Spa", "customer_id": "16367000000096001", "customer_name": "Kenny Digital", "description": "8.5 x 11 Pet Hotel and Spa brochure template", "status": "active", "created_time": "2017-02-28T12:30:34+0530" }, {...}, {...} ] }

Update the details of a project

Update the details of an existing project.

Arguments

project_name
string
Name of the project.
customer_id
long
Unique ID of the customer.
description
string
Description about the project.
billing_type
string
Type of billing for the project. Give based_on_task_hours as default.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/projects/{project_id} -X PUT -H "X-com-zoho-expense-organizationid: 10234695" -H "Content-Type: application/json;charset=UTF-8" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f" -d '{"field":"value","field":"value"}'

Body Parameters

Click to copy
{ "project_name": "Brochure Design - Spa", "customer_id": "16367000000096001", "description": "8.5 x 11 Pet Hotel and Spa brochure template", "billing_type": "based_on_task_hours" }

Response Example

{ "code": 0, "message": "The project details has been updated.", "project": { "project_id": "16367000000096055", "project_name": "Brochure Design - Spa", "customer_id": "16367000000096001", "customer_name": "Kenny Digital", "currency_code": "USD", "description": "8.5 x 11 Pet Hotel and Spa brochure template", "status": "active", "billing_type": "based_on_task_hours", "budget_type": "hours_per_task", "show_to_all_users": true, "project_head_id": "16367000000073071", "project_head_name": "Tricia", "created_time": "2017-02-28T12:30:34+0530", "users": [ { "user_id": "16367000000073001", "is_current_user": true, "name": "Will Smith", "email": "will.smith@gmail.com", "user_role": "admin", "role_id": "16367000000030001", "status": "active", "rate": 0 } ] } }

Retrieve details of a project

Details of an existing project.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/projects/{project_id} -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "project": { "project_id": "16367000000096055", "project_name": "Brochure Design - Spa", "customer_id": "16367000000096001", "customer_name": "Kenny Digital", "currency_code": "USD", "description": "8.5 x 11 Pet Hotel and Spa brochure template", "status": "active", "billing_type": "based_on_task_hours", "budget_type": "hours_per_task", "show_to_all_users": true, "project_head_id": "16367000000073071", "project_head_name": "Tricia", "created_time": "2017-02-28T12:30:34+0530", "users": [ { "user_id": "16367000000073001", "is_current_user": true, "name": "Will Smith", "email": "will.smith@gmail.com", "user_role": "admin", "role_id": "16367000000030001", "status": "active", "rate": 0 } ] } }

Delete a project

Delete an existing project.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/projects/{project_id} -X DELETE -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The project has been deleted." }

Make a project active

Mark a project as active.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/projects/{project_id}/active -X POST -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The project has been marked as active." }

Make a project inactive

Mark a project as inactive.

Request Example

Click to copy
$ curl https://expense.zoho.com/api/v1/projects/{project_id}/inactive -X POST -H "X-com-zoho-expense-organizationid: 10234695" -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The project has been marked as inactive." }