API - Dépôt de factures dans une panière i-Dépôt

Cette procédure décrit comment déposer, par API, une facture d’achat ou une facture de vente dans la panière i-Dépôt d’un dossier ACD.

Principe de la panière i-Dépôt

La panière i-Dépôt correspond à une zone de dépôt temporaire des factures avant leur traitement comptable.

Les factures déposées dans cette panière sont ensuite prises en charge, soit :

• automatiquement, par un robot de traitement ;
• manuellement, par un collaborateur du cabinet.

Une fois la facture traitée, elle disparaît de la panière i-Dépôt.

La panière i-Dépôt doit donc être considérée comme une zone de dépôt des documents en attente de traitement, et non comme une zone d’archivage permanent.

Le processus consiste à identifier le dossier à partir de son SIRET, à se positionner sur ce dossier, à identifier la panière correspondant au type de facture, puis à y déposer le document.

1. S’authentifier auprès de l’API

La première étape consiste à ouvrir une session API avec l’endpoint :

POST /v1/authentification

L’authentification permet d’obtenir le UUID de session qui sera utilisé pour les appels suivants.

2. Identifier le dossier à partir du SIRET

Si le SIRET de l’entreprise est connu mais pas son code dossier ACD, il est possible de rechercher le dossier avec :

POST /v1/dossiers/filtrer

Exemple de critère de recherche :

{
  "Sirets": [
    "12345678901234"
  ]
}

Dans la réponse de l’API, récupérer la propriété :

"Code": "CODEDOSSIER"

Cette valeur correspond au code du dossier ACD associé au SIRET.

3. Se positionner sur le dossier

Une fois le code dossier identifié, il faut positionner la session API sur ce dossier avec :

POST /v2/sessions/dossier

Le code récupéré à l’étape précédente est utilisé pour sélectionner le dossier concerné.

Les appels suivants seront alors réalisés dans le contexte de ce dossier.

4. Identifier la panière de destination

Pour récupérer les panières disponibles sur le dossier, utiliser :

GET /v1/panieres/types

Dans la réponse, rechercher la panière correspondant à la nature du document à déposer.

Factures d’achats

Rechercher la panière dont la propriété Famille est :

"Famille": "_TYPE_FACTURES_ACHAT"

Factures de ventes

Rechercher la panière dont la propriété Famille est :

"Famille": "_TYPE_FACTURES_VENTE"

Une fois la panière trouvée, récupérer sa propriété :

"Id": 123

Cet Id identifie la panière dans laquelle le document devra être déposé.

La réponse de l’API permet également de connaître les contraintes applicables aux fichiers pouvant être déposés dans la panière :

• ExtensionsAutorisees : indique les extensions de fichiers autorisées pour cette panière.
  Si cette propriété est vide, aucune restriction d’extension n’est appliquée.
• TailleMaximaleAutorisee : indique la taille maximale autorisée pour un fichier déposé dans la panière.

Il est recommandé de contrôler ces deux informations avant l’envoi du document avec POST /v1/panieres/documents, afin de vérifier que le fichier respecte les caractéristiques attendues par la panière.

5. Déposer la facture dans la panière

Le dépôt du document est effectué avec :

POST /v1/panieres/documents

L’Id de la panière récupéré à l’étape précédente permet d’orienter le document vers la panière correspondant aux factures d’achats ou aux factures de ventes.

La facture est alors disponible dans la zone i-Dépôt du dossier, en attente de son traitement comptable.

Après traitement par un robot ou un collaborateur du cabinet, la facture disparaît de cette zone de dépôt.

Synthèse du processus

POST /v1/authentification
        │
        ▼
Récupération du UUID
        │
        ▼
POST /v1/dossiers/filtrer
Recherche à partir du SIRET
        │
        ▼
Récupération du Code dossier
        │
        ▼
POST /v2/sessions/dossier
Positionnement sur le dossier
        │
        ▼
GET /v1/panieres/types
        │
        ├── _TYPE_FACTURES_ACHAT
        │
        └── _TYPE_FACTURES_VENTE
        │
        ▼
Récupération de l'Id de la panière
        │
        ▼
POST /v1/panieres/documents
        │
        ▼
Dépôt de la facture dans i-Dépôt
        │
        ▼
Traitement comptable
(robot ou collaborateur)
        │
        ▼
La facture disparaît de la zone de dépôt
        │
        ▼
Le document est stocké dans la GED
et associé à l’écriture comptable

Endpoints utilisés