Historique des imports

Présentation générale de l'API et finalité fonctionnelle

Cette API renseigne les collaborateurs sur l’historique complet d’un import effectué. Cette dernière sera surtout utile pour les imports effectués par les partenaires.

Pourquoi ?

Si l’import provient d’un partenaire, les écritures comptables sont intégrées dans Cegid Loop en mode brouillard.

Vous les validerez définitivement dans le dossier depuis le menu suivant : Comptabilité > Imports > Imports partenaires.

Pour suivre l'état d'avancement de cette validation, vous devrez utiliser le endpoint "Historique des imports" (Import history).

Rappel :

Dans l’interface des imports partenaires, il n'est pas possible de récupérer les statuts 10 et 20 ("en attente" et "en cours").

En effet, en fin de traitement de l'import via l'API, on aura uniquement les statuts à partir de 25.

Afin de récupérer les statuts "en attente" et "en cours", il faut utiliser l’API "getImportStatus".

Périmètre fonctionnel

Tous les types d’imports sont concernés par cet API : JSON, TRA, FEC et personnalisés ainsi que tous types de sources de l’import (Manuel, Automatique, API, API Partenaire).

Procédure

Il faut appeler un endpoint permettant d’obtenir l'historique de l’import.

Route	Méthode http	Description
/historiqueImport	GET	Obtention de l'historique complet d'un import

Paramétrage de l’appel

Méthode http pour la demande : GET

Header(s) attendu(s) obligatoire(s) de la demande : API-KEY

Nom	Requis	Exemple	Description
codeDossier	true	CEGIDOO3	Code du dossier
filter string (query)	false	nomFichier=="test.TRA"	Permet de filtrer le résultat
sort	false	?filter="field==={filter}"	Permet de trier le résultat
skip	false	?skip="{number}"	Permet de passer en paramètres X éléments
take	false	?take="{number}"	Permet de récupérer X éléments

Exemple d'un appel :

/historiqueImport?codeDossier=CEGID003

Les différents statuts de l'historique des imports

• 10 : en attente
• 20 : en cours
• 25 : en attente de validation
• 30 : terminé avec succès
• 40 : terminé avec erreur
• 50 : rejeté
• 99 : annulé

Lorsqu'un partenaire effectue un import, ce dernier est enregistré dans l'historique avec un statut de 25 (en attente de validation), en cas de succès de cet import (teminé avec succès). Les écritures associées sont enregistrées alors en mode "Projet".

Si une erreur survient lors de l'import (teminé avec erreur), celui-ci est enregistrée dans l'historique des imports avec un statut de 40 (terminé avec erreur).

En cas de succès, le partenaire a 2 options :

• Approuver l'import : Dans ce cas, les écritures seront mis à jour avec le type "Général" et seront entièrement intégrées. L'historique des imports sera alors mis à jour avec un statut de 30 (Terminé avec succès).

• Refuser l'import : Dans ce cas, les écritures seront supprimées et l'historique de l'import sera mis à jour avec un statut de 50 (Rejeté). Dès lors que ce choix est confirmé, le partenaire peut choisir d'annuler l'import. L'historique sera alors mis à jour avec un statut de 99 (Annulé).

Exemple de réponse de l'API

[
    {
        "objectId": "a53f25cd-3e54-4e72-abe9-1fd73929dd61",
        "revisionId": "0x0000000000021CBE",
        "description": [
            "00792L.TRA"
        ],
        "nomFichier": "00792L.TRA",
        "statut": 40,
        "erreur": "Une écriture n'est pas dans la période : 03/02/2020",
        "briqueApplicative": 10,
        "origine": 10,
        "detail": [],
        "creation": null,
        "misajour": null,
        "utilisateur": "tmartins@cegid.com"
    }
]