Guide to integrating the B2Brouter API and complying with the French RFE from your own system.
From September 2026, all French companies must route their invoices and TVA data through a certified platform. B2Brouter simplifies this: you send your invoice data via a REST API call, and B2Brouter handles PPF registration, document generation (UBL/CII/Factur-X), routing to your clients, and tax reporting to the DGFiP — all through a single integration.
B2Brouter is a certified Plateforme Agréée (PA) for the French DGFiP e-invoicing reform. Connect via REST API and B2Brouter handles the entire compliance stack on your behalf:
What B2Brouter does for you
Details
PPF registration
Publishes your SIREN/SIRET to the Annuaire automatically on activation
Flux 1: B2B e-invoicing
Generates UBL/CII/Factur-X, transmits to PPF, routes to receiver’s platform
Flux 6: Invoice lifecycle
Manages CDAR status messages (Déposée, Reçue, Approuvée, Refusée, Encaissée)
Flux 10: e-Reporting
Aggregates B2C and cross-border B2B transactions (intra-EU and extra-EU) into Ledgers sent to the PPF at the frequency set by your Tax Report Setting’s vat_regime
Peppol 0225 reception
Receives invoices from any French or Peppol-connected platform
Document generation
You send invoice data as JSON — B2Brouter generates the compliant UBL/CII/Factur-X document and transmits it to the PPF. No XML generation required on your side
All transmitted documents (invoices, tax reports, CDAR messages) are stored by B2Brouter for the legally required 10-year retention period. No additional storage setup required on your side
Regulatory context: The French e-invoicing reform mandates that all French companies use a certified Plateforme Agréée (PA) or the government’s PPF (Portail Public de Facturation) to transmit invoices and report TVA data to the DGFiP, starting September 2026. As a certified PA, B2Brouter handles the PPF connection entirely on your behalf — no SFTP, no electronic certificates, no direct PPF integration required.
There are two main use cases for integrating with B2Brouter for France e-invoicing:
eDocExchange — For companies or groups of companies that integrate their management software (ERP, accounting platform) directly with B2Brouter. The onboarding process (account creation, Tax Report Settings configuration) is typically performed once per company through the web UI. Day-to-day operations (issuing invoices, tracking their lifecycle) happen through the API. To add further company accounts to your integration group, follow the same onboarding wizard from the same B2Brouter user account — no separate API call required.
eDocSync — For software vendors and ERP providers who want to offer DGFiP compliance to their own customers from within their product. This is B2Brouter’s white-label / embedded / marque blanche model: B2Brouter operates entirely in the background, end customers interact exclusively with the vendor’s interface and are unaware of B2Brouter. The software vendor is responsible for account provisioning, invoice submission, and lifecycle tracking via the B2Brouter API. End customers do not need a B2Brouter login or subscription.
For eDocSync, account provisioning volume determines the right plan:
Few companies (reseller model): Add each client company as an account in your B2Brouter integration group via the web UI, following the standard onboarding wizard. This works well for tens of companies and shares a single API key.
100+ companies: Contact our Sales team or open a Support Ticket to discuss a dedicated eDocSync plan with bulk provisioning (volume-based pricing for editors).
In both cases, all France-specific compliance features (Annuaire registration, Flux 1/6/10 transmission, CDAR lifecycle) work identically.
B2Brouter is itself a Plateforme Agréée: you integrate with B2Brouter — it is not a relay or connector to another PA. If your SIREN is currently registered with a different PA, activating the Tax Report Setting on the SIREN account fails: you need a migration code (see Change PA). To bring in only one establishment while keeping that existing registration, see Scenario 2 in Account structure. You cannot use B2Brouter as a pass-through to submit invoices under a different PA’s certification.
Routing to recipients on other PAs: When your receiver is registered with a different PA, B2Brouter routes the invoice via the standard Peppol four-corner model (C2 → C3): B2Brouter’s Peppol access point (C2) looks up the recipient’s Peppol address in the Annuaire and delivers the document to the buyer’s access point (C3) — regardless of which PA they use. No additional configuration is required on your side.
Testing environments: Use sandbox for initial API testing and payload validation — DGFiP submissions are simulated in sandbox, no fictitious SIRET required. For full end-to-end testing with the DGFiP QAS (qualification) environment, use B2Brouter’s staging environment as described below.
Do not mix environments. Production uses real SIREN/SIRET numbers and connects to the DGFiP production Annuaire. Staging uses fictitious test identifiers and connects to the DGFiP QAS (qualification) environment. API keys, accounts, and contacts are not shared between environments.
Register at app.b2brouter.net to start a production integration. When you activate the DGFiP Tax Report Setting, your company’s SIREN/SIRET is published to the real PPF Annuaire, making it discoverable by any platform in the French e-invoicing ecosystem.
This option is designed for real B2B invoices starting September 2026. In the meantime, the DGFiP will clear QAS-period records before the reform goes live — so any invoices you send during your pilot will not create compliance obligations. This is the right starting point if you have already chosen B2Brouter and want to test the full integration with your actual company data.
Register at app-staging.b2brouter.net to use B2Brouter’s test environment, which is connected to the DGFiP’s QAS (qualification) environment.
This is the best option if:
You are evaluating multiple platforms before committing
Your SIREN/SIRET is already published in the Annuaire with another PA and you don’t want to change PA yet
You prefer not to associate your company identifier with test activity
The staging environment is self-provisioned: once you have test identifiers (see below), you can start end-to-end testing in under 24 hours.
Staging SIRET validation: In the staging environment, any valid 14-digit number is accepted as a SIRET without checksum validation. The fictitious identifiers from the Chorus Pro QAS CSV are pre-registered in the DGFiP QAS annuaire and work end-to-end. In production, SIRET format and checksum are validated.
Important: The DGFiP does not allow real SIREN or SIRET numbers in their QAS environment. You must use fictitious test identifiers. You can obtain these yourself via the Chorus Pro QAS portal (free, 5-minute process) or request a pre-assigned set by opening a Support Ticket in the staging app.
One account per SIREN: B2Brouter creates one account per SIREN (the TVA number key is derived from the SIREN). If you provide a SIRET, the SIREN is extracted from it. Two different SIRETs from the same company (same SIREN) will resolve to the same account. If your company operates from multiple establishments (different SIRETs), these are modelled as organisational units within the same B2Brouter account — not as separate accounts. Contact Support if you need to configure multi-establishment invoicing. Keep this in mind when selecting rows from the CSV: pick SIRETs with distinct SIRENs (first 9 digits) for each independent company you need to test.
The Chorus Pro QAS portal lets you generate a “Matelas de données” (data set) — a CSV file containing fictitious SIREN/SIRET identifiers pre-registered in the DGFiP test environment. Follow these steps:
You can use a temporary email address (e.g. temp-mail.io).
Use any name; this account is purely for obtaining test identifiers.
Check your inbox for the “Initialisation de mot de passe Chorus Pro” email and set your password (link valid 60 minutes).
Log in → go to Domaines → Matelas de données → click Générer un matelas de données and confirm.
Go to Consultation du matelas de données. Wait until both statuses show “Disponible”:
Statut pour Chorus Pro: Disponible
Statut pour l’annuaire de facturation PPF: Disponible
Generation typically takes a few minutes. Refresh the page to check.
Click “Générer et télécharger le fichier CSV du matelas structures et utilisateurs” to download your test identifiers.
The CSV contains multiple fictitious SIREN/SIRET numbers in rows labelled “Privé” and “Public”. Use only rows from the “Privé” (private sector) section for your test accounts. Public sector entities (SIREN 'Public') are rejected by the DGFiP QAS annuaire — attempting to activate e-Reporting on a public-sector account returns HTTP 422 (“La création d’une ligne annuaire n’est pas possible pour une entité associée à un SIREN ‘Public’”). This is correct behaviour: public entities use Chorus Pro directly, not a PA.
Use one private-sector SIREN for your emitter account and another for your test contact.
⚠️ Your company’s Annuaire registration is not immediate: publication goes out with the nightly batch and is live the next morning, both in staging and in production. This is how the DGFiP infrastructure works, not a B2Brouter delay. Until then you will not be able to send invoices.
The following day: create a test contact using a second SIREN from the CSV (see Create a contact).
Authentication uses a static API key passed in the X-B2B-API-Key HTTP header. There is no OAuth2 flow — generate your API key in the B2Brouter UI under Settings → API Keys. Keep it confidential and never include it in client-side code. Also set X-B2B-API-Version in every request.
Base URL: All examples below use https://api-staging.b2brouter.net. For production, replace with https://api.b2brouter.net.
Account structure: Parent and organisational units
In France, every company has a 9-digit SIREN identifying it as a legal entity, and every establishment or service has a 14-digit SIRET derived from that SIREN. B2Brouter follows the same hierarchy, with a parent account and, under it, an organisational unit (UO) for each establishment or service. Invoices are issued from the parent account or from a specific UO, depending on the issuing establishment.
The parent account is always a SIREN. Any SIRET, Code Routage or Suffix (see Identifiers and schemes) is always modelled as a UO under that parent, never as an independent account: this is what keeps the published identifiers of the parent and its UOs consistent.
If you create an account with a SIRET, B2Brouter does not reject it: it derives the SIREN from the first 9 digits, creates the parent account if it does not exist yet, and attaches the SIRET as a UO. What the call returns is the UO. Converting an existing parent to a SIRET with a PUT does return 422 parameter_matriu_must_be_siren.
Every UO has its own Tax Report Setting. A UO never reports through the parent account: if it does not have its own Tax Report Setting enabled, it does not report. That said, when you create a UO under a parent that already has DGFiP active, B2Brouter clones an own Tax Report Setting for it so that it starts reporting with no extra steps. If you don’t want it to report, disable it (enabled: false) once created. See Scenarios and cases to pick your configuration.
The golden rule applies to contacts too. French contacts (clients and suppliers) follow the same hierarchy and the same cin_scheme values: the contact parent is always the SIREN, and any SIRET, Code Routage or Suffix is a UO. The system technically allows a contact parent with an identifier other than the SIREN, but doing so breaks the UOs you later add for the same client. To create them, see Create a contact.
In B2Brouter, French accounts, organisational units and contacts are defined by a principal identifier (cin_scheme + cin_value). SIRET UOs with several internal services add a sub-identifier (routing_codes.cin1_scheme + routing_codes.cin1_value) to address a specific service. These are two different things: the Suffix is a principal cin_scheme, whereas the Code Routage always goes in the sub-identifier and never as a principal cin_scheme.
Account, UO or contact principal identifier (cin_scheme + cin_value):
cin_scheme
cin_value
Meaning
Example
0002 (2)
SIREN, 9 digits + Luhn
Legal entity
123456789
0009 (9)
SIRET, 14 digits (SIREN + 5 digits) + Luhn
Establishment
12345678900012
8040
Suffix, alphanumeric [A-Za-z0-9_\-\/]+
UO without its own SIRET
SUF01, ADMIN
Sub-identifier or routing code (routing_codes.cin1_scheme + routing_codes.cin1_value):
On the Peppol network, by contrast, the French participant is always identified by scheme 0225 (FRCTC Electronic Address), the code reserved for French electronic addresses. Its value is always a composition published at the Annuaire, never a bare identifier: a SIRET without the SIREN in front is not publishable. Schemes 0224 and 8040 are not Peppol schemes: they only serve to build that value.
B2Brouter covers three configuration scenarios. Which one applies depends on what you want to do from B2Brouter. If you don’t know whether your SIREN is already registered with another PA, check it at the Annuaire with the Directory lookup.
Do you want the SIREN to report from B2Brouter?
Answer
Scenario
What to do
Yes
Scenario 1. The whole company reports
Activate the Tax Report Setting on the SIREN parent account. Establishments, services and internal units are modelled with Cases 1, 2 and 3. If the SIREN is already registered with another PA, you must first migrate it to B2Brouter with a migration code (see Migrating from another PA or to another one).
No, I want one specific establishment to report from B2Brouter
Scenario 2. Only one establishment reports
Create the establishment as a UO with the SIRET and activate the Tax Report Setting on that UO only, not on the SIREN parent account. The SIREN’s registration with the other PA is left untouched. Cases 4 and 5.
No, I only want to issue from B2Brouter
Scenario 3. Issue from B2Brouter, receive at your PA
⚠️ Only available on a Suffix UO: create it under the SIREN and activate its Tax Report Setting with issue_only: true. Reception stays with the other PA. Case 6, see Tax Report Setting modes.
You have establishments and they all report from the company.
2. Service Scenario 1
SIRET + Code Routage
Parent:ON UO:ON1
SIREN_SIRET_<CR>
You want to address a specific department inside an establishment.
3. Suffix Scenario 1
Suffix
Parent:ON UO:ON1
SIREN_<SUFFIX>
You have a unit without its own SIRET that must receive and report at its own address.
4. Établissement-only Scenario 2
SIRET
Parent:OFF UO:ON
SIREN_SIRET
The SIREN is already registered with another PA and you are only bringing one establishment to B2Brouter.
5. Établissement-only + Service Scenario 2
SIRET + Code Routage
Parent:OFF UO:ON
SIREN_SIRET_<CR>
Like Case 4, but addressing a department inside that establishment.
6. Issue-only Scenario 3
Suffix with issue_only2
Parent:OFF UO:ON
SIREN_<SUFFIX>
You want to issue from B2Brouter while keeping reception at your current PA.
1 When you create a UO under a parent that already has DGFiP active, B2Brouter clones an own Tax Report Setting for it. See The golden rule.
2 A Suffix UO publishes a 0225 transport and receives invoices like any other address (Case 3). What removes reception is the issue_only flag on its Tax Report Setting, which is only accepted on a Suffix UO (see Tax Report Setting modes).
This section explains how to create the parent account with the SIREN and how to add organisational units to it. The model behind it is in Account structure.
If your company structure requires UOs (see the case table), create each UO with POST /accounts adding parent_id (the id of the parent account you created earlier).
If the parent account already has the DGFiP Tax Report Setting active, the new UO receives its own copy and starts reporting straight away. If you don’t want it to report, disable its Tax Report Setting (enabled: false) once created (see The golden rule).
Attaches the UO to the SIREN parent: this is what makes it a UO
cin_scheme and cin_value
Depending on the UO type
The UO’s own identifier; see Creation fields and Annuaire result. A SIRET always starts with the 9 digits of the parent SIREN, by INSEE definition: if the parent is 123456789, valid SIRETs take the form 123456789XXXXX
country
"fr"
Enables FR validation and routing
email, address, city, postalcode, province
The UO’s contact details and address
Required on any account, UOs included
Without these fields, creation returns HTTP 422 ("Region/Province/Country can't be blank").
Cases 4, 5 and 6: the payload does not distinguish them from their equivalents. What changes is where the Tax Report Setting is activated and, in Case 6, the issue_only flag. See Scenarios and cases.
Cases 1 and 2: Établissement UO with optional Service
The payload for Case 6 (Issue-only) is identical to Case 3: what separates them is not the POST /accounts but the Tax Report Setting you activate afterwards, with issue_only: true. That flag is only accepted on a UO with cin_scheme="8040". See Tax Report Setting modes.
This is the key onboarding step. When you create a Tax Report Setting with code: "dgfip", B2Brouter automatically:
Registers your company in the PPF’s Annuaire: your identifier becomes discoverable by any platform in the French e-invoicing ecosystem.
Creates a Peppol 0225 (FRCTC Electronic Address) transport: your company is enabled to receive electronic invoices from any Peppol-connected platform in France.
⚠️ If the account you activate on already has a Peppol transport, it will be replaced by the new 0225 transport during activation.
Identifier already registered with another PA:
If the SIREN you activate on was previously registered with another PA, B2Brouter will close the existing Annuaire entry and open a new one. If you need to keep that existing registration, do not activate on the SIREN; activate on a SIRET UO instead (see “Where to activate” below). Update any existing integration that references the old transport identifier.
Where to activate the Tax Report Setting: {ACCOUNT_ID} can be the SIREN parent, a SIRET UO, or both. Every account (parent or UO) that has its own Tax Report Setting is published in the Annuaire under its own address. For accounts in the French TVA territory (FR, and the DROM GP/MQ/RE) there is no inheritance between UO and parent (see The golden rule): without its own Tax Report Setting the UO does not report, and with an own Tax Report Setting disabled it doesn’t either. Three configurations:
Tax Report Setting on the SIREN only: the company is published as SIREN (standard case, Scenario 1). New UOs under this parent automatically receive their own cloned Tax Report Setting on creation (see the note below), so they normally report too.
Tax Report Setting on the SIREN and on one or more SIRET UOs: the company is published both as SIREN and as each SIREN_SIRET (one Annuaire address per activated account). All active DGFiP Tax Report Settings under the same SIREN must share the same vat_regime: activating one with a different value returns 422 dgfip_vat_regime_taken_per_siren.
Tax Report Setting on a SIRET UO only, not on the SIREN: only that establishment is published (SIREN_SIRET); the SIREN itself is not (Scenario 2). Use this when the SIREN is already registered with another PA and you want to keep that registration.
If you create a UO while the parent is already active: B2Brouter automatically creates its own DGFiP Tax Report Setting (with start_date tomorrow), so it starts reporting with no extra steps. If the parent doesn’t have DGFiP active at that moment, the UO is created without any Tax Report Setting; once you activate the parent later, the UO gets its own. The UO never looks at the parent’s setting to decide whether to report.
The start_date determines when tax reporting begins. From that date, invoices you issue will generate tax reports and be transmitted to the PPF.
When tax reporting begins. Must be today or a future date. Defaults to tomorrow if omitted.
type_operation
string
Yes
Default operation type for this company: "services", "goods", or "mixed". Determines the DGFiP process code (S1/B1 etc.) used in tax reports. Choose "mixed" if your company sells both goods and services. On a mixed invoice, the Flux 1 tax report is emitted under the services process code (S1/S2/S4/S7) and reports only the service breakdowns; the DGFiP has no dedicated “M” cadre for Flux 1 (see Process codes). This setting can be updated after activation.
naf_code
string
Yes
The company’s NAF/APE code (Nomenclature d’Activités Française). This is the 2-digit section code assigned by INSEE that identifies the company’s main economic activity (e.g. "62" for IT and software services, "47" for retail, "86" for health). The DGFiP uses this code for tax reporting classification. You can find your NAF code on your company’s Kbis extract or on sirene.fr.
enterprise_size
string
Yes
The company’s size category as defined by INSEE. Allowed values: "micro" (Microentreprise — < 10 employees, CA ≤ 2 M€), "pme" (PME — 10 to 249 employees, CA ≤ 50 M€), "eti" (ETI — 250 to 4 999 employees, CA ≤ 1.5 Md€), or "ge" (Grande Entreprise — 5 000+ employees or CA > 1.5 Md€).
vat_regime
string
Yes, unless annuaire_only=true
The company’s TVA regime. Determines the Flux 10 (e-Reporting) transmission frequency. Without a valid vat_regime, no declarable invoices can be transmitted: the request returns HTTP 422. See the regime table.
reason_vat_exempt
string
No
Default TVA exemption reason code for this company. Defaults to "VATEX-FR-FRANCHISE" (franchise en base de TVA). Set this if your company operates under a specific TVA exemption regime. See TVA-exempt lines and Franchise en base de TVA for the full list of accepted codes.
email
string
No
Contact email for tax-related notifications.
auto_generate
boolean
No
Always true for DGFiP (legal obligation). Cannot be changed.
auto_send
boolean
No
Automatically transmit tax reports to the PPF. Defaults to true.
enabled
boolean
No
Whether the setting is active. Defaults to true. Annuaire registration only occurs when true.
annuaire_only
boolean
No
When true, the account is only registered with the Annuaire of the PPF for reception. No Flux 1 tax reports are generated and no CDAR messages are sent; enterprise_size and naf_code become optional. Defaults to false. See Tax Report Setting modes.
Transactions every ten days (days 1-10, 11-20, 21-end of month); payments monthly.
reel_normal_trimestriel
Monthly.
simplifie
Monthly. Submission deadline: the 26th of the following month. Regime abolished on 2027-01-01; treated as reel_normal_trimestriel afterwards.
franchise_en_base
Bimonthly (calendar bimonths: Jan-Feb, Mar-Apr, May-Jun, Jul-Aug, Sep-Oct, Nov-Dec). Submission deadline: the 26th of the following month.
If the Annuaire registration fails (invalid SIREN/SIRET, or a temporary DGFiP service outage), the Tax Report Setting creation is rolled back and an error is returned. Correct the issue and retry.
If you followed the steps above, you already have the full mode and don’t need to read the rest of this section. The other two modes are deviations for specific situations.
When you need it: your company is not required to issue yet, but you want to be listed at the Annuaire so suppliers can send you invoices.
It registers the company with the Annuaire and creates the 0225 transport for reception, but generates no tax reports and sends no CDAR messages. enterprise_size and naf_code are no longer required.
When you need it: you want to issue from a Suffix UO at B2Brouter while reception stays with the PA that already holds your SIREN. If you would rather bring it over, see Change PA.
This flag is only accepted on a Suffix UO (cin_scheme="8040") under the SIREN parent. Activating it on the parent returns 422 dgfip_issue_only_suffix_uo_only.
On activation, B2Brouter publishes your line at the PPF Annuaire (the French administration’s directory that routes Flux 1) with the SIREN_<SUFFIX> address, but creates no Peppol transport. The line the other PA publishes for your SIREN stays intact: whatever you publish, you publish under SIREN_<SUFFIX>, which is a different identifier.
You have to create the transport yourself for the Suffix UO, with the composed identifier and with cdar as the only document type enabled. Without a transport, the first send fails with 422 "To use Peppol Network you need to configure this connection to your account".
Three fields are critical:
reception: true publishes the Suffix to the SML. It is required, because CDARs arrive over Peppol and without publication they would not find you.
cdar: true, and no other document type. This is what makes the mode issue-only: you receive the responses to the invoices you issue, but not invoices, which must keep arriving at your current PA.
pin_value must be the {parent SIREN}_{suffix} composition with pin_scheme: 225, the same address B2Brouter has already published on the Annuaire line.
The result is a transport that issues and receives CDARs only. The registration the other PA holds for your SIREN is untouched and keeps receiving your suppliers’ invoices.
If you later want to receive through B2Brouter as well, disable issue_only.
Changing PA involves two separate registrations that behave differently:
The Annuaire is always updated by the incoming PA, not the outgoing one.
The Peppol registration is what can block the change: an identifier can only be active with one provider at a time. Until the registration is moved or deregistered, the incoming PA’s activation fails with 422.
There are three ways to unblock it:
With a migration code, the automatic and recommended path, because it does not interrupt service. It is always issued by the PA that currently publishes the identifier, and used by the incoming PA on activation. At B2Brouter you can request one when leaving (see Leaving B2Brouter) and supply one when arriving (see Coming to B2Brouter).
With Peppol deregistration: the outgoing PA unpublishes the identifier from Peppol. This frees it and the incoming PA can activate, but it leaves you without service until they publish it again. See Unpublishing, deregistering and migrating.
Manually, when the outgoing PA offers neither: contact the incoming PA, and it is the one that claims the change from the outgoing one. Every French PA is required to offer this path, so having no code does not leave you stuck (see Coming to B2Brouter).
Three operations that often go by the same name and have different effects:
Operation
Effect
Still registered in the SML?
Unpublish from the Peppol Directory
Removes the entry from the searchable catalogue
Yes: it keeps sending and receiving
Unpublish from Peppol
Removes the participant registration from the SML
No: this is the deregistration that frees the identifier
Migrate with a code
Transfers the registration to the new PA without deregistering
Yes, with no interruption
Only the second one frees the identifier. As long as the SML registration exists, activating the Tax Report Setting on that identifier will keep failing with 422, even if the other PA has unpublished the directory entry. This is the most common confusion: if they assure you they have unpublished you and activation keeps failing, ask them to confirm they removed the SML registration and not just the directory entry.
The check B2Brouter runs on activation is a live DNS query against the SML, not a query against a database of ours. So there is no guaranteed delay after a deregistration, because propagation depends on the SML and DNS, but you can retry the activation whenever you like and you will get the real state at that moment. A migration code avoids all of this, because it goes through no deregistration.
Activating the Tax Report Setting on an identifier published by another provider fails with 422. Repeat the same call adding the code that provider gave you:
POST /tax_report_settings with peppol_migration_code. This is the main route for France: it moves the identifier as part of the same activation.
POST /transports or PUT /transports/{code} with migration_code, if you are creating the transport directly.
Both fields are write-only and never appear in a GET. If the code doesn’t work, the call fails with migration_code_malformed, migration_code_not_applicable or migration_code_rejected, the latter carrying the real SML reason. No partial state is left behind: if the migration fails, the transport is not created.
If the other PA offers you neither a code nor a deregistration, open a support ticket and we will start the manual procedure to claim your portability.
It returns 409 not_published_by_b2brouter if the transport is send-only, since the identifier is then not published by us.
The read-only migration_pending field on transport GETs tells you whether a code has been issued and not yet cancelled. The code itself is never exposed in any GET.
A French B2B contact needs routing identifiers (how the invoice reaches the recipient) and tax identification (how the recipient appears in the UBL XML).
Field
Value
Purpose
cin_scheme
"0002" (SIREN, default) or "0009" (SIRET, to address a specific establishment)
Organisation ID: used to look up the recipient in the Annuaire
cin_value
SIREN or SIRET
Organisation ID: the identifier registered in the Annuaire
tin_scheme
9957
Tax ID: ISO 6523 code for French fiscal identifier
tin_value
FR{kk}{siren} (e.g. "FR78225214234")
Tax ID: French TVA number in the UBL XML
pin_scheme
"0225"
EAS Peppol of the FR participant (FRCTC Electronic Address) — required for French contacts
pin_value
Recipient’s Annuaire composition
Contact’s Peppol identifier; follows the same composition as the parent at the Annuaire (SIREN, SIREN_SIRET, SIREN_SIRET_<CR> or SIREN_<SUFFIX> — see Identifier levels)
country
"fr"
Required for DGFiP routing logic
currency
"EUR"
Default currency for this contact’s invoices
transport_type_code
"peppol"
Recommended: ensures delivery via the Peppol network
document_type_code
"xml.ubl.invoice.frcius.v1"
Recommended: France CIUS UBL invoice format
Transport and document type: For French contacts registered in the Annuaire, we recommend explicitly setting transport_type_code: "peppol" and document_type_code: "xml.ubl.invoice.frcius.v1". Without pin_value, creation returns HTTP 422 (“Peppol Endpoint ID can’t be blank”). You can verify that a contact is registered in the Annuaire before creating it by using the Directory lookup or the official Peppol Directory.
Contacts in Belgium, Germany, and other EU countries: For B2B invoices to non-French companies, use their national identifier scheme (e.g. "0208" for Belgian KBO/BCE, "0190" for German Leitweg-ID, "0184" for Dutch KVK) and the appropriate country code. If the recipient has an active Peppol access point, B2Brouter routes the invoice via standard Peppol BIS 3.0 — no configuration needed. For transactions with any non-"fr" contact, Flux 10 cross-border e-Reporting is generated automatically.
Addressing a specific establishment: if the client has several establishments and you need to identify one in particular, use cin_scheme: "0009" with the 14-digit SIRET and set pin_value to the SIREN_SIRET composition (e.g. 987654321_98765432100011) instead of the bare SIREN.
Multi-level contacts: if your client has several establishments or services that need separate identifiers, create the parent contact first at SIREN level and then add UOs with parent_id. See Account structure for the golden rule and applicable structures.
Alternative: inline contact on the invoice (without the contacts module)
Instead of creating a contact separately and referencing it with contact_id, you can send an inline contact object directly inside POST /accounts/{ACCOUNT_ID}/invoices, with all of the recipient’s data:
{
"invoice":{
"type":"IssuedInvoice",
"contact":{
"name":"Client Exemple SARL",
"country":"fr",
"currency":"EUR",
"language":"fr",
"cin_scheme":"0009",
"cin_value":"98765432100011",
"tin_scheme":9957,
"tin_value":"FR05987654321",
"pin_scheme":"0225",
"pin_value":"987654321_98765432100011",
"transport_type_code":"peppol",
"document_type_code":"xml.ubl.invoice.frcius.v1"
}
}
}
⚠️ Key warning: always pass the correct identifiers (tin / cin / pin) with the correct FR composition (SIREN parent + UO), to avoid breaking parent↔UO consistency (see The golden rule). From API version 2026-04-20, the system rejects (422) a non-simplified inline contact that provides neither tin_value nor cin_value. currency and language are mandatory on any contact; without them the creation fails regardless. The inline contact also accepts routing_codes.cin1_scheme / routing_codes.cin1_value to identify a service inside a SIRET (Case 2), with the same values ("224" and the Code Routage) as a contact created through the contacts module.
B2Brouter routes invoices automatically. To inspect how a recipient will be routed before sending — for example to confirm they are registered in the Annuaire — use the Directory lookup (Flux 11):
Recipient is registered and active at the PPF Annuaire
information_flags
FR_ASSUJETTI_INACTIVE
Recipient has an out-of-date registration or no assigned PA
information_flags
FR_ASSUJETTI_UNKNOWN
The PPF has no conclusive information (e.g. 404)
source
array of "peppol", "annuaire"
Sources consulted. If both appear, B2Brouter found the recipient in both directories
This lookup is informational: B2Brouter already resolves routing automatically when creating an invoice (see Annuaire verification and tax report generation). Use it to inspect before sending or to display the recipient’s status in your UI.
B2Brouter automatically verifies whether French contacts (country: "fr") are registered in the DGFiP Annuaire. This verification determines the tax reporting flow:
Contact registered in Annuaire (in_dgfip_annuaire: true or not yet verified): the invoice generates a Flux 1 tax report (domestic B2B e-invoicing).
Contact NOT registered in Annuaire (in_dgfip_annuaire: false): the invoice does not generate a tax report. This prevents invalid Flux 1 submissions for recipients that the PPF cannot route to.
Contact not yet verified (in_dgfip_annuaire: nil): B2Brouter is permissive — the invoice proceeds and generates a tax report. Verification happens asynchronously in the background.
If you create a French contact and immediately send an invoice, the Annuaire verification may not have completed yet. This is by design — B2Brouter does not block invoice creation while verification is pending. If the contact turns out to be unregistered, future invoices to that contact will not generate Flux 1 tax reports until the contact registers with a PA.
The Annuaire check only applies to French domestic contacts (country: "fr"). Non-French contacts always follow the Flux 10 e-Reporting path regardless of Annuaire status.
Important: both companies must be in the DGFiP Annuaire: for an FR → FR sending with a Flux 1 tax report, both the issuer and the receiver must be registered in the DGFiP Annuaire. If one of them is not, the tax report cannot complete and the invoice is sent without a tax declaration.
⚠️ The annuaire-entreprises.data.gouv.fr website is for general fiscal data; it does not guarantee DGFiP Annuaire registration — they are different databases.
From September 2026 this permissive behaviour will stop applying: tax declarations will simply fail if the identifier is not listed as DGFiP-activable, even when the SIREN/SIRET is valid.
Once your company is onboarded and the DGFiP Tax Report Setting is enabled, creating invoices works through the standard Invoice API, POST /accounts/{ACCOUNT_ID}/invoices. B2Brouter handles all France-specific requirements automatically: tax report generation, UBL/CII/Factur-X formatting, and PPF transmission via Flux 1.
Use send_after_import: true to create and transmit in one step. Set it to false if you want to create the invoice first and review it before sending — in that case, the invoice stays in new state until you trigger transmission via a separate call or through the B2Brouter UI.
Invoice date
For accounts with an active DGFiP Tax Report Setting, the invoice date cannot be a future date. A future date returns HTTP 422 (“Only invoices with today’s date are allowed”). The dates in the examples below are illustrative; replace them with the current date when testing.
Invoice number
⚠️ Keep the invoice number at 20 characters or fewer. Creation does not validate it and a longer number is created without error, but the PPF enforces a 20-character limit and rejects the deposit afterwards with REJ_SEMAN. In a Flux 10 ledger, the rejection takes the whole period’s batch down with it.
Sequential invoicing
The API processes one invoice per request. For bulk or batch scenarios, iterate through your invoice list and call the endpoint for each document. The API supports concurrent requests — you can parallelise multiple POSTs without waiting for each response before starting the next.
The tax_report_ids array in the response contains the ID of the generated tax report. Use it to track the submission lifecycle (see Check the state of a Tax Report).
Three payment fields are mandatory for French B2B e-invoices (IssuedInvoice). Provide them as direct API fields:
Field
DGFiP field
Description
Required
remittance_information
PMD
Payment reference and legal mentions (company registration, share capital, RCS)
Yes: B2B domestic and cross-border
payment_method_text
PMT
Textual description of the payment method
Yes: B2B domestic and cross-border
payment_terms
AAB
Due date, late payment penalties, discount conditions
Yes: B2B domestic and cross-border
bank_account_id
—
Id of the bank account associated with your B2Brouter company. Required when payment_method is bank transfer (code 4)
Yes, for bank transfer payments
If any required field is missing, the request returns HTTP 422 with explicit error messages for each absent field. These are not silent — the invoice is never created. Correct the missing fields and resubmit.
Bank account: create the bank account associated with your company first (from the web UI or via API), and reference its id in the invoice with bank_account_id. The bank account holds IBAN and BIC and is the canonical source — do not pass them as free text inside payment_method_text.
B2C invoices (IssuedSimplifiedInvoice) do not require these fields.
Importing from other formats (UBL, CII, Factur-X): For these integrations, use the extra_info field with structured tags:
#PMD# FA-2026-0048 — Exemplar SAS, RCS Paris 123 456 789
When a line has category: "E" (TVA-exempt), you must also provide a comment with the applicable VATEX-FR-CGI261-* exemption code (DGFiP BT-121):
⚠️ Silent blocking: If comment is omitted on a category E line, the invoice is created (HTTP 200) but never transmitted to the PPF. The response will contain a non-empty errors array — check it even on successful responses.
DGFiP TVA exemption codes (BT-121)
Code
Legal reference
Tax category
Description
VATEX-FR-FRANCHISE
Art. 293 B CGI
Z (zero-rate)
Franchise en base de TVA
VATEX-FR-CNWVAT
—
E (exempt)
Avoir net de taxe — credit note without TVA (supplier waives the TVA adjustment). Credit notes only (261/381/396, rule G6.21)
VATEX-FR-AE
—
E (exempt)
Autoliquidation (reverse charge)
VATEX-FR-CGI261-1
Art. 261-1° CGI
E (exempt)
Soins et services médicaux
VATEX-FR-CGI261-2
Art. 261-2° CGI
E (exempt)
Services paramédicaux
VATEX-FR-CGI261-3
Art. 261-3° CGI
E (exempt)
Enseignement scolaire, universitaire et formation professionnelle
VATEX-EU-F / -I / -J
—
E (exempt)
Régime de la marge (margin scheme)
EU-level exemption codes: besides the VATEX-FR-* national codes above, the DGFiP also accepts the VATEX-EU-* codelist (UNCL5305 / EN16931 extensions). The régime de la marge (margin scheme) uses VATEX-EU-F, VATEX-EU-I or VATEX-EU-J on a category E line. Provide the applicable code in the line comment.
Companies operating under the franchise en base de TVA regime operate at zero-rate (tax category Z), not exempt (category E). For franchise invoices, set percent: 0.0 and category: "E" with comment: "VATEX-FR-FRANCHISE" on each tax line — B2Brouter transcodes the category to Z automatically:
Some operations fall outside the scope of TVA and must carry tax category O with percent: 0.0, not category E (exempt) or Z (zero-rate). Two common cases:
Détaxe (operations outside the TVA field): the line carries no TVA.
Débours (reimbursable expenses advanced on behalf of the client): passed through without TVA.
{
"taxes_attributes":[
{"name":"TVA","percent":0.0,"category":"O"}
]
}
The Flux 1 tax report synthesises the corresponding category O TaxSubtotal automatically. The NS category is also accepted and transcoded to O.
Legacy fields: in API versions prior to 2026-04-20, a credit note was expressed with is_amend: true + amended_number + amended_date instead of invoice_references. These fields remain accepted in those versions for backward compatibility, but are now legacy: use invoice_references for new integrations.
The process code determines the PPF flux cadre. B2Brouter assigns it automatically based on type_operation in the Tax Report Setting and the invoice characteristics.
Process Code
Type of Operation
Description
S1
Services
Standard invoice for services
B1
Goods
Standard invoice for goods
M1
Mixed
Standard invoice for mixed operations
S2
Services
Paid invoice for services
B2
Goods
Paid invoice for goods
M2
Mixed
Paid invoice for mixed operations
S4
Services
Invoice with payments on account (services)
B4
Goods
Invoice with payments on account (goods)
M4
Mixed
Invoice with payments on account (mixed)
S7
Services
Correction of a registered invoice (services)
B7
Goods
Correction of a registered invoice (goods)
No “M” cadre in Flux 1: although type_operation accepts "mixed", the Flux 1 tax report never carries an M-series process code. A mixed invoice resolves to the corresponding services code (S1/S2/S4/S7) and reports only its service breakdowns. The M rows above are listed for reference but are not produced by Flux 1.
France uses a Y-/5-corner model, not clearance. The invoice is transmitted to the receiver regardless of whether a Flux 1 tax report is registered; the PPF does not pre-clear invoices before they reach the receiver. The Invoice and the Tax Report are separate lifecycles that only coincide at the Flux 1 delivery. A tax report error does not undo an invoice that has already reached the receiver.
1 CDV 206 sets the same state as 205: accepted. The invoice state does not distinguish a full approval from a partial one. The amount the receiver approved is recorded as metadata on the corresponding event, not as an invoice field. 2 The invoice payload carries refuse_reason_code with the structured rejection reason.
Before sending:
For an invoice to be sent, it has to pass schematron validation. If it does not, the send returns HTTP 422, the invoice is left in error state and no tax report is created. The message cites the rule code that failed, for example G1.24 for an invalid TVA rate. The errors field holds the rejection reason: edit the invoice with a PATCH and send it again, or delete it and create a new one. There is no retry endpoint: the path is correct-and-resend.
After sending: DELETE and PATCH return 422: the invoice is inside the receiver’s lifecycle and the correction is made with a credit note. The exception is a failed deposit: as long as all of its tax reports are in error or refused state, the invoice can still be deleted and redone.
Configure webhook endpoints in the B2Brouter UI under Settings → Webhooks. Once configured, B2Brouter sends an HTTP POST to your endpoint each time the invoice reaches a new state.
After an invoice reaches sent state, the GET /invoices/{id} response includes a download_legal_url field. Use it to download the invoice document that was transmitted:
As a one-step alternative, you can call GET /invoices/{id}/as/legal directly, without first fetching download_legal_url from the invoice payload. It returns the archived legal document as stored and does not generate a billable transaction — see Download invoices and Transaction: View_as.
Encaissée is the last state of the CDV cycle of a French B2B invoice, right after the receiver’s approval. It indicates that payment has been confirmed (see the full CDV mapping in the Invoice states table).
B2Brouter propagates the payment confirmation to the PPF via one of two paths, depending on the invoice nature:
Partial payments are recorded with the POST /accounts/{ACCOUNT_ID}/payments endpoint, passing amount and invoice_id. Repeat the call for each payment you receive; once the sum of recorded amounts covers the invoice total, the invoice automatically transitions to paid.
For a single full payment, you can also call mark_as directly with state: "paid" (see Mark an invoice as paid via API); there is no need to go through POST /accounts/{ACCOUNT_ID}/payments first.
Alternatively, handle payments from the B2Brouter web app: open the invoice → Create payment → enter the paid amount.
Payment notes:
You can pass full: true instead of amount to register the full outstanding payment: B2Brouter calculates the pending amount at the time the call executes and never exceeds the invoice total. If you pass an explicit amount instead, there is no overpayment guard: it is your responsibility not to exceed the outstanding total.
Deleting a payment does not reopen the invoice: it stays in the paid state.
If the payment generated a Flux 10 tax report (cross-border or B2C invoice), a PUT/DELETE on that payment returns HTTP 422 because the already-submitted declaration is locked. The domestic FR-FR case (CDV 212, no additional tax report) has no such lock.
As a French company registered in the Annuaire with a Peppol 0225 transport, you automatically receive electronic invoices from other French and Peppol-connected platforms.
Each state transition emits the corresponding CDV to the issuer. Automatic rejections (213) are the exception: they require no call, because B2Brouter derives the DGFiP reason code from the validation errors.
The reason is mandatory for 206 and 207: without it, the call returns 422.
1 The amount_code values are MAP, MAPTTC, MNA and MNATTC. 2 Without dispute: true, the annotated state only records internally and sends no CDV. 3reason_code is optional. See Rejection codes.
When you reject an invoice you can add a reason_code with the DGFiP’s structured reason: ADR_ERR, REF_CT_ABSENT, CMD_ERR, TX_TVA_ERR, MONTANTTOTAL_ERR, CALCUL_ERR, DOUBLON, NON_CONFORME, DEST_ERR, TRANSAC_INC, EMMET_INC, CONTRAT_TERM and DOUBLE_FACT.
The API also accepts AUTRE, but the DGFiP does not allow it in a rejection.
Flux 10 covers transactions outside the scope of the domestic B2B e-invoicing obligation that must still be reported to the DGFiP. B2Brouter handles Flux 10 automatically.
Sales to non-TVA-registered individuals in France. Use "type": "IssuedSimplifiedInvoice". The contact_id and payment fields are not required for B2C invoices.
Cross-border transactions (B2B intra-EU and extra-EU)
Sales to or purchases from companies established outside France must be reported via Flux 10. Use the standard IssuedInvoice or ReceivedInvoice type and set the counterparty’s country to the relevant non-"fr" value. B2Brouter detects the cross-border nature automatically.
French overseas territories: the DROM départements Guadeloupe (gp), Martinique (mq) and La Réunion (re) are treated as domestic France. Invoices to contacts there generate a Flux 1 tax report and carry IdentificationCode FR, exactly like mainland France. The other overseas territories (Guyane gf, Mayotte yt, Polynésie française pf, Nouvelle-Calédonie nc, TAAF tf, Saint-Pierre-et-Miquelon pm) fall outside the French TVA territory and follow the Flux 10 e-Reporting path.
B2Brouter groups Flux 10 tax reports into Ledgers sent to the PPF. The sending frequency is not always daily: it depends on the vat_regime configured on the Tax Report Setting (see DGFiP Tax Report Settings fields), every ten days or monthly depending on the regime, or bimonthly for franchise_en_base. In staging, ledgers are deposited daily to make testing easier; in production, they follow the regime’s real periodicity. You can identify Flux 10 tax reports by a non-null ledger_id in the tax report response.
payments: payment ledgers (process codes S2 / B2 / M2, TVA on services accrues at collection), document type xml.ledger.dgfip.payments.
The combination of roles and modes yields up to 3 ledgers per account and reporting period:
Ledger
Role
Mode
Content
A: Émission
SE
transactions
Issued invoices (B2C and cross-border B2B)
B: Réception
BY
transactions
Intracommunity / extra-EU purchases declared as the buyer
C: Payments
SE
payments
Confirmed payments of your issued invoices (cross-border / B2C Encaissée case)
The pair (BY, payments) does not exist: payment information for your purchases is generated by the seller on their side; you do not declare it.
Each tax report links to a single ledger_id (it cannot belong to more than one ledger at a time). Grouping happens per account + reporting period + (role, mode) under a lock to avoid duplicates.
