API Docs
/
No Results Found
Projects

Projects

A project is a series of tasks performed over a period of time, to achieve certain targets. There can be many number of people working on a single project and a project may consist of single or multiple tasks. A project is billed and charged upon a customer whom the project was taken up for.

Possible error codes:
Error CodeMessage
1002Project does not exists
20004Please ensure that the amount is not negative
20077Expense has been recorded for this project. Hence, it cannot be deleted

Attribute

project_id
string
Unoque ID of the project
project_name
string
Name of the project. Maximum length [100]
customer_id
string
Unique ID of the customer.
customer_name
string
Name of the client of the project
currency_code
string
Code to denote currency
description
string
Project Description - A short note on the project details
status
string
Project Status
billing_type
string
The way you bill your customer. Allowed Values: fixed_cost_for_project, based_on_project_hours, based_on_staff_hours and based_on_task_hours
rate
float
Total project cost
budget_type
string
Project budject type
total_hours
string
Total hours spent on project
total_amount
double
Total cost of the project
billed_hours
string
Total duration/hours of a project that is billed
billed_amount
double
Total billable amount of the project
un_billed_hours
string
Hours of the project that cannot be billed
un_billed_amount
double
Total value of Unbilled expense of the project
billable_hours
string
Hours charged for, in total project hours
billable_amount
double
Total billed amount
non_billable_hours
string
Non-billable project hours
non_billable_amount
double
Total value of non-billable expense
is_recurrence_associated
boolean
To check if project (task) billing is recurrning
recurring_invoices
array
Recurring invoices included in the project
created_time
string
Time of project creation
show_in_dashboard
boolean
To check if dashboard view is available for project
tasks
array
Tasks comprising a project
Show Sub-Attributes arrow
task_id
string
ID of the task(s) performed in a project
task_name
string
Name of the task performed in a project
description
string
Project Description - A short note on the project details
rate
float
Total project cost
budget_hours
string
Planned hours for completion of project
total_hours
string
Total hours spent on project
billed_hours
string
Total duration/hours of a project that is billed
un_billed_hours
string
Hours of the project that cannot be billed
non_billable_hours
string
Non-billable project hours
status
string
Project Status
is_billable
boolean
Boolean to check if a task or expense is billable in a project
task_custom_fields
string
Additional fields to describe task
users
array
Users of a project
Show Sub-Attributes arrow
user_id
string
ID of the user to be added to the project.
is_current_user
boolean
user_name
string
Name of the user. Maximum length [200]
email
string
Email of the user. Maximum length [100]
user_role
string
Role to be assigned. Allowed Values: staff, admin and timesheetstaff
status
string
Project Status
rate
float
Total project cost
budget_hours
string
Planned hours for completion of project
total_hours
string
Total hours spent on project
billed_hours
string
Total duration/hours of a project that is billed
un_billed_hours
string
Hours of the project that cannot be billed

Example

{ "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "currency_code": "USD", "description": "A simple algorithm is to be tested with vehicle detection application.", "status": "active", "billing_type": "fixed_cost_for_project", "rate": 5000, "budget_type": " ", "total_hours": "12:26", "total_amount": 500, "billed_hours": "12:27", "billed_amount": 500, "un_billed_hours": "00:00", "un_billed_amount": 0, "billable_hours": "12:26", "billable_amount": 500, "non_billable_hours": "0.00", "non_billable_amount": 0, "is_recurrence_associated": false, "recurring_invoices": "", "created_time": "2013-11-18T18:05:27+0530", "show_in_dashboard": true, "tasks": [ { "task_id": "460000000044009", "task_name": "Distribution Analysis", "description": "A simple algorithm is to be tested with vehicle detection application.", "rate": 5000, "budget_hours": "0", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00", "non_billable_hours": "0.00", "status": "active", "is_billable": true, "task_custom_fields": "" } ], "users": [ { "user_id": "460000000024003", "is_current_user": true, "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "status": "active", "rate": 5000, "budget_hours": "0", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00" } ] }

Create a project

Create a new project.
oauthscope : ZohoInvoice.projects.CREATE

Arguments

project_name
string
(Required)
Name of the project. Maximum length [100]
customer_id
string
(Required)
ID of the customer.
description
string
Project description. Maximu length [500]
billing_type
string
(Required)
The way you bill your customer. Allowed Values: fixed_cost_for_project, based_on_project_hours, based_on_staff_hours and based_on_task_hours
rate
string
Hourly rate for a task.
budget_type
string
The way you budget. Allowed Values: total_project_cost, total_project_hours, hours_per_task and hours_per_staff
budget_hours
string
Task budget hours
budget_amount
string
Give value, if you are estimating total project cost.
user_id
string
(Required)
ID of the user to be added to the project.
tasks
array
Tasks comprising a project
Show Sub-Attributes arrow
task_name
string
(Required)
Name of the task. Maximum length [100]
description
string
Task description. Maximum length [500]
rate
string
Hourly rate of a task.
budget_hours
string
Task budgeting.
users
array
Users of a project
Show Sub-Attributes arrow
user_id
string
(Required)
ID of the user to be added to the project.
is_current_user
boolean
user_name
string
Name of the user. Maximum length [200]
email
string
Email of the user. Maximum length [100]
user_role
string
Role to be assigned. Allowed Values: staff, admin and timesheetstaff
status
string
Project Status
rate
string
Hourly rate for a task.
budget_hours
string
Task budget hours
total_hours
string
Total hours spent on project
billed_hours
string
Total duration/hours of a project that is billed
un_billed_hours
string
Hours of the project that cannot be billed

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/projects -X POST -H "X-com-zoho-invoice-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": "Network Distribution", "customer_id": "460000000044001", "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user", "billing_type": "based_on_task_hours", "rate": " ", "budget_type": " ", "budget_hours": " ", "budget_amount": " ", "user_id": "INV-00003", "tasks": [ { "task_name": "INV-00003", "description": "INV-00003", "rate": "INV-00003", "budget_hours": "INV-00003" } ], "users": [ { "user_id": "INV-00003", "is_current_user": true, "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "status": "active", "rate": " ", "budget_hours": " ", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00" } ] }

Response Example

{ "code": 0, "message": "The project has been created.", "project": { "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "currency_code": "USD", "description": "A simple algorithm is to be tested with vehicle detection application.", "status": "active", "billing_type": "fixed_cost_for_project", "rate": 5000, "budget_type": " ", "total_hours": "12:26", "total_amount": 500, "billed_hours": "12:27", "billed_amount": 500, "un_billed_hours": "00:00", "un_billed_amount": 0, "billable_hours": "12:26", "billable_amount": 500, "non_billable_hours": "0.00", "non_billable_amount": 0, "is_recurrence_associated": false, "recurring_invoices": "", "created_time": "2013-11-18T18:05:27+0530", "show_in_dashboard": true, "tasks": [ { "task_id": "460000000044009", "task_name": "Distribution Analysis", "description": "A simple algorithm is to be tested with vehicle detection application.", "rate": 5000, "budget_hours": "0", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00", "non_billable_hours": "0.00", "status": "active", "is_billable": true, "task_custom_fields": "" } ], "users": [ { "user_id": "460000000024003", "is_current_user": true, "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "status": "active", "rate": 5000, "budget_hours": "0", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00" } ] } }

List projects

List all projects with pagination.
oauthscope : ZohoInvoice.projects.READ

Query Parameters

filter_by
Filter projects by any status. Allowed Values: Status.All, Status.Active and Status.Inactive
customer_id
Unique ID of the customer.
sort_column
Sort projects. Allowed Values: project_name, customer_name, rate and created_time

Request Example

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

Response Example

{ "code": 0, "message": "success", "projects": [ { "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "description": "A simple algorithm is to be tested with vehicle detection application.", "status": "active", "billing_type": "fixed_cost_for_project", "rate": 5000, "created_time": "2013-11-18T18:05:27+0530", "has_attachment": false, "total_hours": "12:26", "billable_hours": "12:26" }, {...}, {...} ] }

Update a project

Update details of a project.
oauthscope : ZohoInvoice.projects.UPDATE

Arguments

project_name
string
(Required)
Name of the project. Maximum length [100]
customer_id
string
(Required)
ID of the customer.
description
string
Project description. Maximum length [500]
billing_type
string
(Required)
The way you bill your customer. Allowed Values: fixed_cost_for_project, based_on_project_hours, based_on_staff_hours and based_on_task_hours
rate
string
Hourly rate for a task.
budget_type
string
The way you budget. Allowed Values: total_project_cost, total_project_hours, hours_per_task and hours_per_staff
budget_hours
string
Task budget hours
budget_amount
string
Give value, if you are estimating total project cost.
user_id
string
(Required)
ID of the user to be added to the project.
tasks
array
Tasks comprising a project
Show Sub-Attributes arrow
task_name
string
(Required)
Name of the task. Maximum length [100]
description
string
Task description. Maximum length [500]
rate
string
Hourly rate of a task.
budget_hours
string
Task budgeting.
users
array
Users of a project
Show Sub-Attributes arrow
user_id
string
(Required)
ID of the user to be added to the project.
is_current_user
boolean
user_name
string
Name of the user. Maximum length [200]
email
string
Email of the user. Maximum length [100]
user_role
string
Role to be assigned. Allowed Values: staff, admin and timesheetstaff
status
string
Project Status
rate
string
Hourly rate for a task.
budget_hours
string
Task budget hours
total_hours
string
Total hours spent on project
billed_hours
string
Total duration/hours of a project that is billed
un_billed_hours
string
Hours of the project that cannot be billed

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/projects/{project_id} -X PUT -H "X-com-zoho-invoice-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": "Network Distribution", "customer_id": "460000000044001", "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user", "billing_type": "based_on_task_hours", "rate": " ", "budget_type": " ", "budget_hours": " ", "budget_amount": " ", "user_id": "INV-00003", "tasks": [ { "task_name": "INV-00003", "description": "INV-00003", "rate": "INV-00003", "budget_hours": "INV-00003" } ], "users": [ { "user_id": "INV-00003", "is_current_user": true, "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "status": "active", "rate": " ", "budget_hours": " ", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00" } ] }

Response Example

{ "code": 0, "message": "The project information has been updated.", "project": { "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "currency_code": "USD", "description": "A simple algorithm is to be tested with vehicle detection application.", "status": "active", "billing_type": "fixed_cost_for_project", "rate": 5000, "budget_type": " ", "total_hours": "12:26", "total_amount": 500, "billed_hours": "12:27", "billed_amount": 500, "un_billed_hours": "00:00", "un_billed_amount": 0, "billable_hours": "12:26", "billable_amount": 500, "non_billable_hours": "0.00", "non_billable_amount": 0, "is_recurrence_associated": false, "recurring_invoices": "", "created_time": "2013-11-18T18:05:27+0530", "show_in_dashboard": true, "tasks": [ { "task_id": "460000000044009", "task_name": "Distribution Analysis", "description": "A simple algorithm is to be tested with vehicle detection application.", "rate": 5000, "budget_hours": "0", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00", "non_billable_hours": "0.00", "status": "active", "is_billable": true, "task_custom_fields": "" } ], "users": [ { "user_id": "460000000024003", "is_current_user": true, "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "status": "active", "rate": 5000, "budget_hours": "0", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00" } ] } }

Get a project

Get the details of a project.
oauthscope : ZohoInvoice.projects.READ

Request Example

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

Response Example

{ "code": 0, "message": "success", "project": { "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "currency_code": "USD", "description": "A simple algorithm is to be tested with vehicle detection application.", "status": "active", "billing_type": "fixed_cost_for_project", "rate": 5000, "budget_type": " ", "total_hours": "12:26", "total_amount": 500, "billed_hours": "12:27", "billed_amount": 500, "un_billed_hours": "00:00", "un_billed_amount": 0, "billable_hours": "12:26", "billable_amount": 500, "non_billable_hours": "0.00", "non_billable_amount": 0, "is_recurrence_associated": false, "recurring_invoices": "", "created_time": "2013-11-18T18:05:27+0530", "show_in_dashboard": true, "tasks": [ { "task_id": "460000000044009", "task_name": "Distribution Analysis", "description": "A simple algorithm is to be tested with vehicle detection application.", "rate": 5000, "budget_hours": "0", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00", "non_billable_hours": "0.00", "status": "active", "is_billable": true, "task_custom_fields": "" } ] } }

Delete project

Deleting a existing project.
oauthscope : ZohoInvoice.projects.DELETE

Request Example

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

Response Example

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

Activate a project

Mark project as active
oauthscope : ZohoInvoice.projects.CREATE

Request Example

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

Response Example

{ "code": 0, "message": "The selected Projects have been marked as active." }

Deactivate a project

Marking a project as inactive.
oauthscope : ZohoInvoice.projects.CREATE

Request Example

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

Response Example

{ "code": 0, "message": "The selected projects have been marked as inactive." }

Clone a project

Cloning the settings of an existing project.
oauthscope : ZohoInvoice.projects.CREATE

Arguments

project_name
string
(Required)
Name of the project. Maximum length [100]
description
string
Project description. Maximum length [500]

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/projects/{project_id}/clone -X POST -H "X-com-zoho-invoice-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": "Network Distribution", "description": "Distribution for the system of intermediaries between the producer of goods and/or services and the final user" }

Response Example

{ "code": 0, "message": "Project has been cloned successfully.", "project": { "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "currency_code": "USD", "description": "A simple algorithm is to be tested with vehicle detection application.", "status": "active", "billing_type": "fixed_cost_for_project", "rate": 5000, "budget_type": " ", "total_hours": "12:26", "total_amount": 500, "billed_hours": "12:27", "billed_amount": 500, "un_billed_hours": "00:00", "un_billed_amount": 0, "billable_hours": "12:26", "billable_amount": 500, "non_billable_hours": "0.00", "non_billable_amount": 0, "is_recurrence_associated": false, "recurring_invoices": "", "created_time": "2013-11-18T18:05:27+0530", "show_in_dashboard": true, "tasks": [ { "task_id": "460000000044009", "task_name": "Distribution Analysis", "description": "A simple algorithm is to be tested with vehicle detection application.", "rate": 5000, "budget_hours": "0", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00", "non_billable_hours": "0.00", "status": "active", "is_billable": true, "task_custom_fields": "" } ], "users": [ { "user_id": "460000000024003", "is_current_user": true, "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "status": "active", "rate": 5000, "budget_hours": "0", "total_hours": "12:26", "billed_hours": "12:27", "un_billed_hours": "00:00" } ] } }

Assign users

Assign a users to a project.
oauthscope : ZohoInvoice.projects.CREATE

Arguments

user_id
string
(Required)
ID of the user to be added to the project.
rate
float
Total project cost
budget_hours
string
Planned hours for completion of project

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/projects/{project_id}/users -X POST -H "X-com-zoho-invoice-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
{ "user_id": "INV-00003", "rate": 5000, "budget_hours": "0" }

Response Example

{ "code": 0, "message": "Users added.", "users": [ { "user_id": "460000000024003", "is_current_user": true, "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "status": "active", "rate": 5000, "budget_hours": "0" }, {...}, {...} ] }

List Users

Get list of all users associated to a project.
oauthscope : ZohoInvoice.projects.READ

Request Example

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

Response Example

{ "code": 0, "message": "success", "users": [ { "user_id": "460000000024003", "is_current_user": true, "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "status": "active", "rate": 5000, "budget_hours": "0" }, {...}, {...} ] }

Invite user

Invite a user to the project.
oauthscope : ZohoInvoice.projects.CREATE

Arguments

user_name
string
(Required)
Name of the user. Maximum length [200]
email
string
(Required)
Email of the user. Maximum length [100]
user_role
string
Role to be assigned. Allowed Values: staff, admin and timesheetstaff
rate
string
Hourly rate for a task.
budget_hours
string
Planned hours for completion of project

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/projects/{project_id}/users/invite -X POST -H "X-com-zoho-invoice-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
{ "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "rate": " ", "budget_hours": "0" }

Response Example

{ "code": 0, "message": "The staff has been added.", "users": [ { "user_id": "460000000024003", "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "is_current_user": true }, {...}, {...} ] }

Update user

Update details of a user.
oauthscope : ZohoInvoice.projects.UPDATE

Arguments

user_name
string
Name of the user. Maximum length [200]
user_role
string
Role to be assigned. Allowed Values: staff, admin and timesheetstaff
rate
float
Total project cost
budget_hours
string
Planned hours for completion of project

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/projects/{project_id}/users/{user_id} -X PUT -H "X-com-zoho-invoice-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
{ "user_name": "John David", "user_role": "admin", "rate": 5000, "budget_hours": "0" }

Response Example

{ "code": 0, "message": "The staff information has been updated.", "users": [ { "user_id": "460000000024003", "user_name": "John David", "email": "test@zylker.org", "user_role": "admin", "is_current_user": true }, {...}, {...} ] }

Get a User

Get details of a user in project.
oauthscope : ZohoInvoice.projects.READ

Request Example

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

Response Example

{ "code": 0, "message": "success", "users": { "user_id": "460000000024003", "is_current_user": true, "user_name": "John David", "email": "test@zylker.org", "user_role": "admin" } }

Delete user

Remove user from a project.
oauthscope : ZohoInvoice.projects.DELETE

Request Example

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

Response Example

{ "code": 0, "message": "The staff has been removed" }

Post comment

Post comment to a project.
oauthscope : ZohoInvoice.projects.CREATE

Arguments

description
string
(Required)
Project description. Maximum length [500]

Request Example

Click to copy
$ curl https://invoice.zoho.com/api/v3/projects/{project_id}/comments -X POST -H "X-com-zoho-invoice-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
{ "description": "Billing based on task hours" }

Response Example

{ "code": 0, "message": "Comments added.", "comments": [ { "project_id": "460000000044019", "comment_id": "460000000044027", "description": "A simple algorithm is to be tested with vehicle detection application.", "commented_by_id": "460000000024003", "commented_by": "John David", "date": "2013-11-18", "date_description": "19 days ago", "time": "6:52 PM" }, {...}, {...} ] }

List comments

Get comments for a project.
oauthscope : ZohoInvoice.projects.READ

Request Example

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

Response Example

{ "code": 0, "message": "success", "comments": [ { "comment_id": "460000000044027", "project_id": "460000000044019", "description": "A simple algorithm is to be tested with vehicle detection application.", "commented_by_id": "460000000024003", "commented_by": "John David", "is_current_user": true, "date": "2013-11-18", "date_description": "19 days ago", "time": "6:52 PM" }, {...}, {...} ] }

Delete comment

Deleting a comment.
oauthscope : ZohoInvoice.projects.DELETE

Request Example

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

Response Example

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

List invoices

Lists invoices created for this project.
oauthscope : ZohoInvoice.projects.READ

Query Parameters

sort_column
Sort invoices raised. Allowed Values: invoice_number, date, total, balance and created_time

Request Example

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

Response Example

{ "code": 0, "message": "success", "invoices": [ { "invoice_id": "460000000044001", "customer_name": "SAF Instruments Inc", "status": "active", "invoice_number": "INV-00004", "reference_number": " ", "date": "2013-11-18", "due_date": "2013-11-19", "total": "310.75", "balance": "48.75", "created_time": "2013-11-18T18:05:27+0530" }, {...}, {...} ] }