Request standard report generation

Creates a pending report entry and publishes a reportRequested event for asynchronous processing.

Query Params
boolean
Defaults to false

Replace an existing report with the same tenant, period (month of end date), and filename

Body Params

Request body to trigger asynchronous standard report generation

string | null

Date field the period filters. Null uses the data area default. DOCUMENT accepts DOCUMENT_DATE and CREATION_DATE.
Must be one of:

DOCUMENT_DATE
CREATION_DATE
BOOKING_DATE
columns
array of objects | null

Optional CSV column selection. Null requests all configured columns; an empty array requests an empty CSV.

columns
string
required

Data area to report on.
Must not be null.
Must be one of:

DOCUMENT
PAYMENT_INTENT
METERED_USAGE
RATED_USAGE
COMBINED_USAGE
CONTRACT
CUSTOMER
OPOS_CASE
SETTLEMENT
string | null

CSV field delimiter. Null uses comma.
Must be one of:

COMMA
SEMICOLON
date
required

Inclusive range end (ISO date).
Must not be null.

string | null

Optional filename prefix used instead of the data-area name. Blank keeps the data-area name. 1-64 letters, digits, or hyphens, and must not start or end with a hyphen.

relationPaths
array of strings or null | null

Optional dot-separated relation paths joined onto dataArea, for example CONTRACT or CONTRACT.CUSTOMER. A nested path requires its parent path. Supported hops: DOCUMENT to CONTRACT, CONTRACT to DOCUMENT, DOCUMENT to PAYMENT_INTENT, CONTRACT to CUSTOMER.

relationPaths
date
required

Inclusive range start (ISO date).
Must not be null.

Headers
int64
required
Responses
202

The request has been accepted for processing, but the processing has not been completed.

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json