---
title: "List e-reporting periods for a party"
method: GET
path: "/apps/gov-fr/v1/reports/{silo_entry_id}/periods"
---

# List e-reporting periods for a party

`GET /apps/gov-fr/v1/reports/{silo_entry_id}/periods`

## Request

- Base URL: `https://api.invopop.com`
- URL: `https://api.invopop.com/apps/gov-fr/v1/reports/{silo_entry_id}/periods`
- Auth: none required
- TypeScript: <https://skmtc.dev/invopop/apis/access-service-api/docs/apps/gov-fr/v1/reports/:silo_entry_id/periods/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the party's Flux 10 report periods, most recent first
(`created_at` descending).

## Path parameters

- `silo_entry_id` string, required

## Query parameters

- `kind` 'tx' | 'py'
- `offset` integer
- `limit` integer

## Response `200`

One page of report periods.

- ListPeriodsResponse: One page of report periods, most recent first.
  - `periods` ReportingPeriod[], required: The report periods on this page.
    - `id` string, required: Unique identifier of the period.
    - `siren` string, required: 9-digit French SIREN of the reporting party.
    - `flux_kind` 'tx' | 'py', required: Report kind: - `tx` - Transactions (invoice data). - `py` - Payments.
    - `role` 'seller' | 'buyer' | '', required: Role the reporting party plays for the transactions in this period. Empty for B2C-only periods. - `seller` - The party is the supplier. - `buyer` - The party is the customer.
    - `period_start` string, required: First day of the reporting window, as `YYYY-MM-DD`.
    - `period_end` string, required: Last day (inclusive) of the reporting window, as `YYYY-MM-DD`.
    - `sequence` integer, required: Submission sequence for the window. `1` is the initial report; higher values are corrective re-submissions.
    - `previous_period_id` string: ID of the prior sequence for the same window. Omitted for sequence 1.
    - `status` 'generated' | 'submitted' | 'filed' | 'rejected', required: Lifecycle status of the period: - `generated` - XML built, not yet sent to the PPF. - `submitted` - Sent to the PPF, awaiting acknowledgement. - `filed` - Accepted by the PPF. - `rejected` - Rejected by the PPF.
    - `flux_code` string: PPF flux filename assigned when the report was submitted. Omitted before submission.
    - `ack_ref` string: PPF acknowledgement status code once received (`300` filed, `301` rejected). Omitted while awaiting acknowledgement.
    - `submitted_at` string, date-time: When the report was submitted to the PPF. Omitted before submission.
    - `created_at` string, date-time, required: When the period was created.
    - `updated_at` string, date-time, required: When the period was last updated.
  - `next_offset` integer: Offset to pass on the next call to fetch the following page. Omitted on the last page.

## Other responses

- `400`: The request is malformed or missing required parameters.
- `401`: Missing or invalid authentication token.
- `404`: The referenced silo entry or its party registration could not be found. The party must be registered before submitting the OTP.
- `500`: An unexpected server-side error occurred.

---

[API](https://skmtc.dev/invopop/apis/access-service-api.md) - [All operations](https://skmtc.dev/invopop/apis/access-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/invopop/apis/access-service-api/revisions/fc954f96ea62?raw)
