---
title: tm.report
slug: db/tmreport
createdAt: 2023-12-14T14:12:25.531Z
---

List of defined reports

## Fields

| FIELD                   | TYPE                               | DESCRIPTION                                                                                                                |
| ----------------------- | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| id                      | `int`                              | Unique ID                                                                                                                  |
| name                    | `mlstring`                         | Name of the report                                                                                                         |
| description             | `mlstring`                         | Description of the report                                                                                                  |
| reporttypeid            | `int`                              | The report type defines the UI and parameters that are used when generating the report                                     |
| defaultformat           | `string`                           | Reports can be generated as pdf or excel file. This field defines the default format. Possible values are 'pdf' or 'excel' |
| content                 | `**map[k:string t:map v:string]**` | The actual report definition, see [reports](docId:8UtaNGInLcJpbEqb5fMYg) for more information.                             |
| subtitles               | `[string]`                         | A list of subtitles for the report                                                                                         |
| options                 | `ReportOptions`                    | Key-value array of options. Can contain: pdfpagesize, excelpagewidth, excelscaling, usesystemfont                          |
| translations            | `map[k:string t:map v:string]`     | A map of language codes to [gettext .po files](http://en.wikipedia.org/wiki/Gettext).                                      |
| emailschedule           | `bool`                             | Indicates if this report is scheduled to be sent by mail at a certain interval                                             |
| emailschedulehourofday  | `int`                              | Hour of the day the report will be sent                                                                                    |
| emailscheduledayofweek  | `int`                              | Day of the week the report will be sent. 1 = monday -> 7 = sunday                                                          |
| emailscheduledayofmonth | `int`                              | Day of the month the report will be sent.                                                                                  |
| emailschedulequery      | `string`                           | Report will only be sent if the given query returns at least one result.                                                   |
| emailrecipients         | `string`                           | List of email recipients that should receive the report, separated by ;                                                    |
| emailcc                 | `string`                           | List of email recipients that should receive the report in cc, separated by ;                                              |
| emailbcc                | `string`                           | List of email recipients that should receive the report in bcc, separated by ;                                             |
| usagetypeid             | `int`                              | Indicates where the report is being used. Possible values: 17001 (Sales), 17002 (External sales), 17003 (Hidden)           |
| createdts               | `timestamp`                        | Created timestamp                                                                                                          |
| lastupdatets            | `timestamp`                        | Last updated timestamp                                                                                                     |