submit_payment_report
Submit payment reports to DGFiP for international B2B or B2C transactions. Builds conformant FRR XML payloads for Approved Platform submission.
Instructions
Submit a DGFiP Flux 10.2 / 10.4 payment e-reporting flow.
Scope: Compatible Solution (CS) mode, no payload validation. See README "Scope" section.
Builds a FRR XML payload conforming to DGFiP Spécifications Externes v3.2 (payment.xsd / ereporting.xsd) and submits it to the Approved Platform via POST /v1/flows with flowSyntax="FRR".
Use for:
International B2B payment reporting (processing_rule=B2BInt, flow_type=UnitaryCustomerPaymentReport)
B2C individual payment reporting (processing_rule=B2C, flow_type=UnitaryCustomerPaymentReport)
Aggregated B2C payment reporting (processing_rule=B2C, flow_type=AggregatedCustomerPaymentReport)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| flow_type | Yes | XP Z12-013 FlowType for this payment report: UnitaryCustomerPaymentReport — Flux 10.2 unit payment AggregatedCustomerPaymentReport — Flux 10.4 aggregated B2C payment | |
| issuer_id | Yes | TT-13: SIREN or SIRET of the French declarant. | |
| sender_id | Yes | TT-8: Identifier of the CS/PDP platform submitting the report. | |
| type_code | Yes | TT-4: Transmission type code, e.g. '380'. | |
| period_end | Yes | TT-90: Report period end date (ISO 8601, e.g. '2025-01-31'). | |
| issuer_name | Yes | TT-14: Legal name of the declarant. | |
| sender_name | Yes | TT-9: Legal name of the sender platform. | |
| tracking_id | No | Optional external tracking identifier for this flow. | |
| period_start | Yes | TT-89: Report period start date (ISO 8601, e.g. '2025-01-01'). | |
| invoices_json | Yes | JSON array of payment records. Each invoice in the `invoices` JSON list must have: Required fields: invoice_id TT-91 Invoice number (reference to the original invoice) issue_date TT-102 Invoice issue date (ISO 8601) payment_date TT-92 Payment date (ISO 8601) subtotals TT-93..95 List of payment breakdown objects subtotals list entries: tax_percent TT-93 VAT rate (decimal, e.g. "20.0") amount TT-95 Collected amount at this rate (decimal string) currency_code TT-94 (optional) Currency code (e.g. "EUR") | |
| issue_datetime | Yes | TT-3: Transmission creation timestamp, e.g. '20250115T120000+0100'. | |
| processing_rule | Yes | B2BInt for international B2B payments, B2C for B2C payments. | |
| transmission_id | Yes | TT-1: Unique identifier for this transmission (generated by sender). | |
| issuer_id_scheme | Yes | TT-12: ID scheme for issuer: 'SIREN' or 'SIRET'. | |
| issuer_role_code | Yes | TT-15: Issuer role: 'MOA' or 'OD'. | |
| sender_id_scheme | Yes | TT-7: ID scheme for sender, e.g. 'SIREN', 'SIRET'. | |
| sender_role_code | Yes | TT-10: Sender role code: 'CS', 'PDP', 'OD', or 'MOA'. | |
| transmission_name | No | TT-2: Optional human-readable name for the transmission. | |
| confirmation_token | No | Confirmation token returned by a prior pending response. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||