v1

Swagger 2.02026-07-13107162315.5 KB
TimesheetSummary

Retrieves aggregated timesheet statistics for a date range, with optional grouping by up to three dimensions (e.g. Project, User, Category, Task, Month). Requires EntryDateFrom and EntryDateTo.

get/api/TimesheetSummary

Query parameters

model.groupBystring[]

(Optional) Combine one, two or three levels of Grouping. Combine these possible grouping values: "Customer", "Project", "Category", "User", "Task", "Year", "Month", "Day", "Week".

model.entryDateFromstring date-time

(Required) Filter for timesheets greater or equal to the specified date. e.g. 2019-01-25. You can optionally include a time component, otherwise it assumes 00:00

model.entryDateTostring date-time

(Required) Filter for timesheets with an entry date smaller or equal to the specified date. e.g. 2019-01-25. You can optionally include a time component, otherwise it assumes 00:00

model.userIDinteger[]

(Optional) Defaults to the current user. Provide one or more UserIDs of Users whose timesheets should be retrieved. If the current user doesn't have impersonation rights, then they will only see their own data.

model.projectIDinteger

(Optional) Filter by Project

model.isBillableboolean

(Optional) Filter by the billable status of Timesheets.

model.isInvoicedboolean

(Optional) Filter for timesheets by whether they have been Invoiced or not.

model.timesheetEntryApprovalStatusCodestring[]

(Optional) Filter for timesheets that belong to one of the specified statuses (Draft, Pending, Approved, AutoApproved, Rejected)

Response

Returns aggregated timesheet totals with optional grouping.

EntryDateFromstring date-time

The start of the date range used for this summary.

EntryDateTostring date-time

The end of the date range used for this summary.

TotalHoursnumber double

Total hours across all timesheet entries in the result set.

BillableHoursnumber double

Total billable hours across all timesheet entries in the result set.

UserIDinteger[]

The list of user IDs included in this summary.

GroupingLevelsstring[]

The grouping dimensions applied to this summary result.