IMPORT AU FORMAT TRA

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

 

Cette API permet d'effectuer un import au format TRA de tous les éléments rattachés aux mouvements comptables à partir d'un fichier normé :

  • écritures comptables,

  • écritures analytiques,

  • comptes généraux,

  • tiers,

  • sections analytiques (l'axe doit être présent dans le dossier Cegid Loop),

  • journaux,

  • devises,

  • modes de paiement,

  • RIB des tiers.

Notes importantes :

  • L'import au format TRA ne permet pas la récupération du lettrage.
  • Pour la gestion des pièces jointes, Cf. chapitre Cas spécifiques, ci-dessous.
  • Le descriptif des comptes, tiers, journaux et sections doit être présent en tant que paramètre dans le fichier TRA. En effet, cette condition est préalable pour la création de ces éléments, présents dans un mouvement comptable.  

Procédure

Cette API est lancée à la suite de l'API d'obtention de l'URI-URL du fichier. Cf. chapitre Structure du corps de la demande, ci-dessous.

Il faut appeler un endpoint permettant de récupérer un fichier TRA et d'enregistrer une demande d'import d'écritures. Après insertion, un service interne récupèrera la demande pour la traiter et effectuer l'import.

  |Route|Méthode http|Description| | :- | :- | :- | |/importTRA | POST | Insère une demande d'import d'écritures |

Paramétrage de l'appel

Méthode http pour la demande : POST

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

 

Structure du corps de la demande

Clé Type Description
codeIbs string Code Dossier
URI string Chemin d'accès au fichier dans Azure Storage
URL string Endroit où le fichier est enregistré

Important

Il faut saisir soit l'URL soit l'URI, mais pas les deux en même temps.

L'URL ou l'URI doit être valide pendant au moins 24 heures pour l'authentification au fichier (recommandation de Microsoft).

Cette procédure est disponible avec le lien suivant : Obtention de l'URI-URL du fichier | Cegid Developers (lien en prod à vérifier avec Manon)

L'objectif est de pouvoir gérer le processus de "retry" et de suivre les interruptions de service, qu'elles soient volontaires ou involontaires.

Exemple d'appel

https://api.cegid.com/loop-api-publiques/importTra

 

{
"codeIbs": "string",
"URI": "string",
"URL": "string"

}

 

Les différents codes retour en cas de succès

 

Code retour http de la réponse : 200

Format du corps de la réponse : JSON

Structure du corps de la réponse :

Clé Type Valeur
accountingImportRequestId String String sous forme de guid, par exemple : "8d1e2a1a-e245-46a5-a06e-6e3cfa903824". Ce guid permettra de suivre la demande via un autre endpoint : getImportStatus.

 

{
" countingImportReguestId": "8d1e2a1a-e245-46a5-aa6e-6e3cfage3824"

}

Quelques exemples de messages d'erreurs possibles :

 

  • Le codeIbs n'est pas spécifié.

  • Le chemin d'accès URI ou l'URL du fichier n'est pas spécifié.

  • Ambiguité sur le chemin d'accès, seul un des deux champs doit être renseigné.

  • Le dossier {codeIBS} n'existe pas sur le domaine.

Notes :

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".

Cas spécifiques

Import avec analytique

Il faut créer l'axe analytique dans le dossier Cegid Loop, au préalable.

Pour rappel, les sections sont crées à l'import, sous réserve que le paramétrage des sections soit présent dans le fichier TRA.

 

Import avec lettrage

Le lettrage n'est pas pris en compte dans l'import TRA.

Import avec devise

Exemple de fichier TRA

Medias/Import%20TRA_1.png  

Résultat en saisie dans Cegid Loop

 

Medias/Import%20TRA_2.png

 

 

Import avec modes de paiement

 

Mode de paiement dans Cegid Loop Format TRA
Aucun LCR (Traites, LCR et BOR), TEP (Titres de paiement), TRI (Transferts internationaux)
Espèces ESP
Chèque CHQ
Carte bancaire CB
Virement bancaire VIR (virements), VIC (virements commerciaux), VIT (virements de trésorerie)
Prélèvement bancaire PRE
Titre Interbancaire de Paiement TIP

 

 

Pour les modes de paiement suivants, il n'existe pas de correspondance dans le TRA :

 

  • LCR BOR (Lettre de Change Relevé par bordereau)

  • LCR magnétique (Lettre de Change Relevé dématérialisée)

  • Traite (autre moyen de paiement)

  • Télérèglement (ordre de prélèvement)

Import avec RIB Tiers

On ne récupère que le RIB du compte principal.

 

Import avec pièces jointes

Pour que les PJ soient importées, il faut que la référence du fichier soit présente dans le fichier TRA.

Medias/Import%20TRA_3.png  

Dans un second temps, les PJ devront être déposées dans :

  • Ancien SharePoint : DP > ARCHIVE > IMPORT

  • New Teams : Documents > Général > Imports de fichiers

Suite à l'import, les pièces jointes seront déplacées dans :

  • Ancien SharePoint : DP > ARCHIVE > IMPORT

  • New Teams : Documents > Général > Archives > CodeEtablissement/Exercice/Période + Nom de la PJ renommée à l'identique au lien en saisie