v1

latestOpenAPI 3.1.0Apache 2.02026-07-22160175414.0 KB
Reports

Create a new Report

<Info> This endpoint does not adhere to the "v3 API endpoints" principles. The "fields" query parameter is not supported, but all fields are systematically returned. </Info>

Starts the creation of a a report, based on based on an existing report-template. So you first need to retrieve the report-template unique identifier templateId.

Please see this guide on how to download reports.

post/timmi-timesheet/api/reports

Request body

idinteger

Unique identifier of the report generated

templateIdstring required

Reference to a ReportTemplate to generate a report from.

status'pending' | 'done' | 'error'

Status of a generated report.

namestring

Name given to the generated report.

startsOnstring date

Starting date of the generated report. Default dates of the report-template are applied if left null.

endsOnstring date

Ending date of the generated report. Default of the report-template are applied if left null.

Response

Created

idinteger

Unique identifier of the report generated

templateIdstring required

Reference to a ReportTemplate to generate a report from.

status'pending' | 'done' | 'error'

Status of a generated report.

namestring

Name given to the generated report.

startsOnstring date

Starting date of the generated report. Default dates of the report-template are applied if left null.

endsOnstring date

Ending date of the generated report. Default of the report-template are applied if left null.