v1

latestOpenAPI 3.1.02026-08-066984441.1 MB

timeReports

Returns all time reports of a user.

Returns time reports the user created as well as the shared time reports of other users.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

get/timereports

Headers

Authorizationstring required

Bearer authentication

Response

sharedboolean

Whether the time report is shared.

dateModestring nullable

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 date-time nullable

The start date time of the report when DateMode is "customRange".

endOnstring date-time nullable

The end date time of the time report. when DateMode is "customRange". Currently the start of the end day.

filterstring nullable

The generated filter query of the time report.

chartTypestring nullable

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

projectIdstring uuid nullable

The id of the project of the time report. Used for the pdf reports.

companyIdstring uuid nullable

The id of the company of the time report. Used for the pdf reports.

sumBystring nullable

Summarises the values by the sum of this property.

sortBystring nullable

Sorts the values by this property.

sortByOrderstring nullable

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

roundBystring nullable

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

groupBystring nullable

Group the values by property.

sortColumnstring nullable

Sort the values of the time report by a column.

sortGroupsEnabledboolean nullable

Whether sorting of groups is enabled.

availableColumnsstring[] nullable

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".

billingStatusesstring[] nullable

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

notestring nullable

Filter time entries by note.

usersFilterstring[] nullable

Filter time entries by users.

projectsFilterstring[] nullable

Filter time entries by projects.

noProjectFilterboolean nullable

Filter to show also time entries without a project.

projectCompaniesFilterstring[] nullable

Filter time entries by projects of the companies.

projectTypesFilterstring[] nullable

Filter time entries by projects of the type.

projectStatusesNameFilterstring[] nullable

Filter time entries by projects with status name.

projectStatusTypesFilterstring[] nullable

Filter time entries by projects with status of type.

projectTeamsFilterstring[] nullable

List of teams, to the filter the projects for.

userTeamsFilterstring[] nullable

Filter for the teams to filter the users.

typesOfWorkFilterstring[] nullable

Group the time report by the type of works.

namestring nullable

The name of the time report.

idstring uuid

The id of the time report.

updatedOnstring date-time

The date this time report was updated.

resourceVersioninteger

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.