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.
Attribute
Max-length [100]
fixed_cost_for_project
, based_on_project_hours
, based_on_staff_hours
and based_on_task_hours
Max-length [200]
Max-length [100]
staff
, admin
and timesheetstaff
Create a project
Create a project.
OAuth Scope : ZohoBooks.projects.CREATE
Arguments
Max-length [100]
Max-length [500]
fixed_cost_for_project
, based_on_project_hours
, based_on_staff_hours
and based_on_task_hours
total_project_cost
, total_project_hours
, hours_per_task
and hours_per_staff
Max-length [100]
Max-length [500]
Max-length [200]
Max-length [100]
staff
, admin
and timesheetstaff
Update a project using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update a project by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. Based on this value, the corresponding project will be retrieved and updated. Additionally, there is an optional X-Upsert header. If the X-Upsert header is true and the custom field's unique value is not found in any of the existing projects, a new project will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.projects.UPDATE
Arguments
Max-length [100]
Max-length [500]
fixed_cost_for_project
, based_on_project_hours
, based_on_staff_hours
and based_on_task_hours
total_project_cost
, total_project_hours
, hours_per_task
and hours_per_staff
Max-length [100]
Max-length [500]
Max-length [200]
Max-length [100]
staff
, admin
and timesheetstaff
List projects
List all projects with pagination.
OAuth Scope : ZohoBooks.projects.READ
Query Parameters
Status.All
, Status.Active
and Status.Inactive
project_name
, customer_name
, rate
and created_time
Update project
Update details of a project.
OAuth Scope : ZohoBooks.projects.UPDATE
Arguments
Max-length [100]
Max-length [500]
fixed_cost_for_project
, based_on_project_hours
, based_on_staff_hours
and based_on_task_hours
total_project_cost
, total_project_hours
, hours_per_task
and hours_per_staff
Max-length [100]
Max-length [500]
Max-length [200]
Max-length [100]
staff
, admin
and timesheetstaff
Get a project
Get the details of a project.
OAuth Scope : ZohoBooks.projects.READ
Delete project
Deleting a existing project.
OAuth Scope : ZohoBooks.projects.DELETE
Activate project
Mark project as active.
OAuth Scope : ZohoBooks.projects.CREATE
Inactivate a project
Marking a project as inactive.
OAuth Scope : ZohoBooks.projects.CREATE
Clone project
Cloning a project.
OAuth Scope : ZohoBooks.projects.CREATE
Arguments
Max-length [100]
Max-length [500]
Assign users
Assign a users to a project.
OAuth Scope : ZohoBooks.projects.CREATE
Arguments
List Users
Get list of users associated with a project.
OAuth Scope : ZohoBooks.projects.READ
Invite user
Invite and user to the project.
OAuth Scope : ZohoBooks.projects.CREATE
Arguments
Max-length [200]
Max-length [100]
staff
, admin
and timesheetstaff
Update user
Update details of a user.
OAuth Scope : ZohoBooks.projects.UPDATE
Arguments
Max-length [200]
staff
, admin
and timesheetstaff
Get a User
Get details of a user in project.
OAuth Scope : ZohoBooks.projects.READ
Delete user
Remove user from a project.
OAuth Scope : ZohoBooks.projects.DELETE
Post comment
Post comment to a project.
OAuth Scope : ZohoBooks.projects.CREATE
Arguments
Max-length [500]
List comments
Get comments for a project.
OAuth Scope : ZohoBooks.projects.READ
Delete comment
Deleting a comment.
OAuth Scope : ZohoBooks.projects.DELETE
List invoices
Lists invoices created for this project.
OAuth Scope : ZohoBooks.projects.READ
Query Parameters
invoice_number
, date
, total
, balance
and created_time