Ecriture Comptable

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

Cette API permet la récupération d'écritures comptables de Cegid Loop :

La requête "GET Liste des Ecriture Comptables" retourne une liste d'informations relatives aux écritures d'un dossier selon le choix des paramètres.

Les limites :

Contrainte de volumétrie => La requête ne renvoie que 100 réponses.

En cas de besoin de résultats supplémentaires, il sera possible utiliser le sinker : Lien vers la documentation technique

GET/EcritureComptable

Description

Lien vers la documentation technique

Cas d'usage

  • Récupération des écritures constituant un paquet de lettrage : avec "codeLettrage" pour récupérer toutes les lignes d'un paquet de lettrage.

  • Récupération d'une écriture précise : avec "ecritureOrigine" pour récupérer l'écriture associée à un document préalablement envoyé au robot comptable et permettre au collaborateur de connaitre l'ensemble des informations de l'écriture dont l'UUID qui peut être utile pour l'utilisation des API publiques telle que la modification de la ventilation analytique.

Procédure

Prérequis :

Un filtre sur le "codeLettrage" ou "ecritureOrigine" sera obligatoire pour affiner la réponse.

Il faut appeler un endpoint :

https://api.cegid.com/loop-api-publiques/API?codeDossier={codeDossier}[&filter][&sort][&skip][&take]

Paramètres du filtre : |Critères principaux|Critères secondaires|Valeurs attendues|Descriptions| | :- | :- | :- |:-| |codeLettrage|| ==null ou !=null ou "UUID"| Lettrage nul ou lettrage différent de nul| |ecritureOrigine||=="UUID"|UUID de l'écriture ||journalCode|=="code du journal"| Code du journal dans l'application| ||refPiece|=="référence de l'écriture"| présent sur l'écriture comptable| ||datePiece| =="AAAA-MM-JJ" ou >="AAAA-MM-JJ| ||compteNumero|=="numéro du compte"|numéro du compte dans le plan comptable|

Exemple de filtre :

  • ecritureOrigine == "0d07ade2-c4fa-4892-90bd-2dbd50d1c6b7"

  • codeLettrage != null && journalCode == "OD"

  • codeLettrage == null && journalCode == "OD"

  • codeLettrage == "8f1b20ba-42cc-4f1c-b52a-0780be300bcb" && journalCode == "OD" && refPiece =="REGLEMENT TVA"

  • codeLettrage != null && datePiece=="2020-04-30T00:00:00Z"

  • codeLettrage != null && datePiece >="2023-04-30T00:00:00Z" && datePiece <="2023-05-30T00:00:00Z"

  • NOTE : le paramètre filter doit utiliser la notation javascript pour l'égalité : soit == ou === ou !=

Route Méthode http Description
/EcritureComptable GET Retourne une liste des Ecritures Comptables

Paramétrage de l’appel

Méthode http pour la demande : GET

Header(s) attendu(s) obligatoire(s) de la demande

Champ Description
Ocp-Apim-Subscription-Key Subscription key
x-apikey API Key & Secret

Paramètres de la demande

Champ Description Obligatoire Exemple
Fields1 Valeur à renseigner : Code Dossier Oui CEGID001
filter Permet de filtrer le resultat Oui codeLettrage == null
sort Trie le résultat Non
skip Saute X dossiers Non
take Retourne X dossiers Non

Code retour

En cas de succès :

Code retour http de la réponse : 200

En cas d'échec :

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour :

L'API retourne une liste d'objet suivant

Champ Sous champ 1 Sous champ 2 Type Description
journalId string($uuid) ID (UUID) Code unique
journalCode string Code journal
journalLibelle string Description journal
etablissementId
objectId string($uuid) ID (UUID) Code unique de l'établissement
revisionId string($uuid) ID (UUID) de la révision de l'établissement
shortDescription string Description de l'établissement
longDescription string Description de l'établissement
numero string Numéro index
periode
objectId string($uuid) ID (UUID) Code unique de la période
revisionId string($uuid) ID (UUID) de révision de la période
shortDescription string Description de la période
longDescription string Description de la période
groupeId string($uuid) ID (UUID) du groupe
datePiece string Date de l'écriture comptable
refPiece string Référence de la pièce présente sur l'écriture comptable
ligneId string($uuid) ID (UUID) de la ligne
compteId string($uuid) ID (UUID) cu compte
compteNumero string numéro du compte, exemple
compteLibelle string libellé du compte
tiersId string($uuid) ID (UUID) du tiers
tiersCode string Code du tiers
tiersNomUsuel string Nom du tiers
tiersType string Type de tiers
reference string Référence du mouvement
libelle string Libellé du mouvement
debit
amount Montant débiteur
currency Devise
currencyAmount Montant devise
currencyRate Taux de change
credit
amount Montant créditeur
currency Devise
currencyAmount Montant devise
currencyRate Taux de change
dateEcheance string($date-time) Date d'échéance
modePaiement string Code du mode de paiement
statutLettrage string Code du statut de lettrage
codeLettrage string Code du statut de lettrage
datePointage string($date-time) Date opération
axeAnaXXX
objectId string($uuid) ID (UUID) de l'axe analytique
revisionId ID (UUID) de la révision
instanceOf string Nom du service : "ecritureAnalytique"
creator string($uuid) ID (UUID) du créateur de l'axe
created string($date-time) Date de création de l'axe
owner string($uuid) ID (UUID) du créateur de l'axe
"updated string($date-time) Date de mise à jour de l'axe
sessionId string($uuid) ID (UUID) de la session
section
objectId string($uuid) ID (UUID) Code unique de la section
revisionId string($uuid) ID (UUID) de révision
shortDescription string Code de la section
longDescription string Description de la section
debit
amount string Montant débit
currency string Devise
currencyAmount string Montant devise
currencyRate string Taux
credit
amount string Montant crébit
currency string Devise
currencyAmount string Montant devise
currencyRate string Taux
shortDescription string Code de la section
longDescription string Code et Description de la section

Exemple de retour

{
    "journalId": "037c2a4a-d9ca-4e67-811d-34a6430398f1",
    "journalCode": "AC",
    "journalLibelle": "ACHAT",
    "etablissementId": {
      "objectId": "fbb534af-620f-4757-a738-3924718bb9aa",
      "revisionId": "0x0000000000014056",
      "shortDescription": [
        "UNCLEPHIL"
      ],
      "longDescription": [
        "UNCLEPHIL"
      ]
    },
    "numero": "1",
    "periode": {
      "objectId": "c0951b65-5771-457c-9ec1-d2c4ae856e72",
      "revisionId": "0x0000000000000B11",
      "shortDescription": [
        "2023"
      ],
      "longDescription": [
        "2023"
      ]
    },
    "groupeId": "f37236c6-53cb-47a3-ac5e-e21cbee86cda",
    "datePiece": "2023-08-15T00:00:00Z",
    "refPiece": "TESTANO8",
    "ligneId": "0c75bb77-24a5-406d-9ff6-039171c54ada",
    "compteId": "30b88c4d-5170-4fc8-8693-68b3354a6156",
    "compteNumero": "60100000",
    "compteLibelle": "Achats de matières premières et fournitures",
    "tiersId": null,
    "tiersCode": "",
    "tiersNomUsuel": "",
    "tiersType": 0,
    "reference": "",
    "libelle": "Fournisseur",
    "debit": {
      "amount": 555,
      "currency": "EUR",
      "currencyAmount": 555,
      "currencyRate": 1
    },
    "credit": {
      "amount": 0,
      "currency": "",
      "currencyAmount": 0,
      "currencyRate": 1
    },
    "dateEcheance": null,
    "modePaiement": 1,
    "statutLettrage": 0,
    "codeLettrage": null,
    "datePointage": null,
    "axeAnaDEL": [
      {
        "objectId": "11c4549f-bd4b-47c0-b2e0-5e644aa89ef2",
        "revisionId": "0x000000000008B295",
        "instanceOf": "ecritureAnalytique",
        "creator": "38bb206f-b181-4b63-8752-067f5bc4f8ff",
        "created": "2024-03-13T09:58:11Z",
        "owner": "38bb206f-b181-4b63-8752-067f5bc4f8ff",
        "updated": "2024-03-13T09:58:11Z",
        "sessionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "section": {
          "objectId": "3891b999-e8eb-4c09-96fa-bc3d784f4bb6",
          "revisionId": "0x0000000000054793",
          "shortDescription": [
            "SECA@DEL"
          ],
          "longDescription": [
            "SECA@DEL",
            "SECTION D'ATTENTE AXEANADEL"
          ]
        },
        "debit": {
          "amount": 555,
          "currency": "EUR",
          "currencyAmount": 555,
          "currencyRate": 1
        },
        "credit": {
          "amount": 0,
          "currency": "EUR",
          "currencyAmount": 0,
          "currencyRate": 1
        },
        "shortDescription": [
          [
            "SECA@DEL"
          ]
        ],
        "longDescription": [
          [
            "SECA@DEL",
            "SECTION D'ATTENTE AXEANADEL"
          ],
          555,
          0
        ]
      }
    ],