Top

Time Entries

List time entries.
GET /projects/timeentries
List all time entries with pagination.
Get a time entry
GET /projects/timeentries/:time_entry_id
Get details of a time entry.
Log time entries
POST /projects/timeentries
Logging time entries.
Update time entry
PUT /projects/timeentries/:time_entry_id
Update logged time entry
Delete time entry
DELETE /projects/timeentries/:time_entry_id
Deleting a logged time entry.
Delete time entries
DELETE /projects/timeentries
Deleting time entries
Get timer
GET /projects/timeentries/runningtimer/me
Get current running timer
Start timer
POST /projects/timeentries/:time_entry_id/timer/start
Start tracking time spent
Stop timer
POST /projects/timeentries/timer/stop
Stop tracking time, say taking a break or leaving

List time entries.

GET  /projects/timeentries

List all time entries with pagination.

Parameters

from_date string
[yyyy-MM-dd]
Date from which the time entries logged to be fetched
to_date string
[yyyy-MM-dd]
Date up to which the time entries logged to be fetched
filter_by string 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 string Search time entries by project_id.
user_id string Search time entries by user_id.
sort_column string Sort time entries.
Allowed Values: project_name, task_name, user_name, log_date, timer_started_at and customer_name

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "success",
      "time_entries": [
        {
          "time_entry_id": "460000000044021",
          "project_id": "460000000044007",
          "project_name": "Network Distribution",
          "customer_id": "460000000044001",
          "customer_name": "Richards Electric Company",
          "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": "",
          "end_time": "",
          "log_time": "05:00",
          "is_billable": true,
          "billed_status": "unbilled",
          "notes": "",
          "timer_started_at": "",
          "timer_duration_in_minutes": "",
          "created_time": "2013-09-17T18:05:27+0530"
        },
        {
          "time_entry_id": "460000000044025",
          "project_id": "460000000044007",
          "project_name": "Network Distribution",
          "customer_id": "460000000044001",
          "customer_name": "Richards Electric Company",
          "task_id": "460000000044009",
          "task_name": "Distribution Analysis",
          "user_id": "460000000024003",
          "is_current_user": true,
          "user_name": "John David",
          "log_date": "2013-09-18",
          "begin_time": "",
          "end_time": "",
          "log_time": "03:01",
          "is_billable": true,
          "billed_status": "unbilled",
          "notes": "",
          "timer_started_at": "2013-09-18 19:12:19",
          "timer_duration_in_minutes": 2,
          "created_time": "2013-09-18T18:05:27+0530"
        }
      ],
      "page_context": {
        "page": 1,
        "per_page": 200,
        "has_more_page": false,
        "report_name": "Timesheet",
        "applied_filter": "Date.All",
        "sort_column": "task_name",
        "sort_order": "A"
      }
    }

Get a time entry

GET  /projects/timeentries/:time_entry_id

Get details of a time entry.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "success",
      "time_entry": {
        "time_entry_id": "460000000044021",
        "project_id": "460000000044007",
        "project_name": "Network Distribution",
        "customer_id": "460000000044001",
        "customer_name": "Richards Electric Company",
        "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": "",
        "end_time": "",
        "log_time": "05:00",
        "is_billable": true,
        "billed_status": "invoiced",
        "notes": "",
        "timer_started_at": "",
        "timer_duration_in_minutes": 0,
        "created_time": "2013-09-17T18:05:27+0530"
      }
    }

Log time entries

POST  /projects/timeentries

Logging time entries.

Request attributes

project_id* string ID of the project
task_id* string ID of the task.
user_id* string ID of the user.
log_date* string
[yyyy-MM-dd]
Date on which the user spent on the task.
log_time string
[HH:mm]
Time the user spent on this task. Either send this attribute or begin and end time attributes.
begin_time string
[HH:mm]
Time the user started working on this task.
end_time string
[HH:mm]
Time the user stopped working on this task.
is_billable boolean Whether it is billable or not
notes string
[500]
Description of the work done.
start_timer boolean Start timer.

Sample Request

{
      "project_id": "460000000044007",
      "task_id": "460000000044009",
      "user_id": "460000000024003",
      "log_date": "2013-09-17",
      "begin_time": "10:00",
      "end_time": "15:00",
      "log_time": "",
      "is_billable": true,
      "notes": "",
      "start_timer": ""
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "Your timesheet entry has been added",
      "time_entry": {
        "time_entry_id": "460000000044021",
        "project_id": "460000000044007",
        "project_name": "Network Distribution",
        "customer_id": "460000000044001",
        "customer_name": "Richards Electric Company",
        "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": "10:00",
        "end_time": "15:00",
        "log_time": "05:00",
        "is_billable": true,
        "billed_status": "invoiced",
        "notes": "",
        "timer_started_at": "",
        "timer_duration_in_minutes": 0,
        "created_time": "2013-09-17T18:05:27+0530"
      }
    }

Update time entry

PUT  /projects/timeentries/:time_entry_id

Update logged time entry

Request attributes

project_id* string ID of the project
task_id* string ID of the task.
user_id* string ID of the user.
log_date* string
[yyyy-MM-dd]
Date on which the user spent on the task.
log_time string
[HH:mm]
Time the user spent on this task. Either send this attribute or begin and end time attributes.
begin_time string
[HH:mm]
Time the user started working on this task.
end_time string
[HH:mm]
Time the user stopped working on this task.
is_billable boolean Whether it is billable or not
notes string
[500]
Description of the work done.
start_timer boolean Start timer.

Sample Request

{
      "project_id": "460000000044007",
      "task_id": "460000000044009",
      "user_id": "460000000024003",
      "log_date": "2013-09-17",
      "log_time": "05:00",
      "is_billable": true,
      "notes": "",
      "start_timer": ""
    }

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The timesheet's information has been updated.",
      "time_entry": {
        "time_entry_id": "460000000044021",
        "project_id": "460000000044007",
        "project_name": "Network Distribution",
        "customer_id": "460000000044001",
        "customer_name": "Richards Electric Company",
        "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": "",
        "end_time": "",
        "log_time": "05:00",
        "is_billable": true,
        "billed_status": "invoiced",
        "notes": "",
        "timer_started_at": "",
        "timer_duration_in_minutes": 0,
        "created_time": "2013-09-17T18:05:27+0530"
      }
    }

Delete time entry

DELETE  /projects/timeentries/:time_entry_id

Deleting a logged time entry.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{"code": 0,"message":"The time entry has been deleted"}

Delete time entries

DELETE  /projects/timeentries

Deleting time entries

Parameters

time_entry_ids* string
[100]
ID of the time entries to be deleted.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{"code": 0,"message":"The selected timesheet entries have been deleted"}

Get timer

GET  /projects/timeentries/runningtimer/me

Get current running timer

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "success",
      "time_entry": {
        "time_entry_id": "460000000044021",
        "project_id": "460000000044007",
        "project_name": "Network Distribution",
        "customer_id": "460000000044001",
        "customer_name": "Richards Electric Company",
        "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": "",
        "end_time": "",
        "log_time": "05:00",
        "is_billable": true,
        "billed_status": "unbilled",
        "notes": "",
        "timer_started_at": "2013-10-17 19:00:28",
        "timer_duration_in_minutes": 20,
        "created_time": "2013-09-17T18:05:27+0530"
      }
    }

Start timer

POST  /projects/timeentries/:time_entry_id/timer/start

Start tracking time spent

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The timer has been started.",
      "time_entry": {
        "time_entry_id": "460000000044021",
        "project_id": "460000000044007",
        "project_name": "Network Distribution",
        "customer_id": "460000000044001",
        "customer_name": "Richards Electric Company",
        "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": "",
        "end_time": "",
        "log_time": "04:30",
        "is_billable": true,
        "billed_status": "unbilled",
        "notes": "",
        "timer_started_at": "2013-10-17 19:00:28",
        "timer_duration_in_minutes": 0,
        "created_time": "2013-09-17T18:05:27+0530"
      }
    }

Stop timer

POST  /projects/timeentries/timer/stop

Stop tracking time, say taking a break or leaving

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "Timer has been stopped successfully.",
      "time_entry": {
        "time_entry_id": "460000000044021",
        "project_id": "460000000044007",
        "project_name": "Network Distribution",
        "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": "",
        "end_time": "",
        "log_time": "05:00",
        "is_billable": true,
        "billed_status": "unbilled",
        "notes": "",
        "timer_started_at": "",
        "timer_duration_in_minutes": 0,
        "created_time": "2013-09-17T18:05:27+0530"
      }
    }