API v1 ReferenceTime Reports

Returns all time reports of a user.

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

Required Permissions
Any authenticated user.

Headers

AuthorizationstringRequired

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

Response

OK

namestring or nullOptional

The name of the time report.

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

startOndatetime or nullOptional

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

endOndatetime or nullOptional

The end date time of the time report. when DateMode is “customRange”.

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

projectIdUUID or nullOptional

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

companyIdUUID or nullOptional

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.

availableColumnslist of stringsOptional

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

billingStatuseslist of stringsOptional

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

notestring or nullOptional

Filter time entries by note.

usersFilterlist of UUIDsOptional

Filter time entries by users.

projectsFilterlist of UUIDsOptional

Filter time entries by projects.

noProjectFilterboolean or nullOptional

Filter to show also time entries without a project.

projectCompaniesFilterlist of UUIDsOptional

Filter time entries by projects of the companies.

projectTypesFilterlist of UUIDsOptional

Filter time entries by projects of the type.

projectStatusesNameFilterlist of stringsOptional

Filter time entries by projects with status name.

projectStatusTypesFilterlist of stringsOptional

Filter time entries by projects with status of type.

projectTeamsFilterlist of UUIDsOptional

List of teams, to the filter the projects for.

userTeamsFilterlist of UUIDsOptional

Filter for the teams to filter the users.

taskTagsModelFilterlist of objectsOptional

Filter time entries by the tags of the task.

projectTagsModelFilterlist of objectsOptional

Filter time entries by the tags of the project.

userTagsModelFilterlist of objectsOptional

Filter time entries by the tags of the users.

typesOfWorkFilterlist of UUIDsOptional

Group the time report by the type of works.

idUUIDOptional

The id of the time report.

userobjectOptional
updatedOndatetimeOptional

The date this time report was updated.

resourceVersionlongOptional

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