Timetrackings API

List timetrackings

GET /timesheet
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
Content-Length: 1051
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "status_id": null,
    "client_service_id": 1,
    "text": "",
    "allowable_bill": true,
    "charge": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "estimated_time": null,
    "date": "2013-02-12",
    "duration": "1:00",
    "running": false
  },
  {
    "id": 2,
    "user_id": 1,
    "status_id": null,
    "client_service_id": 1,
    "text": "",
    "allowable_bill": true,
    "charge": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "estimated_time": null,
    "date": "2015-09-18",
    "duration": "0:01",
    "running": false
  },
  {
    "id": 3,
    "user_id": 1,
    "status_id": null,
    "client_service_id": 1,
    "text": "",
    "allowable_bill": true,
    "charge": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "estimated_time": null,
    "date": "2013-02-12",
    "duration": "2:30",
    "running": false
  }
]

Search timetrackings

POST /timesheet/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
status_id optional string

The following scopes are needed:

  • monitoring_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 1051
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "status_id": null,
    "client_service_id": 1,
    "text": "",
    "allowable_bill": true,
    "charge": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "estimated_time": null,
    "date": "2013-02-12",
    "duration": "1:00",
    "running": false
  },
  {
    "id": 2,
    "user_id": 1,
    "status_id": null,
    "client_service_id": 1,
    "text": "",
    "allowable_bill": true,
    "charge": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "estimated_time": null,
    "date": "2015-09-18",
    "duration": "0:01",
    "running": false
  },
  {
    "id": 3,
    "user_id": 1,
    "status_id": null,
    "client_service_id": 1,
    "text": "",
    "allowable_bill": true,
    "charge": null,
    "contact_id": null,
    "sub_contact_id": null,
    "pr_project_id": null,
    "pr_package_id": null,
    "pr_milestone_id": null,
    "travel_time": null,
    "travel_charge": null,
    "travel_distance": null,
    "estimated_time": null,
    "date": "2013-02-12",
    "duration": "2:30",
    "running": false
  }
]

Show timetracking

GET /timesheet/5
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: 7ae0e05e3adf8e8dc8cbf5c85b0b0de9
Content-Length: 418
Content-Type: application/json
{
  "id": 5,
  "user_id": 1,
  "status_id": null,
  "client_service_id": 1,
  "text": "",
  "allowable_bill": true,
  "charge": null,
  "contact_id": null,
  "sub_contact_id": null,
  "pr_project_id": null,
  "pr_package_id": null,
  "pr_milestone_id": null,
  "travel_time": null,
  "travel_charge": null,
  "travel_distance": null,
  "estimated_time": null,
  "date": "2013-02-01",
  "duration": "2:30",
  "running": false,
  "tracking": {
    "type": "duration",
    "date": "2013-02-01",
    "duration": "2:30"
  }
}

Create timetracking

POST /timesheet
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "client_service_id": 1,
  "allowable_bill": true,
  "tracking": {
    "type": "duration",
    "date": "2013-02-01",
    "duration": "02:30"
  }
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
allowable_bill required boolean
client_service_id required Resource client_service
tracking required undefined Valid values for type:

duration => fields date, duration
range => fields start (datetime Format yyyy-mm-dd hh:ii:ss), end (datetime Format yyyy-mm-dd hh:ii:ss)
user_id required Resource user
charge optional decimal
contact_id optional Resource contact
estimated_time optional time (Format hh:ii)
pr_milestone_id optional Resource pr_milestone
pr_package_id optional Resource pr_package
pr_project_id optional Resource pr_project
status_id optional Resource monitoring_status
sub_contact_id optional Resource contact
text optional string (10000)

The following scopes are needed:

  • monitoring_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Etag: 7ae0e05e3adf8e8dc8cbf5c85b0b0de9
Content-Length: 418
Content-Type: application/json
{
  "id": 5,
  "user_id": 1,
  "status_id": null,
  "client_service_id": 1,
  "text": "",
  "allowable_bill": true,
  "charge": null,
  "contact_id": null,
  "sub_contact_id": null,
  "pr_project_id": null,
  "pr_package_id": null,
  "pr_milestone_id": null,
  "travel_time": null,
  "travel_charge": null,
  "travel_distance": null,
  "estimated_time": null,
  "date": "2013-02-01",
  "duration": "2:30",
  "running": false,
  "tracking": {
    "type": "duration",
    "date": "2013-02-01",
    "duration": "2:30"
  }
}

Edit timetracking

POST /timesheet/5
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "tracking": {
    "date": "2013-02-12",
    "duration": "14:45"
  }
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
allowable_bill optional boolean
charge optional decimal
client_service_id optional Resource client_service
contact_id optional Resource contact
estimated_time optional time (Format hh:ii)
pr_milestone_id optional Resource pr_milestone
pr_package_id optional Resource pr_package
pr_project_id optional Resource pr_project
status_id optional Resource monitoring_status
sub_contact_id optional Resource contact
text optional string (10000)
tracking optional undefined Valid values for type:

duration => fields date, duration
range => fields start (datetime Format yyyy-mm-dd hh:ii:ss), end (datetime Format yyyy-mm-dd hh:ii:ss)
user_id optional Resource user

The following scopes are needed:

  • monitoring_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Etag: b77b5f2c3cb2219fe0fef9f44528547b
Content-Length: 420
Content-Type: application/json
{
  "id": 5,
  "user_id": 1,
  "status_id": null,
  "client_service_id": 1,
  "text": "",
  "allowable_bill": true,
  "charge": null,
  "contact_id": null,
  "sub_contact_id": null,
  "pr_project_id": null,
  "pr_package_id": null,
  "pr_milestone_id": null,
  "travel_time": null,
  "travel_charge": null,
  "travel_distance": null,
  "estimated_time": null,
  "date": "2013-02-12",
  "duration": "14:45",
  "running": false,
  "tracking": {
    "type": "duration",
    "date": "2013-02-12",
    "duration": "14:45"
  }
}

Delete timetracking

DELETE /timesheet/5
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
Content-Length: 16
Content-Type: application/json
{
  "success": true
}