Skip to main content
GET
List e-reporting periods for a party
Each period is one submission window for a (kind, role) tuple; a report generated again for the same window, for example after a PPF rejection, appears as a separate period with an incrementing sequence. Filter by report kind with kind. Paginate with offset and limit (default 50, maximum 200). When more results remain, the response carries a next_offset to pass on the next call; it is omitted on the last page.

Authorizations

Authorization
string
header
required

Authenticate using a valid Invopop enrollment token in the Bearer scheme.

Example: Authorization: Bearer <token>

Path Parameters

siren
string
required

SIREN of the reporting party. The party's org.Party silo entry ID is still accepted in its place, but will be phased out.

Example:

"123456789"

Query Parameters

kind
enum<string>

Restrict the results to a single report kind:

  • tx - Transactions (invoice data).
  • py - Payments.

Omit to return both kinds.

Available options:
tx,
py
Example:

"tx"

offset
integer
default:0

Number of results to skip, for pagination. Must be non-negative.

Required range: x >= 0
Example:

0

limit
integer
default:50

Maximum number of results to return. Values outside the 1–200 range fall back to the default of 50.

Required range: 1 <= x <= 200
Example:

50

Response

One page of report periods.

One page of report periods, most recent first.

periods
object[]
required

The report periods on this page.

next_offset
integer

Offset to pass on the next call to fetch the following page. Omitted on the last page.

Example:

50