Table of Contents

Paramétrage des tiers Clients

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

Ces APIs permettent d'interagir sur le paramétrage des tiers Clients de Cegid Loop :

GET/tiersclient

Cette API retourne la liste du plan des tiers Clients.

Lien vers la documentation technique

Cas d'usage

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

Procédure

Il faut appeler un endpoint permettant de lister les tiers Clients :

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

Route Méthode http Description
/tiersClient GET Retourne la liste des tiers Clients

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 Tiers
type int Tiers Client : 0
prenom string Prénom
nom string Nom
raisonSociale string
nomUsuel string
lettrable boolean
compteContrepartie {...}
SIRET string
telephone string
fax string
email string
siteWeb string
adr {...}
rib [...]
actif boolean
validation sEnum:Array [ 2 ]
soumisTva boolean
numeroTva string
tva {...}
modePaiement Enum:Array[ 11 ]
fact {...}

Exemple de retour

[
  {
    "objectId": "8b9bc406-637a-4623-ba38-036b975ce3be",
    "revisionId": "0x0000000000033A66",
    "description": [
      "CLI0002"
    ],
    "code": "CLI0002",
    "type": 0,
    "nature": 2,
    "prenom": "",
    "nom": "",
    "raisonSociale": "ESSAI client",
    "nomUsuel": "ESSAI client",
    "lettrable": true,
    "compteContrepartie": {
      "objectId": null,
      "description": [
        ""
      ]
    },
    "SIRET": "",
    "telephone": "",
    "fax": "",
    "email": "",
    "siteWeb": "",
    "adr": {
      "adresse1": "",
      "adresse2": "",
      "adresse3": "",
      "ville": "",
      "codePostal": "",
      "pays": {
        "objectId": null,
        "description": [
          ""
        ]
      },
      "geolocalisation": ""
    }
    }
   ]

POST/tiersclient

Cette API crée un tiersClient.

Lien vers la documentation technique

Cas d'usage

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

Procédure

Il faut appeler un endpoint permettant d'ajouter les tiers Clients :

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

Route Méthode http Description
/tiersClient POST Ajoute des tiers Clients

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 tiersClient Oui
type int Tiers Client:0 Oui
nature string Enum:Array [ 2 ]{Personne Physique:1,Personne Morale:2} Oui
prenom string Prénom Oui si personne physique
nom string Nom Oui si personne physique
raisonSociale string Oui si personne morale
nomUsuel string Oui si personne morale
lettrable boolean
compteContrepartie {...}
SIRET string
telephone string
fax string
email string
siteWeb string
adr {...}
rib [...]
actif boolean
validation sEnum:Array [ 2 ]
soumisTva boolean
numeroTva string
tva {...}
modePaiement Enum:Array[ 11 ]
fact {...}

Exemple de body

{
    "code": "Client003",
    "type": 0,
    "nature": 1,
    "prenom": "Client 003",
    "nom": " client",
    "raisonSociale": "",
    "nomUsuel": " client",
    "lettrable": true,
    "compteContrepartie" : {
         "objectId" : null,
         "description" : [
            ""
         ]
      },
    "SIRET": "",
    "telephone": "0478338877",
    "fax": "",
    "email": "monclient@gmail.com",
    "siteWeb": "www.cegid.com",
    "adr": {
      "adresse1": " av des alouette",
      "adresse2": "",
      "adresse3": "",
      "ville": "",
      "codePostal": "",
      "pays": {
        "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "geolocalisation": ""
    },
    "rib" : [ ],
    "actif": true,
    "validation": 1,
    "soumisTva": true,
    "numeroTva": "1",
    "tva": {
      "objectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "modePaiement": 1,
    "fact": {}
  }
]

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 Numéro de Tiers Client Oui
type int Tiers Client : 0
nature string Enum:Array [ 2 ] Personne Physique:1,Personne Morale:2
prenom string Prénom
nom string Nom
raisonSociale string
nomUsuel string
lettrable boolean
compteContrepartie object
SIRET string
telephone string
fax string
email string
siteWeb string
adr object
rib object
actif boolean
validation sEnum:Array [ 2 ]
soumisTva boolean
numeroTva string
tva object
modePaiement Enum:Array[ 11 ]
fact object

Exemple de retour


 [
   {
      "revisionId" : "0x000000000001BD59",
      "objectId" : "06492d78-46a2-44e2-b110-9005a7785db2",
      "code" : "Client003",
      "type" : 0,
      "nature" : 1,
      "prenom" : "Client 003",
      "nom" : " client",
      "raisonSociale" : "",
      "nomUsuel" : " client",
      "lettrable" : true,
      "compteContrepartie" : {
         "objectId" : null
      },
      "SIRET" : "",
      "telephone" : "0478338877",
      "fax" : "",
      "email" : "monclient@gmail.com",
      "siteWeb" : "www.cegid.com",
      "rib" : [ ],
      "actif" : true,
      "validation" : 1,
      "soumisTva" : true,
      "numeroTva" : "1",
      "tva" : {
         "objectId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "modePaiement" : 1,
      "created" : "2022-06-28T12:41:30Z",
      "updated" : "2022-06-28T12:41:30Z"
   }
]

PUT/tiersclient

Cette API modifie les tiers Clients d'un dossier client

Lien vers la documentation technique

Cas d'usage

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

Points d'attention

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

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

Route Méthode http Description
/tiersClient PUT Modifie des tiers Clients

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" : "815e7856-3182-4b28-8bb1-25eca3f2ebfd",
      "revisionId" : "0x000000000001BD60",
      "code" : "Client003",
      "type" : 0,
      "nature" : 1,
      "prenom" : "Client 003",
      "nom" : "Update  client",
      "raisonSociale" : "",
      "nomUsuel" : " client",
      "lettrable" : true,
      "compteContrepartie" : {
         "objectId" : null
      },
      "SIRET" : "",
      "telephone" : "0478338877",
      "fax" : "",
      "email" : "monclient@gmail.com",
      "siteWeb" : "www.cegid.com",
      "rib" : [ ],
      "actif" : true,
      "validation" : 1,
      "soumisTva" : true,
      "numeroTva" : "string",
      "tva" : {
         "objectId" : null
      },
      "modePaiement" : 1,
      "updated" : "2022-06-28T13:35:21Z"
   }
]

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 Numéro de tiersClient Oui
type int Tiers client : 0
nature string Enum:Array [ 2 ]
prenom string first name
nom string name
raisonSociale string
nomUsuel string
lettrable boolean
compteContrepartie {...}
SIRET string
telephone string
fax string
email string
siteWeb string
adr {...}
rib [...]
actif boolean
validation sEnum:Array [ 2 ]
soumisTva boolean
numeroTva string
tva {...}
modePaiement Enum:Array[ 11 ]
fact {...}

Exemple de retour


[[
   {
      "objectId" : "815e7856-3182-4b28-8bb1-25eca3f2ebfd",
      "revisionId" : "0x000000000001BD60",
      "code" : "Client003",
      "type" : 0,
      "nature" : 1,
      "prenom" : "Client 003",
      "nom" : "Update  client",
      "raisonSociale" : "",
      "nomUsuel" : " client",
      "lettrable" : true,
      "compteContrepartie" : {
         "objectId" : null
      },
      "SIRET" : "",
      "telephone" : "0478338877",
      "fax" : "",
      "email" : "monclient@gmail.com",
      "siteWeb" : "www.cegid.com",
      "rib" : [ ],
      "actif" : true,
      "validation" : 1,
      "soumisTva" : true,
      "numeroTva" : "string",
      "tva" : {
         "objectId" : null
      },
      "modePaiement" : 1,
      "updated" : "2022-06-28T13:35:21Z"
   }
]

DEL/tiersclient

Cette API supprime un tiersClient

Lien vers la documentation technique

Cas d'usage

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

Points d'attention

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

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

Route Méthode http Description
/tiersClient DEL Suppression des tiers Clients

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