Table of Contents

Plan des comptes

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

Ces API permettent d'interagir sur le paramétrage des comptes de Cegid Loop :

GET/compte

Cette API retourne la liste du plan des comptes généraux.

Lien vers la documentation technique

Cas d'usage

  • Cette API permet de retourner toute la liste des comptes généraux d'un dossier client au sein du cabinet.
  • Elle permet également de retourner un échantillon de comptes grâce à ses paramètres (Cf. § Paramètres de la demande).

Procédure

Il faut appeler un endpoint permettant de lister les comptes :

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

Route Méthode http Description
/compte GET Retourne la liste des comptes

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
codeDossier Valeur à renseigner : cabinet Oui
filter Permet de filtrer le resultat Non
sort Trie le résultat Non
skip Saute X dossiers Non
take Retourne X dossiers Non
select Retourne seulement les champs mentionnés Non

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas de d'échec

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour

L'API retourne une liste d'objet dossier au format suivant :

Champ Type Description
objectId string($uuid) ID (UUID) Code unique
revisionId string($uuid) ID (UUID) de la révision
numero string Numéro de compte
libelle string Libelllé du compte
type string 1-7
collectif boolean false or true
lettrable boolean false or true
pointable boolean false or true
centralisable boolean false or true
analytique boolean false or true
ferme boolean fermer
comptecontrepartie string contrepertie automatique
compteBanque string compte de banque
tva string TVA

Exemple de retour

[
{
    "objectId": "0f57181f-379e-44f5-9470-64680ed50bb5",
    "revisionId": "0x0000000000017ED5",
    "description": [
      "60100000"
    ],
    "numero": "60100000",
    "libelle": "Achats non stockés de matières et fournitures",
    "type": 6,
    "collectif": false,
    "lettrable": false,
    "pointable": false,
    "centralisable": false,
    "analytique": true,
    "ferme": false,
    "compteContrepartie": {
      "objectId": null,
      "description": [
        ""
      ]
    }
   ]

POST/compte

Cette API crée un compte.

Lien vers la documentation technique

Cas d'usage

  • Cette API permet la création de compte au niveau des dossiers du cabinet par une application externe.

Procédure

Il faut appeler un endpoint permettant d'ajouter les comptes :

https://api.cegid.com/loop-api-publiques/compte?codeDossier={codeDossier}

Route Méthode http Description
/compte POST Ajoute des comptes

Paramétrage de l’appel

Méthode http pour la demande : POST

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
codeDossier Valeur à renseigner : Code du dossier Oui

Body de la demande

Champ Type Description Obligatoire
numero string Numéro de compte Oui
libelle string Libelllé du compte Oui
type string 1-7
collectif boolean false or true
lettrable boolean false or true
pointable boolean false or true
centralisable boolean false or true
analytique boolean false or true
ferme boolean fermer
comptecontrepartie string contrepertie automatique
compteBanque string compte de banque
tva string TVA

| Exemple de body

[
  {
    "numero": "string",
    "libelle": "string",
    "type": "1",
    "collectif": true,
    "lettrable": true,
    "pointable": true,
    "centralisable": true,
    "analytique": true,
    "ferme": true,
    "compteContrepartie": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "compteBanque": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "tva": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  }
]

Points d'attention sur la structure du JSON

  • Vous ne pouvez pas modifier les propriétés d'un élément 'enfant'.
  • Vous pouvez ajouter, modifier ou supprimer des éléments 'enfant' en incluant leur 'objectId', toutes les autres propriétés seront ignorées.
  • Cela s'applique également aux éléments « enfants » dans un tableau.

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas de d'échec

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour

Champ Type Description Obligatoire
numero string Numéro de compte Oui
libelle string Libelllé du compte Oui
type string 1-7
collectif boolean false or true
lettrable boolean false or true
pointable boolean false or true
centralisable boolean false or true
analytique boolean false or true
ferme boolean fermer
comptecontrepartie string contrepertie automatique
compteBanque string compte de banque
tva string TVA

Exemple de retour


 [
   {
      "revisionId" : "0x000000000006DE18",
      "objectId" : "d6504a33-a758-4e73-ad77-915d3b3447d2",
      "numero" : "6011200",
      "libelle" : "ACHATS DIVERS",
      "type" : 6,
      "collectif" : false,
      "lettrable" : false,
      "pointable" : false,
      "centralisable" : false,
      "analytique" : true,
      "ferme" : false,
      "compteContrepartie" : {
         "objectId" : null
      },
      "compteBanque" : {
         "objectId" : null
      },
      "tva" : {
         "objectId" : null
      },
      "created" : "2022-05-16T14:31:45Z",
      "updated" : "2022-05-16T14:31:45Z"
   }
]

PUT/compte

Cette API modifie un dossier client

Lien vers la documentation technique

Cas d'usage

  • Cette API permet de modifier les informations des comptes dans Cegid Loop depuis une application externe.

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/compte afin de recupérer les champs obligatoires objectId et revisionId.

Assurez-vous d'avoir la dernière version de la valeur de revisionId.

En effet, la valeur de ce champ est incrémentée à chaque mise à jour.

Cette API permet de modifier la valeur d'un champ et pas de la supprimer. Envoyer une valeur à vide ne supprimera pas la valeur précedente.

Procédure

Il faut appeler un endpoint permettant de modifier les comptes :

https://api.cegid.com/loop-api-publiques/compte?codeDossier={codeDossier}

Route Méthode http Description
/compte PUT Modifie des comptes

Paramétrage de l’appel

Méthode http pour la demande : PUT

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
codeDossier Valeur à renseigner : cabinet Oui

Body de la demande

Exemple de body

[{
    "objectId": "4d3d91c0-1866-4444-ac31-05bfb9e55ebd",
    "revisionId": "0x00000000000F2AEC",
    "description": ["51100000"],
    "numero": "51100000",
    "libelle": "Compte modifié",
    "type": 1,
    "collectif": false,
    "lettrable": false,
    "pointable": false,
    "centralisable": false,
    "analytique": false,
    "ferme": false
}]

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas de d'échec

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour

Champ Type Description Obligatoire
numero string Numéro de compte Oui
libelle string Libelllé du compte Oui
type string 1-7
collectif boolean false or true
lettrable boolean false or true
pointable boolean false or true
centralisable boolean false or true
analytique boolean false or true
ferme boolean fermer

Exemple de retour

[{
    "objectId": "4d3d91c0-1866-4444-ac31-05bfb9e55ebd",
    "revisionId": "0x00000000000FA7E0",
    "numero": "51100000",
    "libelle": "Compte modifié",
    "type": 1,
    "collectif": false,
    "lettrable": false,
    "pointable": false,
    "centralisable": false,
    "analytique": false,
    "ferme": false,
    "updated": "2024-05-28T07:19:14Z"
}]

DEL/compte

Cette API supprime un compte

Lien vers la documentation technique

Cas d'usage

  • Cette API permet de supprimer des comptes dans Cegid Loop depuis une application externe

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/compte afin de recupérer les champs obligatoires objectId et revisionId.

Assurez-vous d'avoir la dernière version de la valeur de revisionId.

En effet, la valeur de ce champ est incrémentée à chaque mise à jour.

Procédure

Il faut appeler un endpoint permettant de supprimer les comptes :

https://api.cegid.com/loop-api-publiques/compte?codeDossier={codeDossier}

Route Méthode http Description
/compte DEL Suppression des comptes

Paramétrage de l’appel

Méthode http pour la demande : DEL

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
codeDossier Valeur à renseigner : code du dossier Oui

Body de la demande

Champ Type Description Obligatoire
objectId string($uuid) ID (UUID) Code unique Oui
revisionId string($uuid) ID (UUID) de la révision Oui

Exemple de body

[
  {
    "revisionId": "0x000000000006DE0F",
    "objectId": "95e17efe-bb83-4d19-9424-7d5d2383982a"
  }
]

Code retour

En cas de succès

Code retour http de la réponse : 200

En cas de d'échec

Lien vers la liste des codes d'erreur

Structure du retour

Format du retour

Champ Type Description
objectId string($uuid) ID (UUID) Code unique
revisionId string($uuid) ID (UUID) de la révision

Example de retour

	
Response body
Download
[
  {
    "revisionId": "0x000000000006DE0F",
    "objectId": "95e17efe-bb83-4d19-9424-7d5d2383982a"
  }
]