API Docs
/
No Results Found
Time-Entries

Time-Entries

Time entries are various entries of time made by users in a project, based on the time they spent on a project, in a task.

Attribute

time_entry_id
string
project_id
string
Search time entries by project_id.
project_name
string
customer_id
string
Search projects by customer id.
customer_name
string
task_id
string
ID of the task.
task_name
string
user_id
string
Search time entries by user_id.
user_name
string
is_current_user
boolean
log_date
string
Date on which the user spent on the task. Date-Format [HH:mm]
begin_time
string
end_time
string
log_time
string
is_billable
boolean
billed_status
string
invoice_id
string
notes
string
timer_started_at
string
timer_started_at_utc_time
string
timer_duration_in_minutes
string
timer_duration_in_seconds
string
created_time
string
timesheet_custom_fields
string

Example

{ "time_entry_id": "460000000044021", "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "task_id": "460000000044009", "task_name": "Distribution Analysis", "user_id": "460000000024003", "user_name": "John David", "is_current_user": true, "log_date": "2013-09-17", "begin_time": "03:00", "end_time": "04:00", "log_time": "05:00", "is_billable": true, "billed_status": "unbilled", "invoice_id": "", "notes": " ", "timer_started_at": " ", "timer_started_at_utc_time": "", "timer_duration_in_minutes": " ", "timer_duration_in_seconds": "", "created_time": "2013-09-18T18:05:27+0530", "timesheet_custom_fields": "" }

Log time entries

Logging time entries.
oauthscope : ZohoBooks.projects.CREATE

Arguments

project_id
string
(Required)
ID of the project.
task_id
string
(Required)
ID of the task.
user_id
string
(Required)
ID of the user.
log_date
string
(Required)
Date on which the user spent on the task. Date-Format [HH:mm]
log_time
string
Time the user spent on this task. Either send this attribute or begin and end time attributes. Time-Format [HH:mm]
begin_time
string
Time the user started working on this task. Time-Format [HH:mm]
end_time
string
Time the user stopped working on this task. Time-Format [HH:mm]
is_billable
boolean
Whether it is billable or not.
notes
string
Description of the work done. Max-length [500]
start_timer
string
Start timer.
cost_rate
double
Hourly cost rate

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/timeentries?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
{ "project_id": "Network Distribution", "task_id": "460000000044001", "user_id": "460000000024003", "log_date": "2013-09-17", "log_time": " ", "begin_time": "10:00", "end_time": "15:00", "is_billable": true, "notes": " ", "start_timer": " ", "cost_rate": 10 }

Response Example

{ "code": 0, "message": "Your timesheet entry has been added.", "time_entry": { "time_entry_id": "460000000044021", "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "task_id": "460000000044009", "task_name": "Distribution Analysis", "user_id": "460000000024003", "user_name": "John David", "is_current_user": true, "log_date": "2013-09-17", "begin_time": "03:00", "end_time": "04:00", "log_time": "05:00", "is_billable": true, "billed_status": "unbilled", "invoice_id": "", "notes": " ", "timer_started_at": " ", "timer_started_at_utc_time": "", "timer_duration_in_minutes": " ", "timer_duration_in_seconds": "", "created_time": "2013-09-18T18:05:27+0530", "timesheet_custom_fields": "" } }

List time entries.

List all time entries with pagination.
oauthscope : ZohoBooks.projects.READ

Query Parameters

from_date
Date from which the time entries logged to be fetched
to_date
Date up to which the time entries logged to be fetched
filter_by
Filter time entries by date and status. Allowed Values: Date.All, Date.Today, Date.ThisWeek, Date.ThisMonth, Date.ThisQuarter, Date.ThisYear, Date.PreviousDay, Date.PreviousWeek, Date.PreviousMonth, Date.PreviousQuarter, Date.PreviousYear, Date.CustomDate, Status.Unbilled and Status.Invoiced
project_id
Search time entries by project_id.
user_id
Search time entries by user_id.
sort_column
Sort time entries. Allowed Values: project_name, task_name, user_name, log_date, timer_started_at and customer_name
organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/timeentries?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "time_entries": [ { "time_entry_id": "460000000044021", "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "task_id": "460000000044009", "task_name": "Distribution Analysis", "user_id": "460000000024003", "is_current_user": true, "user_name": "John David", "log_date": "2013-09-17", "begin_time": "03:00", "end_time": "04:00", "log_time": "05:00", "is_billable": true, "billed_status": "unbilled", "invoice_id": "", "notes": " ", "timer_started_at": " ", "timer_duration_in_minutes": " ", "created_time": "2013-09-18T18:05:27+0530", "cost_rate": 0, "cost_amount": 0 }, {...}, {...} ], "page_context": [ { "page": 10, "per_page": 450, "report_name": "Projects", "has_more_page": false, "sort_order": "D", "sort_column": "customer_name" } ] }

Delete time entries

Deleting time entries.
oauthscope : ZohoBooks.projects.DELETE

Arguments

time_entry_ids
string
(Required)
ID of the time entries to be deleted.

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/timeentries?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
{ "time_entry_ids": " " }

Response Example

{ "code": 0, "message": "The selected timesheet entries have been deleted" }

Update time entry

Update logged time entry.
oauthscope : ZohoBooks.projects.UPDATE

Arguments

project_id
string
(Required)
ID of the project.
task_id
string
(Required)
ID of the task.
user_id
string
(Required)
ID of the user.
log_date
string
(Required)
Date on which the user spent on the task. Date-Format [HH:mm]
log_time
string
Time the user spent on this task. Either send this attribute or begin and end time attributes. Time-Format [HH:mm]
begin_time
string
Time the user started working on this task. Time-Format [HH:mm]
end_time
string
Time the user stopped working on this task. Time-Format [HH:mm]
is_billable
boolean
Whether it is billable or not.
notes
string
Description of the work done. Max-length [500]
start_timer
string
Start timer.
cost_rate
double
Hourly cost rate

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/timeentries/:time_entry_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
{ "project_id": "Network Distribution", "task_id": "460000000044001", "user_id": "460000000024003", "log_date": "2013-09-17", "log_time": " ", "begin_time": "10:00", "end_time": "15:00", "is_billable": true, "notes": " ", "start_timer": " ", "cost_rate": 0 }

Response Example

{ "code": 0, "message": "The timesheet's information has been updated.", "time_entry": { "time_entry_id": "460000000044021", "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "task_id": "460000000044009", "task_name": "Distribution Analysis", "user_id": "460000000024003", "user_name": "John David", "is_current_user": true, "log_date": "2013-09-17", "begin_time": "03:00", "end_time": "04:00", "log_time": "05:00", "is_billable": true, "billed_status": "unbilled", "invoice_id": "", "notes": " ", "timer_started_at": " ", "timer_started_at_utc_time": "", "timer_duration_in_minutes": " ", "timer_duration_in_seconds": "", "created_time": "2013-09-18T18:05:27+0530", "timesheet_custom_fields": "" } }

Get a time entry

Get details of a time entry.
oauthscope : ZohoBooks.projects.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/timeentries/:time_entry_id?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "time_entry": { "time_entry_id": "460000000044021", "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "task_id": "460000000044009", "task_name": "Distribution Analysis", "user_id": "460000000024003", "user_name": "John David", "is_current_user": true, "log_date": "2013-09-17", "begin_time": "03:00", "end_time": "04:00", "log_time": "05:00", "is_billable": true, "billed_status": "unbilled", "invoice_id": "", "notes": " ", "timer_started_at": " ", "timer_started_at_utc_time": "", "timer_duration_in_minutes": " ", "timer_duration_in_seconds": "", "created_time": "2013-09-18T18:05:27+0530", "timesheet_custom_fields": "", "cost_rate": 0 } }

Delete time entry

Deleting a logged time entry.
oauthscope : ZohoBooks.projects.DELETE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/timeentries/:time_entry_id?organization_id=10234695 -X DELETE -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

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

Start timer

Start tracking time spent.
oauthscope : ZohoBooks.projects.CREATE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/timeentries/:time_entry_id/timer/start?organization_id=10234695 -X POST -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "The timer has been started.", "time_entry": { "time_entry_id": "460000000044021", "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "task_id": "460000000044009", "task_name": "Distribution Analysis", "user_id": "460000000024003", "user_name": "John David", "is_current_user": true, "log_date": "2013-09-17", "begin_time": "03:00", "end_time": "04:00", "log_time": "05:00", "is_billable": true, "billed_status": "unbilled", "invoice_id": "", "notes": " ", "timer_started_at": " ", "timer_started_at_utc_time": "", "timer_duration_in_minutes": " ", "timer_duration_in_seconds": "", "created_time": "2013-09-18T18:05:27+0530", "timesheet_custom_fields": "" } }

Stop timer

Stop tracking time, say taking a break or leaving.
oauthscope : ZohoBooks.projects.CREATE

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/timeentries/timer/stop?organization_id=10234695 -X POST -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "Timer has been stopped successfully.", "time_entry": { "time_entry_id": "460000000044021", "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "task_id": "460000000044009", "task_name": "Distribution Analysis", "user_id": "460000000024003", "user_name": "John David", "is_current_user": true, "log_date": "2013-09-17", "begin_time": "03:00", "end_time": "04:00", "log_time": "05:00", "is_billable": true, "billed_status": "unbilled", "invoice_id": "", "notes": " ", "timer_started_at": " ", "timer_started_at_utc_time": "", "timer_duration_in_minutes": " ", "timer_duration_in_seconds": "", "created_time": "2013-09-18T18:05:27+0530", "timesheet_custom_fields": "" } }

Get timer

Get current running timer.
oauthscope : ZohoBooks.projects.READ

Query Parameters

organization_id
(Required)
ID of the organization

Request Example

Click to copy
$ curl https://books.zoho.com/api/v3/projects/timeentries/runningtimer/me?organization_id=10234695 -H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

Response Example

{ "code": 0, "message": "success", "time_entry": { "time_entry_id": "460000000044021", "project_id": "460000000044019", "project_name": "REAL TIME TRAFFIC FLUX", "customer_id": "460000000044001", "customer_name": "SAF Instruments Inc", "task_id": "460000000044009", "task_name": "Distribution Analysis", "user_id": "460000000024003", "user_name": "John David", "is_current_user": true, "log_date": "2013-09-17", "begin_time": "03:00", "end_time": "04:00", "log_time": "05:00", "is_billable": true, "billed_status": "unbilled", "invoice_id": "", "notes": " ", "timer_started_at": " ", "timer_started_at_utc_time": "", "timer_duration_in_minutes": " ", "timer_duration_in_seconds": "", "created_time": "2013-09-18T18:05:27+0530", "timesheet_custom_fields": "" } }