Table of Contents

Paramétrage des journaux

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

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

GET/journal

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

Lien vers la documentation technique

Cas d'usage

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

Procédure

Il faut appeler un endpoint permettant de lister les journaux :

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

Route Méthode http Description
/journal GET Retourne la liste des journaux

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 : Code dossier 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
code string code du journal
libelle string Libelllé du journal
type string Type de Journal (Achat:1,OD:2,A-Nouveau:3,Banque:4,Caisse:5,Ecart de Change:6,Régularisation:7,Vente:8)
compteContrepartie object Contrepartie
typeContrepartie boolean Type de Contrepartie {Libre:1,A l'écriture:2,Pied de journal:3}
repriseDateOp boolean Mention date opération
bordereau boolean false or true
ferme boolean Fermé
accesclient boolean Accès client : false or true
saisielibelle int Libellé par defaut {Compte:1,Pièce:2}

Exemple de retour

[
{
    "objectId": "976aa4f3-f6e8-4164-a960-0990bd558682",
    "revisionId": "0x0000000000004678",
    "description": [
      "ACH"
    ],
    "code": "ACH",
    "libelle": "Journal achat",
    "type": 1,
    "compteContrepartie": {
      "objectId": null,
      "description": [
        ""
      ]
    },
    "typeContrepartie": 1,
    "repriseDateOp": false,
    "bordereau": true,
    "ferme": false,
    "accesClient": false,
    "saisieLibelle": 2
  }
   ]

POST/journal

Cette API crée un journal.

Lien vers la documentation technique

Cas d'usage

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

Procédure

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

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

Route Méthode http Description
/journal POST Ajoute des journaux

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
code string code du journal Oui
libelle string Libelllé du journal Oui
type string Type de Journal (Achat:1,OD:2,A-Nouveau:3,Banque:4,Caisse:5,Ecart de Change:6,Régularisation:7,Vente:8)
compteContrepartie object Contrepartie
typeContrepartie boolean Type de Contrepartie {Libre:1,A l'écriture:2,Pied de journal:3}
repriseDateOp boolean Mention date opération
bordereau boolean false or true
ferme boolean Fermé
accesclient boolean Accès client : false or true
saisielibelle int Libellé par defaut {Compte:1,Pièce:2}

Exemple de body

[
  {
    "code": "AC1",
    "libelle": "ACHAT",
    "type": 1,
   "compteContrepartie": {
      "objectId": null,
      "description": [
        ""
      ]
    },
    "typeContrepartie": 1,
    "repriseDateOp": true,
    "bordereau": true,
    "ferme": true,
    "accesClient": true,
    "saisieLibelle": 1
  }
]

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 journal Oui
libelle string Libelllé du journal Oui
type string Type de Journal (Achat:1,OD:2,A-Nouveau:3,Banque:4,Caisse:5,Ecart de Change:6,Régularisation:7,Vente:8)
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
journalcontrepartie string contrepertie automatique
journalBanque string journal 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,
      "journalContrepartie" : {
         "objectId" : null
      },
      "journalBanque" : {
         "objectId" : null
      },
      "tva" : {
         "objectId" : null
      },
      "created" : "2022-05-16T14:31:45Z",
      "updated" : "2022-05-16T14:31:45Z"
   }
]

PUT/journal

Cette API modifie les journaux d'un dossier client

Lien vers la documentation technique

Cas d'usage

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

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/journal 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 journaux :

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

Route Méthode http Description
/journal PUT Modifie des journaux

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 : code dossier Oui

Body de la demande

Exemple de body

[{
    "objectId": "4d3d91c0-1866-4444-ac31-05bfb9e55ebd",
    "revisionId": "0x00000000000F2AEC",
    "description": ["51100000"],
    "numero": "51100000",
    "libelle": "journal 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 journal Oui
libelle string Libelllé du journal Oui
type string Type de Journal (Achat:1,OD:2,A-Nouveau:3,Banque:4,Caisse:5,Ecart de Change:6,Régularisation:7,Vente:8)
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": "journal modifié",
    "type": 1,
    "collectif": false,
    "lettrable": false,
    "pointable": false,
    "centralisable": false,
    "analytique": false,
    "ferme": false,
    "updated": "2024-05-28T07:19:14Z"
}]

DEL/journal

Cette API supprime un journal

Lien vers la documentation technique

Cas d'usage

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

Points d'attention

Avant d'appeler cette API, utilisez l'API GET/journal 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 journaux :

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

Route Méthode http Description
/journal DEL Suppression des journaux

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"
  }
]