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 is required for lucid_de; systemOperatorId is too, unless your workspace stores one (then it is the default). Both are unused by the worksheet registers, which always produce the annual report.

periodYear
integer
required

Calendar year to report (2000–2100).

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

ISO alpha-2 (case-insensitive).

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

The register: lucid_de (Germany, LUCID XML) or one of the worksheet registers (verpact_nl, ara_at, bdo_pl, miteco_es, conai_it). market must match the register.

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

lucid_de only: the LUCID report type (HPM1 plan, HMM1 intra-year, HJM1 year-end, HNM1 supplementary, HAM1 deduction). Worksheet registers always report ANNUAL.

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). For lucid_de, omit it to use the SystemOperatorID stored in your workspace; a value sent here wins. Without either, lucid_de answers 400. Unused by the worksheet registers.

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

Response

Report generated and frozen

id
string<uuid>
required

UUID of the new report — what GET /api/v1/ppwr/mengenmeldung/{reportId}/xml takes.

version
integer
required

Version of the report within its (periodYear, market, format) scope; each regeneration increments it.

systemOperatorId
string

lucid_de only: the LUCID SystemOperatorID the report was generated with — the one you sent, or your workspace's stored one when you omitted it. Absent for the worksheet registers.