Statut des imports
Présentation générale
Cette API renseigne les collaborateurs sur l’état d’avancement de l’import d’un fichier.
Périmètre fonctionnel
Tous les imports sont concernés par cette API : JSON, TRA, FEC et personnalisés.
Procédure
Il faut appeler un endpoint permettant d’obtenir le statut de l’import.
Route | Méthode http | Description |
---|---|---|
/getImportStatus | GET | Obtention du statut de l'import |
Paramétres de l’appel
Méthode http pour la demande : GET
Header(s) attendu(s) obligatoire(s) de la demande : API-KEY
Nom | In | Requis | Type | Description |
---|---|---|---|---|
accountingImportRequestId | template | true | string | Uuid obtenu suite au lancement d'un import |
Exemple d'un appel :
/getImportStatus?accountingImportRequestId={accountingImportRequestId}
Les différents statuts des imports
- 1 : en attente
- 2 : en cours
- 3 : terminé avec succès
- 4 : terminé en erreur
Note importante
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).
Exemple de réponse de l'API
{
"nbRetry": 0,
"_id": "6228c1753a55b9d6b9b6300f",
"nbRetryPendingStatut": 0,
"id": "ed6b34042-1195-46da-a679-a94e607b08b7",
"creationDate": "2022-03-09T15:02:13.218Z",
"lastUpdate": "2022-03-09T15:03:08.067Z",
"codeIBS": "A DETERMINER",
"domain": "A DETERMINER",
"status": 4,
"data": {
"domain": "A DETERMINER",
"code_ibs": "A DETERMINER",
"origine_request": "AUTO_IMPORT",
"file_format": "FEC",
"fine_name": "349536599FEC20211230.txt",
"file_path": "/sites/NOM_SITE_SHAREPOINT/Shared Documents/General/Dépots/Imports_auto/349536599FEC20212130.txt",
"fie_origin": "SHAREPOINT",
"file_owner": " ",
"user_id": "e54dd929-404b-4780-b937-5b56a45a83bf",
"file_url": "",
"attached_files": []
},
"__v": 0
}
Note : Les caractéristiques de l'import sont regroupés dans l'objet Data.