Skip to main content
GET
/
apps
/
gov-fr
/
v1
/
reports
/
{silo_entry_id}
/
periods
/
{period_id}
Fetch a single e-reporting period
curl --request GET \
  --url https://api.invopop.com/apps/gov-fr/v1/reports/{silo_entry_id}/periods/{period_id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}
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.

Authorizations

​
Authorization
string
header
required

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

Example: Authorization: Bearer <token>

Path Parameters

​
silo_entry_id
string
required

ID of the org.Party silo entry being onboarded.

Example:

"5b45453c-cdd0-11ed-afa1-0242ac120002"

​
period_id
string
required

ID of the report period.

Example:

"018f9e2a-7c31-7a10-9b44-2f9d1e6c8a01"

Response

The requested report period.

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.

​
id
string
required

Unique identifier of the period.

Example:

"018f9e2a-7c31-7a10-9b44-2f9d1e6c8a01"

​
siren
string
required

9-digit French SIREN of the reporting party.

Example:

"123456789"

​
flux_kind
enum<string>
required

Report kind:

  • tx - Transactions (invoice data).
  • py - Payments.
Available options:
tx,
py
Example:

"tx"

​
role
enum<string>
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.
Available options:
seller,
buyer,
Example:

"seller"

​
period_start
string
required

First day of the reporting window, as YYYY-MM-DD.

Example:

"2026-06-11"

​
period_end
string
required

Last day (inclusive) of the reporting window, as YYYY-MM-DD.

Example:

"2026-06-20"

​
sequence
integer
required

Submission sequence for the window. 1 is the initial report; higher values are corrective re-submissions.

Example:

1

​
status
enum<string>
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.
Available options:
generated,
submitted,
filed,
rejected
Example:

"filed"

​
created_at
string<date-time>
required

When the period was created.

Example:

"2026-06-21T08:00:00Z"

​
updated_at
string<date-time>
required

When the period was last updated.

Example:

"2026-06-21T08:20:00Z"

​
previous_period_id
string

ID of the prior sequence for the same window. Omitted for sequence 1.

Example:

""

​
flux_code
string

PPF flux filename assigned when the report was submitted. Omitted before submission.

Example:

"PPF206_1025_000123"

​
ack_ref
string

PPF acknowledgement status code once received (300 filed, 301 rejected). Omitted while awaiting acknowledgement.

Example:

"300"

​
submitted_at
string<date-time>

When the report was submitted to the PPF. Omitted before submission.

Example:

"2026-06-21T08:15:00Z"