Skip to main content
POST
Generate Volume Report

Authorizations

Authorization
string
header
required

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Body

application/json

Trigger a report generation. reportType and systemOperatorId are required for lucid_de and unused by the worksheet registers, which always produce the annual report.

periodYear
integer
required
Required range: 2000 <= x <= 2100
market
string
required

ISO alpha-2 (case-insensitive).

Pattern: ^[A-Za-z]{2}$
format
enum<string>
required

Register format. Each accepts exactly one market: lucid_deDE, verpact_nlNL, ara_atAT, bdo_plPL, miteco_esES, conai_itIT.

Available options:
lucid_de,
verpact_nl,
ara_at,
bdo_pl,
miteco_es,
conai_it
reportType
enum<string>

The LUCID Meldungsart: HPM1 Planmengenmeldung, HMM1 unterjährige Mengenmeldung, HJM1 Jahresabschlussmengenmeldung, HNM1 Ergänzungsmengenmeldung, HAM1 Abzugsmengenmeldung.

Available options:
HPM1,
HMM1,
HJM1,
HNM1,
HAM1
systemOperatorId
string

Your dual system's LUCID number: two letters + 13 digits (lower case is accepted and upper-cased). Required for lucid_de, unused by the worksheet registers.

Pattern: ^[A-Za-z]{2}[0-9]{13}$

Response

Report generated and frozen

id
string<uuid>
required
version
integer
required