Table of Contents

Paramétrage des sections

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

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

GET/section

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

Lien vers la documentation technique

Cas d'usage

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

Procédure

Il faut appeler un endpoint permettant de lister les sections :

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

Route Méthode http Description
/section GET Retourne la liste des sections

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 section
description string Libelllé du section
ferme boolean Fermé
axe object Description de l'axe

Exemple de retour

[
    {
    "objectId": "37f8728f-af7a-46e7-b690-668e810208ae",
    "revisionId": "0x0000000000033A12",
    "description": "SECTION D'ATTENTE AXEANAAXE",
    "code": "SECA@AXE",
    "ferme": false,
    "axe": {
      "objectId": "352ebf42-ba97-43bb-a786-649ef1d4ba28",
      "description": [
        "Axe 1"
      ]
    }
  }
   ]

POST/section

Cette API crée un section.

Lien vers la documentation technique

Cas d'usage

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

Procédure

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

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

Route Méthode http Description
/section POST Ajoute des sections

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 section Oui
description string Libelllé du section Oui
type string Type de section (Achat:1,OD:2,A-Nouveau:3,Banque:4,Caisse:5,Ecart de Change:6,
ferme boolean Fermé
axe object Description de l'axe

Exemple de body

Attention, avant d'ajouter la section il est nécessaire d'avoir par get de l'axe in order objectId de l'axe

[
  {
    "code": "SECTIONDOC",
    "description": "Documentation",
    "ferme": true,
    "axe": {
      "objectId": "352ebf42-ba97-43bb-a786-649ef1d4ba28"
    }
  }
]

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
code string code du section Oui
description string Libelllé du section Oui
type string Type de section (Achat:1,OD:2,A-Nouveau:3,Banque:4,Caisse:5,Ecart de Change:6,
ferme boolean Fermé
axe object Description de l'axe

Exemple de retour


  {
    "revisionId": "0x0000000000014051",
    "objectId": "df5cc52f-5347-4618-80f5-6adbb1116c16",
    "code": "SECTIONDOC",
    "description": "Documentation",
    "ferme": true,
    "axe": {
      "objectId": "352ebf42-ba97-43bb-a786-649ef1d4ba28"
    },
    "created": "2022-04-01T16:53:28Z",
    "updated": "2022-04-01T16:53:28Z"
  }
]

PUT/section

Cette API modifie les sections d'un dossier client

Lien vers la documentation technique

Cas d'usage

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

Points d'attention

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

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

Route Méthode http Description
/section PUT Modifie des sections

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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "revisionId": "string",
    "code": "string",
    "description": "string",
    "ferme": true,
    "axe": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  }
]

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
code string code du section Oui
description string Libelllé du section Oui
type string Type de section (Achat:1,OD:2,A-Nouveau:3,Banque:4,Caisse:5,Ecart de Change:6,
ferme boolean Fermé
axe object Description de l'axe

Exemple de retour


[
  {
    "objectId": "37f8728f-af7a-46e7-b690-668e810208ae",
    "revisionId": "0x000000000006DE0E",
    "description": "SECTION D'ATTENTE AXEANAAXE",
    "code": "SECA@AXE",
    "ferme": false,
    "axe": {
      "objectId": "352ebf42-ba97-43bb-a786-649ef1d4ba28"
    },
    "updated": "2022-05-16T07:24:21Z"
  }
]

DEL/section

Cette API supprime un section

Lien vers la documentation technique

Cas d'usage

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

Points d'attention

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

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

Route Méthode http Description
/section DEL Suppression des sections

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