> ## Documentation Index
> Fetch the complete documentation index at: https://docs.invopop.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Fetch an e-reporting period
> Returns the metadata for one report period, scoped to the party
identified by the silo entry.
Returns the metadata for a single report period, scoped to the party identified by the silo entry. The `status` field tracks the lifecycle: `generated` → `submitted` → `filed` or `rejected`.
The generated XML body is not included — use the `/xml` sub-resource to download it.
## OpenAPI
````yaml GET /apps/gov-fr/v1/reports/{silo_entry_id}/periods/{period_id}
openapi: 3.1.0
info:
contact:
email: dev@invopop.com
name: Invopop Developers
description: >-
Set of end-points for the France app, including lookups against the PPF
Annuaire (French e-invoicing directory).
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
title: France Service API
version: 0.1.0
servers:
- description: production
url: https://api.invopop.com
security:
- InvopopAuth: []
paths:
/apps/gov-fr/v1/reports/{silo_entry_id}/periods/{period_id}:
get:
summary: Fetch a single e-reporting period
description: |-
Returns the metadata for one report period, scoped to the party
identified by the silo entry.
operationId: fetchReportingPeriod
parameters:
- $ref: '#/components/parameters/SiloEntryID'
- $ref: '#/components/parameters/PeriodID'
responses:
'200':
description: The requested report period.
content:
application/json:
schema:
$ref: '#/components/schemas/ReportingPeriod'
examples:
filed:
summary: A filed period
value:
id: 018f9e2a-7c31-7a10-9b44-2f9d1e6c8a01
siren: '123456789'
flux_kind: tx
role: seller
period_start: '2026-06-11'
period_end: '2026-06-20'
sequence: 1
status: filed
flux_code: PPF206_1025_000123
ack_ref: '300'
submitted_at: '2026-06-21T08:15:00Z'
created_at: '2026-06-21T08:00:00Z'
updated_at: '2026-06-21T08:20:00Z'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
components:
parameters:
SiloEntryID:
name: silo_entry_id
in: path
required: true
description: ID of the `org.Party` silo entry being onboarded.
schema:
type: string
example: 5b45453c-cdd0-11ed-afa1-0242ac120002
PeriodID:
name: period_id
in: path
required: true
description: ID of the report period.
schema:
type: string
example: 018f9e2a-7c31-7a10-9b44-2f9d1e6c8a01
schemas:
ReportingPeriod:
type: object
description: |-
One Flux 10 submission window for a `(kind, role)` tuple. Corrective
re-submissions of the same window are separate periods sharing the
window dates but with an incrementing `sequence`.
required:
- id
- siren
- flux_kind
- role
- period_start
- period_end
- sequence
- status
- created_at
- updated_at
properties:
id:
type: string
description: Unique identifier of the period.
example: 018f9e2a-7c31-7a10-9b44-2f9d1e6c8a01
siren:
type: string
description: 9-digit French SIREN of the reporting party.
example: '123456789'
flux_kind:
type: string
description: |-
Report kind:
- `tx` - Transactions (invoice data).
- `py` - Payments.
enum:
- tx
- py
example: tx
role:
type: string
description: |-
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.
enum:
- seller
- buyer
- ''
example: seller
period_start:
type: string
description: First day of the reporting window, as `YYYY-MM-DD`.
example: '2026-06-11'
period_end:
type: string
description: Last day (inclusive) of the reporting window, as `YYYY-MM-DD`.
example: '2026-06-20'
sequence:
type: integer
description: |-
Submission sequence for the window. `1` is the initial report;
higher values are corrective re-submissions.
example: 1
previous_period_id:
type: string
description: >-
ID of the prior sequence for the same window. Omitted for sequence
1.
example: ''
status:
type: string
description: |-
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.
enum:
- generated
- submitted
- filed
- rejected
example: filed
flux_code:
type: string
description: >-
PPF flux filename assigned when the report was submitted. Omitted
before submission.
example: PPF206_1025_000123
ack_ref:
type: string
description: |-
PPF acknowledgement status code once received (`300` filed,
`301` rejected). Omitted while awaiting acknowledgement.
example: '300'
submitted_at:
type: string
format: date-time
description: When the report was submitted to the PPF. Omitted before submission.
example: '2026-06-21T08:15:00Z'
created_at:
type: string
format: date-time
description: When the period was created.
example: '2026-06-21T08:00:00Z'
updated_at:
type: string
format: date-time
description: When the period was last updated.
example: '2026-06-21T08:20:00Z'
Error:
type: object
required:
- error
properties:
error:
type: string
description: Human-readable description of the error.
example: missing siren parameter
responses:
BadRequest:
description: The request is malformed or missing required parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: missing siren parameter
Unauthorized:
description: Missing or invalid authentication token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: missing enrollment
NotFound:
description: The referenced silo entry or party could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: silo entry not found
InternalServerError:
description: An unexpected server-side error occurred.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: internal server error
securitySchemes:
InvopopAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: |-
Authenticate using a valid Invopop enrollment token in the `Bearer`
scheme.
Example: `Authorization: Bearer `
````