businessreports/list

Get a list of all available business reports. This includes both the standard (default) reports as well as all your custom reports.

The result includes some properties that are required to correctly create a report, notably:

Does the report require specifying a date range?
Is there a report parameter and what are the available options?

URL

(GET) /api/businessreports/list

PARAMETERS

None.

RESULTS

The result is a JSON array. Each element represents a report and has these properties:

reportId	The unique ID of the report. The format is: A default report is prefixed "S" such as in S500. A custom report is prefixed with "C" such as in C1002	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: `"options": [ { "v": "", "t": "Filter by project creation or completion date" }, { "v": "CREATED", "t": "Filter by project creation date" }, { "v": "RECEIVED", "t": "Filter by project reception date" }, { "v": "INPROGRESS", "t": "Filter by project start date" }, { "v": "DONE", "t": "Filter by project completion date" } ]` 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:

{
	"reportId": "S107",
	"systemReportId": 107,
	"systemReportTitle": null,
	"customReportId": null,
	"category": "Financial",
	"title": "Client and supplier costs - By language",
	"help": "https://wordbee.atlassian.net/wiki/spaces/WBT/pages/712138/Report+S107+-+Client+and+supplier+costs+-+By+language",
	"description": "Shows client and supplier invoice amounts grouped by source and target language. Perfect to review benefit and loss individually per source and target language.",
	"categoryid": 1,
	"pin": false,
	"needDateSelector": true,
	"options": [
		{
			"v": "",
			"t": "Filter by project creation or completion date"
		},
		{
			"v": "CREATED",
			"t": "Filter by project creation date"
		},
		{
			"v": "RECEIVED",
			"t": "Filter by project reception date"
		},
		{
			"v": "INPROGRESS",
			"t": "Filter by project start date"
		},
		{
			"v": "DONE",
			"t": "Filter by project completion date"
		},
		{
			"v": "ONEINV",
			"t": "All projects with an invoice date in interval"
		}
	],
	"color": null,
	"deprecated": false,
	"canClone": true
}