Updates a time report.

PUT

Updates the time report of the specified id.

Required Permissions: Any authenticated user.

Path parameters

timeReportIdstringRequired

The id of the time report.

Request

This endpoint expects an object.
namestringOptional

The name of the time report.

sharedbooleanOptionalDefaults to false

Whether the time report is shared.

dateModestringOptional

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

startOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

endOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

filterstringOptional

The generated filter query of the time report.

chartTypestringOptional

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

projectIdstringOptional

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

companyIdstringOptional

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

sumBystringOptional

Summarises the values by the sum of this property.

sortBystringOptional

Sorts the values by this property.

sortByOrderstringOptional

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

roundBystringOptional

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

groupBystringOptional

Group the values by property.

sortColumnstringOptional

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

notestringOptional

Filter time entries by note.

usersFilterlist of stringsOptional

Filter time entries by users.

projectsFilterlist of stringsOptional

Filter time entries by projects.

noProjectFilterbooleanOptionalDefaults to false

Filter to show also time entries without a project.

projectCompaniesFilterlist of stringsOptional

Filter time entries by projects of the companies.

projectTypesFilterlist of stringsOptional

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 stringsOptional

List of teams, to the filter the projects for.

userTeamsFilterlist of stringsOptional

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 stringsOptional

Group the time report by the type of works.

Response

OK

namestringOptional

The name of the time report.

sharedbooleanOptionalDefaults to false

Whether the time report is shared.

dateModestringOptional

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

startOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

endOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

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

filterstringOptional

The generated filter query of the time report.

chartTypestringOptional

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

projectIdstringOptional

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

companyIdstringOptional

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

sumBystringOptional

Summarises the values by the sum of this property.

sortBystringOptional

Sorts the values by this property.

sortByOrderstringOptional

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

roundBystringOptional

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

groupBystringOptional

Group the values by property.

sortColumnstringOptional

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

notestringOptional

Filter time entries by note.

usersFilterlist of stringsOptional

Filter time entries by users.

projectsFilterlist of stringsOptional

Filter time entries by projects.

noProjectFilterbooleanOptionalDefaults to false

Filter to show also time entries without a project.

projectCompaniesFilterlist of stringsOptional

Filter time entries by projects of the companies.

projectTypesFilterlist of stringsOptional

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 stringsOptional

List of teams, to the filter the projects for.

userTeamsFilterlist of stringsOptional

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 stringsOptional

Group the time report by the type of works.

idstringOptional

The id of the time report.

userobjectOptional
updatedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this time report was updated.

resourceVersionlongOptionalDefaults to 0

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