Aller au contenu principal
Version: 8.5

Installation et configuration

Cette section décrit la configuration côté AOS du sous-module E-Invoicing : les paramètres globaux de l'application, la création d'une plateforme d'accès vers une PA, et la création des règles de routage qui pilotent chaque type d'opération (annuaire, émission, réception).

Paramètres généraux

L'application E-Invoicing dispose d'un écran de paramétrage global, accessible depuis le gestionnaire d'applications d'AOS. Ces paramètres sont transverses : ils s'appliquent à toutes les plateformes d'accès et à tous les traitements automatisés du sous-module.

Écran de paramétrage global de l'application E-Invoicing dans le gestionnaire d'applications d'AOS.
Écran de paramétrage global de l'application E-Invoicing dans le gestionnaire d'applications d'AOS.

Onglet Général

  • Plateforme par défaut (defaultAccessPlatform) — Plateforme d'accès utilisée par défaut lorsque aucune plateforme n'est explicitement renseignée sur un batch ou sur une société. Ce champ est à remplir après la création d'au moins une plateforme d'accès.

Onglet Stockage

Cet onglet régit la manière dont les fichiers de facturation électronique sont conservés dans AOS.

  • Chemin de stockage (storageBasePath) — Sous-répertoire racine, dans le système de gestion documentaire d'AOS, dans lequel les fichiers de facturation électronique sont rangés. Valeur par défaut : « frfiscal ».

Onglet Journalisation

Cet onglet pilote le niveau de traçabilité des appels effectués vers la PA et reçus depuis celle-ci.

  • Journalisation des appels API (logApiCalls) — Lorsque cette option est activée, toutes les requêtes HTTP sortantes vers la PA et leurs réponses sont consignées dans les journaux d'exécution. Valeur par défaut : désactivée. À n'activer qu'en cas de besoin de diagnostic, l'activation pouvant avoir un impact sur les performances et générer un volume de logs important. En cours de développement.
  • Journalisation des webhooks (logWebhooks) — Lorsque cette option est activée, les charges utiles des webhooks entrants reçus depuis la PA sont consignées dans les journaux à des fins d'audit. Valeur par défaut : activée. En cours de développement.

Création d'une plateforme d'accès

La plateforme d'accès matérialise dans AOS la configuration de connexion à une PA. Une installation peut comporter plusieurs plateformes d'accès en parallèle.

Fiche de configuration d'une plateforme d'accès vers une Plateforme Agréée.
Fiche de configuration d'une plateforme d'accès vers une Plateforme Agréée.

Informations principales

Le panneau principal de la fiche concentre les informations identifiantes et le rattachement organisationnel.

  • Code (code) — Identifiant interne court de la plateforme. Utilisé comme libellé principal dans les écrans et les sélections.
  • Nom (name) — Libellé étendu de la plateforme.
  • Société (company) — Société propriétaire de la configuration. Champ obligatoire. Une plateforme est toujours rattachée à une société donnée.
  • Environnement (environmentSelect) — Deux valeurs possibles :
    • Sandbox (1) — environnement de recette de la PA, utilisé pour les tests d'intégration.
    • Production (2) — environnement de production, utilisé pour les échanges réels.

Le choix de l'environnement influence directement les URL d'API à fournir et le comportement attendu de la PA.

  • Actif (isActive) — Indicateur d'activation de la plateforme. Une plateforme inactive est ignorée par les traitements automatisés. Valeur par défaut : activée.

Mode d'authentification

L'onglet Authentication propose le choix du mécanisme d'authentification utilisé pour les appels API vers la PA, parmi deux options conformes à la norme AFNOR XP Z12-013. Le formulaire affiche dynamiquement les champs nécessaires en fonction du type retenu.

  • Type d'authentification (authTypeSelect) — Choix entre :
    • Clé d'API (1) — authentification par jeton statique.
    • OAuth2 Client Credentials (2) — authentification par jeton porteur (Bearer) renouvelé à chaque appel.

La norme AFNOR XP Z12-013 impose la prise en charge d'OAuth2 par les PA ; certaines PA proposent en complément un mode Clé d'API. Le choix doit être aligné sur ce que la PA déclare prendre en charge.

Détail du mode Clé d'API :

  • Clé d'API (apiKey) — Clé secrète fournie par la PA, à saisir telle quelle. Le champ est masqué à la saisie et chiffré en base. Cette clé est transmise à chaque appel via l'en-tête HTTP convenu avec la PA.

Détail du mode OAuth2 Client Credentials :

  • Identifiant client (clientID) — Identifiant public du compte API fourni par la PA.
  • Secret client (clientSecret) — Secret associé au compte API. Le champ est masqué à la saisie et chiffré en base.
  • URL du jeton (tokenUrl) — Adresse complète du point de terminaison d'obtention de jeton OAuth2 (endpoint « token URL ») exposée par la PA.

Le sous-module obtient à chaque appel un jeton porteur frais auprès du point de terminaison tokenUrl.

Paramètres d'API

L'onglet API regroupe l'URL racine de la PA et les paramètres de robustesse réseau.

  • URL de base (baseUrl) — Racine de l'API de la PA. Tous les chemins de routage sont relatifs à cette URL. Le protocole HTTPS est requis en production.
  • Temporisation de connexion (connectionTimeoutMs) — Durée maximale, en millisecondes, autorisée pour l'établissement d'une connexion HTTP avec la PA. Valeur par défaut : 30 000 ms (30 secondes).
  • Temporisation de lecture (readTimeoutMs) — Durée maximale, en millisecondes, d'attente d'une réponse de la PA après envoi d'une requête. Valeur par défaut : 60 000 ms (60 secondes).
  • Nombre maximal de tentatives (maxRetries) — Nombre de relances effectuées automatiquement en cas d'échec transitoire (timeout, erreur serveur 5xx, etc.). Valeur par défaut : 3. Bornes acceptées : 0 à 10.
  • Délai entre tentatives (retryDelayMs) — Délai d'attente, en millisecondes, entre deux tentatives consécutives. Valeur par défaut : 1 000 ms (1 seconde).

Webhook entrant (optionnel)

info

La spécification webhook est encore en pré-version dans la version 1.2 ; la mise en œuvre côté AOS reste donc en cours de développement et susceptible d'évoluer avec la version normative définitive.

Certaines PA proposent un mécanisme de notification poussée par webhook entrant. Lorsque cette fonctionnalité est utilisée, la PA appelle directement AOS à chaque événement (arrivée d'un flux, changement de statut, etc.), ce qui évite la dépendance à l'interrogation périodique.

  • Webhook activé (webhookEnabled) — Indicateur d'activation de la réception de webhooks. Valeur par défaut : désactivée.
  • Secret de webhook (webhookSecret) — Secret partagé entre la PA et AOS, utilisé pour valider l'empreinte HMAC des notifications entrantes. Le champ est masqué à la saisie et chiffré en base. Visible uniquement lorsque le webhook est activé.

Test de connectivité

Le panneau latéral « Connexion » de la fiche plateforme expose un bouton « Vérifier la connexion » (Check connection) qui valide la configuration en interrogeant la PA.

Panneau latéral de connexion avec le bouton « Vérifier la connexion » et le résultat du test de connectivité.
Panneau latéral de connexion avec le bouton « Vérifier la connexion » et le résultat du test de connectivité.

Paramétrage des règles de routage

Une règle de routage (AccessPlatformRoutingRule) spécifie, pour une plateforme d'accès donnée et pour un type d'opération particulier, le chemin API à appeler et, le cas échéant, les paramétrages de génération de fichier (File Generator) ou de capture de données (Data Capture) à utiliser. Une plateforme porte autant de règles de routage qu'elle expose d'opérations différentes auprès du sous-module.

Les quatre types d'opération définis sont :

  • Annuaire — consultation de l'annuaire de la PA pour la recherche d'entreprises et de leurs adresses électroniques.
  • Émission — transmission des factures et cycle de vie émis par l'entreprise vers ses clients via la PA.
  • Réception — récupération des factures et cycle de vie entrants acheminées vers l'entreprise via la PA.
  • E-Reporting — transmission des données déclaratives à l'administration fiscale via la PA. (en cours de développement)
Onglet des règles de routage sur la fiche d'une plateforme d'accès.
Onglet des règles de routage sur la fiche d'une plateforme d'accès.

Les champs présentés sur le formulaire d'une règle dépendent du type d'opération sélectionné.

Formulaire de paramétrage d'une règle de routage : type d'opération, chemin de service et paramétrages associés.
Formulaire de paramétrage d'une règle de routage : type d'opération, chemin de service et paramétrages associés.

Règle d'annuaire

La règle d'annuaire fournit au sous-module le chemin de l'API d'annuaire de la PA, utilisée pour la recherche et la maintenance des adresses électroniques.

Champs à renseigner :

  • Type de routage (routingSelect) — Sélectionner « Annuaire ».
  • Plateforme d'accès (accessPlatform) — Renseigné automatiquement si la règle est créée depuis l'onglet « Routing rules » d'une plateforme.
  • Société (company) — Renseignée automatiquement à partir de la société de la plateforme d'accès rattachée.
  • Chemin de service annuaire (directoryServicePath) — Préfixe d'API ajouté à l'URL de base de la plateforme pour les appels d'annuaire. Exemple : /directory/v1. La PA doit fournir ce chemin dans sa documentation d'intégration.

Règle d'émission

La règle d'émission fournit au sous-module le chemin de l'API de flux à utiliser pour l'émission de factures et de cycle de vie, ainsi que le paramétrage File Generator qui produit le fichier XML de facture structuré à transmettre.

Champs à renseigner :

  • Type de routage (routingSelect) — Sélectionner « Émission ».
  • Plateforme d'accès et Société — Renseignés automatiquement comme pour la règle d'annuaire.
  • Chemin de service de flux (flowServicePath) — Préfixe d'API ajouté à l'URL de base de la plateforme pour les appels de flux en émission. Exemple : /flow/emission/v1. La PA doit fournir ce chemin.
  • Paramétrage File Generator (fileGeneratorSetting) — Référence à un paramétrage du sous-module File Generator, qui définit le format et le mappage utilisés pour produire le fichier XML sortant. La création et le paramétrage d'un File Generator Setting sont décrits dans la documentation Axelor File Generator.
  • Expression Groovy de filtrage (rule) — Champ optionnel, qui permet de saisir une expression Groovy dont l'évaluation conditionne l'application de la règle à une facture donnée. En cours de développement.

Règle de réception

La règle de réception fournit au sous-module le chemin de l'API de flux à utiliser pour la récupération des factures et cycles de vie entrants, ainsi que le paramétrage Data Capture qui assure l'interprétation de la facture et son intégration dans AOS.

Champs à renseigner :

  • Type de routage (routingSelect) — Sélectionner « Réception ».
  • Plateforme d'accès et Société — Renseignés automatiquement comme précédemment.
  • Chemin de service de flux (flowServicePath) — Préfixe d'API ajouté à l'URL de base de la plateforme pour les appels de flux en réception. Exemple : /flow/reception/v1. La PA doit fournir ce chemin.
  • Paramétrage Data Capture (dataCaptureSetting) — Référence à un paramétrage du sous-module Data Capture, qui définit le format et les règles d'extraction utilisés pour intégrer les factures entrantes dans AOS. Le sous-module restreint la sélection aux paramétrages Data Capture pour lesquels l'option « Générer automatiquement la facture » est activée — sans cette option, la facture entrante ne pourrait pas être créée dans AOS au moment de la réception. La création et le paramétrage d'un Data Capture Setting sont décrits dans la documentation Axelor Data Capture.

Règle d'e-reporting

info

La règle d'e-reporting fournira au sous-module le chemin de l'API de flux à utiliser pour la transmission des données d'e-reporting. Cette règle peut être paramétrée dès maintenant dans l'interface, mais l'envoi effectif n'est pas opérationnel en version 8.10 (en cours de développement).

Champs à renseigner (à titre d'anticipation) :

  • Type de routage (routingSelect) — Sélectionner « E-Reporting ».
  • Plateforme d'accès et Société — Renseignés automatiquement.
  • Chemin de service de flux (flowServicePath) — Préfixe d'API ajouté à l'URL de base pour les appels d'e-reporting.