Please note that this API is deprecated. Use timetracking instead.

Timesheets API (deprecated)

List timesheets

GET /monitoring
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • date

The following scopes are needed:

  • monitoring_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Warning: 199 Resource deprecated
Content-Length: 1904
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "date": "2013-02-12",
    "needed_hour": 1,
    "needed_min": 0,
    "monitoring_status_id": null,
    "allowable_bill": true,
    "client_service_id": 1,
    "text": "",
    "estimated_hour": null,
    "estimated_min": null,
    "charge": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "task_id": null,
    "article_id": null,
    "is_time_tracking": false,
    "has_active_time_tracking": false,
    "total_time_in_secs": 3600,
    "tracking_type": 1,
    "is_running": true,
    "start_time_tracking": "2015-09-18 15:41:12",
    "needed_hour_start": "2013-02-12 12:00:00",
    "needed_hour_end": "2013-02-12 13:00:00"
  },
  {
    "id": 2,
    "user_id": 1,
    "date": "2015-09-18",
    "needed_hour": 0,
    "needed_min": 0,
    "monitoring_status_id": null,
    "allowable_bill": true,
    "client_service_id": 1,
    "text": "",
    "estimated_hour": null,
    "estimated_min": null,
    "charge": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "task_id": null,
    "article_id": null,
    "is_time_tracking": true,
    "has_active_time_tracking": true,
    "total_time_in_secs": 63,
    "tracking_type": 2,
    "is_running": true,
    "start_time_tracking": "2015-09-18 15:41:12",
    "needed_hour_start": null,
    "needed_hour_end": null
  },
  {
    "id": 3,
    "user_id": 1,
    "date": "2013-02-12",
    "needed_hour": 2,
    "needed_min": 30,
    "monitoring_status_id": null,
    "allowable_bill": true,
    "client_service_id": 1,
    "text": "",
    "estimated_hour": null,
    "estimated_min": null,
    "charge": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "task_id": null,
    "article_id": null,
    "is_time_tracking": false,
    "has_active_time_tracking": false,
    "total_time_in_secs": 9000,
    "tracking_type": 0,
    "is_running": true,
    "start_time_tracking": "2015-09-18 15:41:12",
    "needed_hour_start": null,
    "needed_hour_end": null
  }
]

Search timesheets

POST /monitoring/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "client_service_id",
    "value": 1
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • date
  • id
Name Required Type Description
id optional string
client_service_id optional string
contact_id optional string
user_id optional string
pr_project_id optional string
monitoring_status_id optional string
date optional string

The following scopes are needed:

  • monitoring_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Warning: 199 Resource deprecated
Content-Length: 1904
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "date": "2013-02-12",
    "needed_hour": 1,
    "needed_min": 0,
    "monitoring_status_id": null,
    "allowable_bill": true,
    "client_service_id": 1,
    "text": "",
    "estimated_hour": null,
    "estimated_min": null,
    "charge": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "task_id": null,
    "article_id": null,
    "is_time_tracking": false,
    "has_active_time_tracking": false,
    "total_time_in_secs": 3600,
    "tracking_type": 1,
    "is_running": true,
    "start_time_tracking": "2015-09-18 15:41:12",
    "needed_hour_start": "2013-02-12 12:00:00",
    "needed_hour_end": "2013-02-12 13:00:00"
  },
  {
    "id": 2,
    "user_id": 1,
    "date": "2015-09-18",
    "needed_hour": 0,
    "needed_min": 0,
    "monitoring_status_id": null,
    "allowable_bill": true,
    "client_service_id": 1,
    "text": "",
    "estimated_hour": null,
    "estimated_min": null,
    "charge": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "task_id": null,
    "article_id": null,
    "is_time_tracking": true,
    "has_active_time_tracking": true,
    "total_time_in_secs": 63,
    "tracking_type": 2,
    "is_running": true,
    "start_time_tracking": "2015-09-18 15:41:12",
    "needed_hour_start": null,
    "needed_hour_end": null
  },
  {
    "id": 3,
    "user_id": 1,
    "date": "2013-02-12",
    "needed_hour": 2,
    "needed_min": 30,
    "monitoring_status_id": null,
    "allowable_bill": true,
    "client_service_id": 1,
    "text": "",
    "estimated_hour": null,
    "estimated_min": null,
    "charge": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "task_id": null,
    "article_id": null,
    "is_time_tracking": false,
    "has_active_time_tracking": false,
    "total_time_in_secs": 9000,
    "tracking_type": 0,
    "is_running": true,
    "start_time_tracking": "2015-09-18 15:41:12",
    "needed_hour_start": null,
    "needed_hour_end": null
  }
]

Show timesheet

GET /monitoring/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • monitoring_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 7b41adf012904ae8f18b0335844cbebf
Warning: 199 Resource deprecated
Content-Length: 608
Content-Type: application/json
{
  "id": 4,
  "user_id": 1,
  "date": "2013-02-12",
  "needed_hour": 2,
  "needed_min": 30,
  "monitoring_status_id": null,
  "allowable_bill": true,
  "client_service_id": 1,
  "text": "",
  "estimated_hour": null,
  "estimated_min": null,
  "charge": null,
  "travel_time": null,
  "travel_charge": null,
  "travel_distance": null,
  "contact_id": null,
  "sub_contact_id": null,
  "pr_project_id": null,
  "pr_package_id": null,
  "pr_milestone_id": null,
  "task_id": null,
  "article_id": null,
  "is_time_tracking": false,
  "has_active_time_tracking": false,
  "total_time_in_secs": 9000,
  "tracking_type": 0,
  "is_running": false,
  "start_time_tracking": null,
  "needed_hour_start": null,
  "needed_hour_end": null
}

Create timesheet

POST /monitoring
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "date": "2013-02-12",
  "client_service_id": 1,
  "duration": "02:30",
  "allowable_bill": true,
  "tracking_type": 0
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
allowable_bill required boolean
client_service_id required Resource client_service
date required date (Format yyyy-mm-dd)
duration required time (Format hh:ii)
needed_hour_end required datetime (Format yyyy-mm-dd hh:ii:ss)
needed_hour_start required datetime (Format yyyy-mm-dd hh:ii:ss)
tracking_type required undefined Valid values:

0 => Type duration
1 => Type from / to
2 => Type stopwatch
user_id required Resource user
article_id optional Resource article
charge optional decimal
contact_id optional Resource contact
estimated_hour optional time (Format hh:ii)
estimated_time optional time (Format hh:ii)
monitoring_status_id optional Resource monitoring_status
pr_milestone_id optional Resource pr_milestone
pr_package_id optional Resource pr_package
pr_project_id optional Resource pr_project
sub_contact_id optional Resource contact
task_id optional Resource task
text optional string (10000)

The following scopes are needed:

  • monitoring_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: 7b41adf012904ae8f18b0335844cbebf
Warning: 199 Resource deprecated
Content-Length: 608
Content-Type: application/json
{
  "id": 4,
  "user_id": 1,
  "date": "2013-02-12",
  "needed_hour": 2,
  "needed_min": 30,
  "monitoring_status_id": null,
  "allowable_bill": true,
  "client_service_id": 1,
  "text": "",
  "estimated_hour": null,
  "estimated_min": null,
  "charge": null,
  "travel_time": null,
  "travel_charge": null,
  "travel_distance": null,
  "contact_id": null,
  "sub_contact_id": null,
  "pr_project_id": null,
  "pr_package_id": null,
  "pr_milestone_id": null,
  "task_id": null,
  "article_id": null,
  "is_time_tracking": false,
  "has_active_time_tracking": false,
  "total_time_in_secs": 9000,
  "tracking_type": 0,
  "is_running": false,
  "start_time_tracking": null,
  "needed_hour_start": null,
  "needed_hour_end": null
}

Overwrite timesheet

PUT /monitoring/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "date": "2013-02-12",
  "client_service_id": 1,
  "duration": "02:30",
  "allowable_bill": true,
  "tracking_type": 0
}
Name Required Type Description
callback optional string
Name Required Type Description
allowable_bill required boolean
client_service_id required Resource client_service
date required date (Format yyyy-mm-dd)
duration required time (Format hh:ii)
needed_hour_end required datetime (Format yyyy-mm-dd hh:ii:ss)
needed_hour_start required datetime (Format yyyy-mm-dd hh:ii:ss)
tracking_type required undefined Valid values:

0 => Type duration
1 => Type from / to
2 => Type stopwatch
user_id required Resource user
article_id optional Resource article
charge optional decimal
contact_id optional Resource contact
estimated_hour optional time (Format hh:ii)
estimated_time optional time (Format hh:ii)
monitoring_status_id optional Resource monitoring_status
pr_milestone_id optional Resource pr_milestone
pr_package_id optional Resource pr_package
pr_project_id optional Resource pr_project
sub_contact_id optional Resource contact
task_id optional Resource task
text optional string (10000)

The following scopes are needed:

  • monitoring_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: 7b41adf012904ae8f18b0335844cbebf
Warning: 199 Resource deprecated
Content-Length: 624
Content-Type: application/json
{
  "id": 4,
  "user_id": 1,
  "date": "2013-02-12",
  "needed_hour": 2,
  "needed_min": 30,
  "monitoring_status_id": null,
  "allowable_bill": true,
  "client_service_id": 1,
  "text": "",
  "estimated_hour": null,
  "estimated_min": null,
  "charge": null,
  "travel_time": null,
  "travel_charge": null,
  "travel_distance": null,
  "contact_id": null,
  "sub_contact_id": null,
  "pr_project_id": null,
  "pr_package_id": null,
  "pr_milestone_id": null,
  "task_id": null,
  "article_id": null,
  "is_time_tracking": false,
  "has_active_time_tracking": false,
  "total_time_in_secs": 9000,
  "tracking_type": 0,
  "is_running": true,
  "start_time_tracking": "2015-09-18 15:42:15",
  "needed_hour_start": null,
  "needed_hour_end": null
}

Delete timesheet

DELETE /monitoring/4
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • monitoring_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Warning: 199 Resource deprecated
Content-Length: 16
Content-Type: application/json
{
  "success": true
}

Start stopwatch

POST /monitoring/1/start
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript-Callback

The following scopes are needed:

  • monitoring_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Warning: 199 Resource deprecated
Content-Length: 16
Content-Type: application/json
{
  "success": true
}

Stop stopwatch

POST /monitoring/1/stop
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript-Callback

The following scopes are needed:

  • monitoring_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Warning: 199 Resource deprecated
Content-Length: 16
Content-Type: application/json
{
  "success": true
}