The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:57 UTC.
API reference
/
Models
ListResultDtoOfReportCatalogItemDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description items
required array of ReportCatalogItemDto
array of ReportCatalogItemDto nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of each ReportCatalogItemDto:
Field
Type
Description reportId
required string
The report id, for example `transactions.report.Summary`. Stable: an id is never renamed
or reused.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
displayName
required string
The report's display name.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
description
required string
What the report shows, when the report describes itself.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
module
required string
The area of the platform the report belongs to, for example `Transactions`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
exportFormats
required array of ReportFileFormat
array of ReportFileFormat The file formats the report can be exported in.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
CsvComma-separated values, text/csv. XlsxAn Excel workbook, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.
supportsMerchantFilter
required boolean
Whether a run can be narrowed to a single merchant with `merchantId`. A run of a report
that cannot be narrowed is refused when it names a merchant.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
This model has no documented fields.
Next steps