API v1 ReferenceTime Reports

Returns time reports of a user.

Returns time reports of a user. The response includes details for the selected time range. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

OK
sharedbooleanOptional
Whether the time report is shared.
dateModestring or nullOptional

The date mode of the time report. Can be: “today”, “yesterday”, “selectDate”, “selectWeek”, “currentWeek”, “lastWeek”, “selectMonth”, “currentMonth”, “lastMonth”, “selectQuarter”, “currentQuarter”, “lastQuarter”, “selectYear”, “currentYear”, “lastYear”, “customRange”, “noFilter”.

startOnstring or nullOptionalformat: "date-time"
The start date time of the report when DateMode is "customRange".
endOnstring or nullOptionalformat: "date-time"
The end date time of the time report. when DateMode is "customRange". Currently the start of the end day.
filterstring or nullOptional
The generated filter query of the time report.
chartTypestring or nullOptional

The actual chart type of the time report. Can be: “group” or “time”.

projectIdstring or nullOptionalformat: "uuid"
The id of the project of the time report. Used for the pdf reports.
companyIdstring or nullOptionalformat: "uuid"
The id of the company of the time report. Used for the pdf reports.
sumBystring or nullOptional
Summarises the values by the sum of this property.
sortBystring or nullOptional
Sorts the values by this property.
sortByOrderstring or nullOptional

The way how to sort the data. Can be: “asc”, desc”.

roundBystring or nullOptional

Rounding method of the time report. Can be: “nearQuarter”, “nearHalf”, “nearHour”, “upQuarter”, “upHalf”, “upHour”.

groupBystring or nullOptional
Group the values by property.
sortColumnstring or nullOptional
Sort the values of the time report by a column.
sortGroupsEnabledboolean or nullOptional
Whether sorting of groups is enabled.
availableColumnslist of strings or nullOptional

List of shown Columns in the time report. Can be: “status”, “duration”, “task”, “timeTrackingNote”, “typeOfWork”, “project”, “date”, “time”, “user”, “client”, “projectType”, “projectRole”, “plannedDuration”, “taskList”, “key”.

billingStatuseslist of strings or nullOptional

Filter of bill satuses of the time report. Can be: “billed”, “notBilled”, “notBillable”.

notestring or nullOptional
Filter time entries by note.
usersFilterlist of strings or nullOptional
Filter time entries by users.
projectsFilterlist of strings or nullOptional
Filter time entries by projects.
noProjectFilterboolean or nullOptional
Filter to show also time entries without a project.
projectCompaniesFilterlist of strings or nullOptional
Filter time entries by projects of the companies.
projectTypesFilterlist of strings or nullOptional
Filter time entries by projects of the type.
projectStatusesNameFilterlist of strings or nullOptional
Filter time entries by projects with status name.
projectStatusTypesFilterlist of strings or nullOptional
Filter time entries by projects with status of type.
projectTeamsFilterlist of strings or nullOptional
List of teams, to the filter the projects for.
userTeamsFilterlist of strings or nullOptional
Filter for the teams to filter the users.
taskTagsModelFilterlist of objects or nullOptional
Filter time entries by the tags of the task.
projectTagsModelFilterlist of objects or nullOptional
Filter time entries by the tags of the project.
userTagsModelFilterlist of objects or nullOptional
Filter time entries by the tags of the users.
typesOfWorkFilterlist of strings or nullOptional
Group the time report by the type of works.
namestring or nullOptional
The name of the time report.
idstringOptionalformat: "uuid"
The id of the time report.
userobjectOptional
updatedOnstringOptionalformat: "date-time"
The date this time report was updated.
resourceVersionlongOptionalRead-only
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.