Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-267057121.5 KB

Fetch a single e-reporting period

Returns the metadata for one report period, scoped to the party identified by the silo entry.

get/apps/gov-fr/v1/reports/{silo_entry_id}/periods/{period_id}

Path parameters

silo_entry_idstring required
Example:5b45453c-cdd0-11ed-afa1-0242ac120002

ID of the org.Party silo entry being onboarded.

period_idstring required
Example:018f9e2a-7c31-7a10-9b44-2f9d1e6c8a01

ID of the report period.

Response

The requested report period.

idstring required

Unique identifier of the period.

sirenstring 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_startstring required

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

period_endstring required

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

sequenceinteger required

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

previous_period_idstring

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_codestring

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

ack_refstring

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

submitted_atstring date-time

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

created_atstring date-time required

When the period was created.

updated_atstring date-time required

When the period was last updated.

Example response

{
  "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"
}