...
reportId | The unique ID of the report. The format is:
| string | ||
title | The report title. | string | ||
description | Optional description of report. | string | ||
pin | Indicates if this report is pinned by the user and moved to the top of the list. In the UI such reports are indicated with an orange star icon. | bool | ||
categoryId | The numeric report category. Also see businessreports/categories | int | ||
category | The report category title. Also see businessreports/categories | string | ||
color | Optional. HTML color code assigned to the report. Can be specified when creating/editing a custom report. | string? | ||
help | A URL to the online documentation describing customization. | string | ||
USED FOR REPORT CREATION | ||||
needDateSelector | Specifies if a from/to date range must be supplied when creating this report. Most reports expect a date range but some do not. | bool | ||
options | Some reports when created allow to specify an option to choose a variant. This property is then the list of available options. For example, the "Client and supplier costs" report proposes these options:
When you create this report you can optionally pass the value in the "v" property. The first element is the default value. | object[] | ||
canClone | Specifies if it is possible to create a custom report based on this default report. Deprecated or older reports may not be "clonable". | bool | ||
OTHER | ||||
deprecated | Some reports should no longer be used and are flagged as deprecated (also in the Wordbee Translator user interface). | bool | ||
systemReportId | With custom reports only. Indicates the standard report from which this custom report is derived. Note that this number omits the "S" prefix. | int? | ||
customReportId | With custom reports only. The ID without the "C" prefix. | int? |
EXAMPLE
A report with options:
...