Transform API : convertir le format d'un document

Convertir des documents entre formats de facturation électronique sans les envoyer via l'endpoint Transform.

La Transform API vous permet de convertir un document d'un format de facturation électronique vers un autre, sans l'envoyer ni le stocker dans la PSB. C'est pratique pour tester des transformations avant la mise en production, ou pour convertir manuellement des documents destinés à des partenaires qui exigent un format spécifique.

Endpoint
POST /api/v1/generic/transform?targetFormat={URN}

Envoyez le document source dans le body avec le content-type application/xml. Le paramètre targetFormat contient l'URN du format cible souhaité.

Comment ça fonctionne ?
  1. Upload : envoyez le document XML vers l'endpoint avec le format cible souhaité
  2. Détection : la PSB détecte automatiquement le format source en se basant sur le contenu XML
  3. Transformation : le document est converti vers le format cible spécifié
  4. Réponse : le document converti est retourné directement en XML

Si la détection automatique du format source échoue, vous pouvez le spécifier explicitement via le paramètre sourceFormat :

POST /api/v1/generic/transform?targetFormat={URN}&sourceFormat={URN}
Exemples

De NLCIUS vers Peppol BIS Billing V3 :

POST /api/v1/generic/transform?targetFormat=urn:cen.eu:en16931:2017%23compliant%23urn:fdc:peppol.eu:2017:poacc:billing:3.0

De UBL vers CII (Cross Industry Invoice) :

POST /api/v1/generic/transform?targetFormat=urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100

Attention : Encodez les valeurs URN dans les paramètres de requête. Le caractère # doit être encodé en %23.

Transformations prises en charge

Toutes les transformations ne sont pas disponibles. La PSB prend en charge les mêmes transformations que lors de l'envoi et de la réception de documents. Les transformations les plus courantes comprennent les conversions entre UBL et CII, et entre différentes variantes régionales (NLCIUS, XRechnung, Factur-X).

Les transformations exactes disponibles dépendent de la table de transformation actuelle de la PSB. Consultez psb.econnect.eu pour l'aperçu le plus récent.

Gestion des erreurs
Code de statutSignification200 OKTransformation réussie, document converti dans le body de la réponse400 Bad RequestFormat source non reconnu ou transformation non prise en charge422 UnprocessableLe document ne peut pas être converti (données manquantes ou invalides)
Quand l'utiliser ?
  • Tests avant mise en production : vérifiez que vos documents sont correctement transformés avant d'activer l'intégration en production
  • Conversion manuelle : convertissez des documents pour des partenaires qui exigent un autre format
  • Comparaison : générez le même document dans plusieurs formats pour vérifier le mapping

Technique : La Transform API ne stocke pas le document et ne déclenche aucun webhook. Le document est transformé en mémoire et retourné directement.


Consultez la spécification API complète sur psb.econnect.eu pour tous les formats pris en charge et les valeurs URN.

Essayer dans l'API

En lien
Articles associés