API Docs
/
No Results Found
Tasks

Tasks

A project comprises of a single or multiple tasks that need to be completed. You need a task to the project before you log time.

Attribute

project_id
string
Unique ID of the project generated by the server.
task_id
string
Unique ID of the task generated by the server.
currency_id
string
The currenct id of the currency
customer_id
string
Customer ID of the customer for whom the task is created.
task_name
string
The name of the task. Max-length [100]
project_name
string
The name of the project
customer_name
string
Name of the customer to whom the task is created.
billed_hours
double
The total hours that are billed.
log_time
double
Total hours logged in the project.
un_billed_hours
double
Total hours that are unbilled.

Example

{ "project_id": "90300000072369", "task_id": "90300000072369", "currency_id": 982000000000190, "customer_id": "903000000000099", "task_name": "Painting", "project_name": "Furniture Manufacturing", "customer_name": "Sujin Kumar", "billed_hours": "12:06", "log_time": "13:06", "un_billed_hours": "01:00" }

Add a task

The task has been added.
oauthscope : ZohoBooks.projects.CREATE

Arguments

task_name
string
(Required)
The name of the task. Max-length [100]
description
string
The description of the project.
rate
integer
Hourly rate for a task.
budget_hours
integer
Task budget hours.

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/:project_id/tasks?organization_id=10234695 -X POST -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
{ "task_name": "Painting", "description": "", "rate": 3, "budget_hours": "" }

Response Example

{ "code": 0, "message": "The project information has been updated.", "task": { "project_id": "90300000072369", "task_id": "90300000072369", "currency_id": 982000000000190, "customer_id": "903000000000099", "task_name": "Painting", "project_name": "Furniture Manufacturing", "customer_name": "Sujin Kumar", "billed_hours": "12:06", "log_time": "13:06", "un_billed_hours": "01:00" } }

List tasks

Get list of tasks added to a project.
oauthscope : ZohoBooks.projects.READ

Arguments

sort_column
string
Sort tasks: Allowed Values: task_name, billes_hours, log_time and un_billes_hours.

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/:project_id/tasks?organization_id=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
{ "sort_column": "created_time" }

Response Example

{ "code": 0, "message": "success", "tasks": [ { "project_id": "90300000072369", "task_id": "90300000072369", "currency_id": 982000000000190, "customer_id": "903000000000099", "task_name": "Painting", "project_name": "Furniture Manufacturing", "customer_name": "Sujin Kumar", "billed_hours": "12:06", "log_time": "13:06", "un_billed_hours": "01:00" }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "report_name": "Tasks", "sort_column": "created_time", "sort_order": "D" } }

Update a task

Update the details of a task.
oauthscope : ZohoBooks.projects.UPDATE

Arguments

task_name
string
(Required)
The name of the task. Max-length [100]
description
string
The description of the project.
rate
integer
Hourly rate for a task.
budget_hours
integer
Task budget hours.

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/:project_id/tasks/:task_id?organization_id=10234695 -X PUT -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
{ "task_name": "Painting", "description": "", "rate": 3, "budget_hours": "" }

Response Example

{ "code": 0, "message": "The task information has been updated.", "task": { "project_id": "90300000072369", "task_id": "90300000072369", "currency_id": 982000000000190, "customer_id": "903000000000099", "task_name": "Painting", "project_name": "Furniture Manufacturing", "customer_name": "Sujin Kumar", "billed_hours": "12:06", "log_time": "13:06", "un_billed_hours": "01:00" } }

Get a task

Get the details of a task.
oauthscope : ZohoBooks.projects.READ

Arguments

task_id
string
Unique ID of the task generated by the server.

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/:project_id/tasks/:task_id?organization_id=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
{ "task_id": "90300000072369" }

Response Example

{ "code": 0, "message": "success", "task": { "project_id": "90300000072369", "project_name": "Furniture Manufacturing", "task_id": "90300000072369", "task_name": "Painting", "description": "", "rate": 3, "status": "active", "is_billable": true } }

Delete Task

Delete a task added to a project.
oauthscope : ZohoBooks.projects.DELETE

Arguments

task_id
string
Unique ID of the task generated by the server.

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/:project_id/tasks/:task_id?organization_id=10234695 -X DELETE -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
{ "task_id": "90300000072369" }

Response Example

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