omnibill/chorus-pro

Chorus Pro, the public sector's invoicing portal, for omnisense/omnibill, through PISTE: a supplier's invoices to a public entity (B2G), deposited as flows and followed. The gateway calls Chorus Pro's "Factures" API:

and, with sandbox: true, https://sandbox-oauth.piste.gouv.fr/api/oauth/token and https://sandbox-api.piste.gouv.fr/cpro/factures (Chorus Pro's qualification). Each call carries Authorization: Bearer <token>, cpro-account: base64(login:password) and Accept: application/json, and a JSON body (idUtilisateurCourant added when user_id is set).

Installation

composer require omnibill/chorus-pro

PHP 8.2 or later, omnisense/omnibill and symfony/http-client. A PISTE application subscribed to the Chorus Pro APIs, and a Chorus Pro technical account attached to the supplier's structure (see Chorus Pro's guides "Se raccorder à Chorus Pro" and "création d'un compte technique").

The sources

Read on 2026-10-08:

• Chorus Pro's "Factures" OpenAPI, as data.gouv.fr points to it (api_gouv_swaggers, api-chorus-pro.json): the routes /v1/deposer/flux, /v1/rechercher/fournisseur, /v1/consulter/historique, the cpro-account header, the bodies, statutCourantCode;
• the annex on the API services of Chorus Pro's external specifications (V5.00, communaute.chorus-pro.gouv.fr): deposerFluxFacture (its syntaxes, 10 MB a file, 30 compressed, its errors), consulterCR, consulterCRDetaille;
• the DGFiP's external specifications v3.2, file "Chorus Pro" v1.1: PISTE, the API channel;
• PISTE's addresses: https://oauth.piste.gouv.fr/api/oauth/token, https://api.piste.gouv.fr, and their sandboxes.

Credentials

• A PISTE application (piste.gouv.fr) subscribed to the Chorus Pro APIs: its client id and secret (OAuth 2.0 client credentials). The sandbox has applications of its own.
• A Chorus Pro technical account (TECH_1_...@cpro.fr) attached to the supplier's structure, and its password; user_id (idUtilisateurCourant) when the account asks for it.

Options

Capabilities

capabilities(): Factur-X, UBL, CII; not an approved platform; public sector; 10 MB.

Operations

Every answer carries codeRetour (0: done) and libelle; another code is a ProviderException with it (20001, GDP_MSG_11.022: the file is too large). HTTP 401 or 403 is an InvalidKeyException: PISTE or the technical account refused.

Chorus Pro's statuses read as the reform's - this package's reading, the code always kept in StatusChange::$code:

The validation circuits (A_VALIDER_1, VALIDEE_2...) and Chorus Pro's own states have no counterpart: the flow keeps its last status, the code is in data.

Not done: receiving (the public entities' side), the directory of structures (another API), e-reporting, callbacks; the deposit report (consulterCR) - its route on PISTE was not found in the documentation read.

Example

<?php

require __DIR__.'/vendor/autoload.php';

use Omnibill\ChorusPro\ChorusProGatewayFactory;
use Omnibill\Model\Invoice;
use Omnibill\Model\Party;
use Omnibill\Model\Syntax;
use Symfony\Component\HttpClient\HttpClient;

$public = (new ChorusProGatewayFactory(HttpClient::create()))->create([
    'client_id' => getenv('PISTE_CLIENT_ID'),
    'client_secret' => getenv('PISTE_CLIENT_SECRET'),
    'login' => getenv('CPRO_LOGIN'),
    'password' => getenv('CPRO_PASSWORD'),
    'sandbox' => true,
]);

$invoice = new Invoice(file_get_contents('F-2026-042.pdf'), 'F-2026-042.pdf', Syntax::FACTURX, 'F-2026-042', buyer: new Party('Mairie', siret: '21670482500019'));
$flow = $public->submit($invoice);                 // PENDING, numeroFluxDepot as reference
$flow = $public->fetchStatus($flow);               // ACCEPTED, the invoice's statut read as the reform's

Run on 2026-10-26 on a MockHttpClient serving this package's fixtures (the harness's recorded.php), PHP 8.4, no network; the requests (>, the body cut at 120 characters) and what each call answered, then supports(Receive::class), receive() and a CDAR submitted:

  > POST https://sandbox-oauth.piste.gouv.fr/api/oauth/token
  > POST https://sandbox-api.piste.gouv.fr/cpro/factures/v1/deposer/flux  {"fichierFlux":"JVBERi0xLjcKLi4u","nomFichier":"F-2026-042.pdf","syntaxeFlux":"IN_DP_E2_CII_FACTURX","avecSignature":fal
CPP0021100000000000000023 pending 2026-10-08 00:00
  > POST https://sandbox-api.piste.gouv.fr/cpro/factures/v1/rechercher/fournisseur  {"numeroFacture":"F-2026-042"}
accepted made_available, history: made_available (MISE_A_DISPOSITION)
bool(false)
The "chorus-pro" gateway does not support Receive.
Chorus Pro takes no CDAR file through this gateway.

In Symfony:

omnibill:
    gateways:
        public:
            factory: chorus-pro
            options:
                client_id: '%env(PISTE_CLIENT_ID)%'
                client_secret: '%env(PISTE_CLIENT_SECRET)%'
                login: '%env(CPRO_LOGIN)%'
                password: '%env(CPRO_PASSWORD)%'
                sandbox: false                  # true: PISTE's sandbox

Errors

A dateDepot or dateHeureEtatCourant PHP cannot read as a date is no date: the flow's submittedAt is then the time of the deposit (as without a dateDepot), the status change's at null; the deposit is kept rather than lost to an exception.

Verified, and not

The package's tests (Tests/ChorusProGatewayTest.php, 5 tests) pass on 2026-10-26 (PHP 8.4).

Responsibility

This package is an independent, unofficial client: it is not affiliated with, endorsed by or sponsored by the AIFE (Chorus Pro) or the PISTE platform. Whoever runs it complies with the Chorus Pro CGU and the PISTE terms; see the README's Responsibility section.