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 Code | Message |
---|---|
1002 | Project does not exists |
20004 | Please ensure that the amount is not negative |
20077 | Expense has been recorded for this project. Hence, it cannot be deleted |
Attribute
Maximum length [100]
fixed_cost_for_project
, based_on_project_hours
, based_on_staff_hours
and based_on_task_hours
Maximum length [200]
Maximum length [100]
staff
, admin
and timesheetstaff
Create a project
Create a new project.
OAuth Scope : ZohoSubscriptions.projects.CREATE
Arguments
Maximum length [100]
Maximu length [500]
fixed_cost_for_project
, based_on_project_hours
, based_on_staff_hours
and based_on_task_hours
Mandatory for projects whose billing_type is either
fixed_cost_for_project
or based_on_project_hours
total_project_cost
, total_project_hours
, hours_per_task
and hours_per_staff
Maximum length [100]
Maximum length [500]
Maximum length [200]
Maximum length [100]
staff
, admin
and timesheetstaff
List projects
List all projects with pagination.
OAuth Scope : ZohoSubscriptions.projects.READ
Query Parameters
Status.All
, Status.Active
and Status.Inactive
project_name
, customer_name
, rate
and created_time
Update a project
Update details of a project.
OAuth Scope : ZohoSubscriptions.projects.UPDATE
Arguments
Maximum length [100]
Maximum length [500]
fixed_cost_for_project
, based_on_project_hours
, based_on_staff_hours
and based_on_task_hours
fixed_cost_for_project"
or "based_on_project_hours"
total_project_cost
, total_project_hours
, hours_per_task
and hours_per_staff
Maximum length [100]
Maximum length [500]
Maximum length [200]
Maximum length [100]
staff
, admin
and timesheetstaff
Get a project
Get the details of a project.
OAuth Scope : ZohoSubscriptions.projects.READ
Delete project
Deleting a existing project.
OAuth Scope : ZohoSubscriptions.projects.DELETE
Activate a project
Mark project as active
OAuth Scope : ZohoSubscriptions.projects.CREATE
Deactivate a project
Marking a project as inactive.
OAuth Scope : ZohoSubscriptions.projects.CREATE
Clone a project
Cloning the settings of an existing project.
OAuth Scope : ZohoSubscriptions.projects.CREATE
Arguments
Maximum length [100]
Maximum length [500]
Assign users
Assign a users to a project.
OAuth Scope : ZohoSubscriptions.projects.CREATE
Arguments
List Users
Get list of all users associated to a project.
OAuth Scope : ZohoSubscriptions.projects.READ
Invite user
Invite a user to the project.
OAuth Scope : ZohoSubscriptions.projects.CREATE
Arguments
Maximum length [200]
Maximum length [100]
staff
, admin
and timesheetstaff
Update user
Update details of a user.
OAuth Scope : ZohoSubscriptions.projects.UPDATE
Arguments
Maximum length [200]
staff
, admin
and timesheetstaff
Get a User
Get details of a user in project.
OAuth Scope : ZohoSubscriptions.projects.READ
Delete user
Remove user from a project.
OAuth Scope : ZohoSubscriptions.projects.DELETE
Post comment
Post comment to a project.
OAuth Scope : ZohoSubscriptions.projects.CREATE
Arguments
Maximum length [500]
List comments
Get comments for a project.
OAuth Scope : ZohoSubscriptions.projects.READ
Delete comment
Deleting a comment.
OAuth Scope : ZohoSubscriptions.projects.DELETE
List invoices
Lists invoices created for this project.
OAuth Scope : ZohoSubscriptions.projects.READ
Query Parameters
invoice_number
, date
, total
, balance
and created_time