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

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
OPOS_CASE
date
required

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

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json