Table of Contents

Création et modification d'un client

Ce scénario illustre comment créer un nouveau client dans Cegid Expert, puis comment modifier certaines de ses informations.

Processus global

Le processus de création et de modification d'un client dans Cegid Expert se déroule en plusieurs étapes.

  1. Vérifier l'existence du client
  2. Créer le client s'il n'existe pas A. Vérifier l'existence de la personne associée dans l'annuaire B. Créer la personne associée dans l'annuaire si nécessaire C. Créer le client depuis la personne de l'annuaire
  3. Modifier les informations du client si nécessaire
flowchart LR
A((Début)):::step --> B[ViewCustomersUsingFilters]
B--> C{Existe}
C -->|Oui| I
C -->|Non| D[ViewAnnuariesUsingFilters] --> E
E{Existe}
E -->|Oui| G
E -->|Non| F[CreateAnnuary] --> G
G[/Annuary Id/]:::result
G --> H[CreateCustomerFromAnnuary] --> I 
I[/Id/]:::result
I --> J[UpdateSingleCustomer] --> K((Fin)):::step
classDef default fill:#ffffff,color:#0046ff,stroke:#0046ff
classDef result fill:#0046ff,color:#ffffff,stroke:#0046ff
classDef step fill:#ffffff,color:#FF5C35,stroke:#FF5C35

Étape 1 : Vérifier l'existence du client

La première étape consiste à vérifier si le client que vous souhaitez créer existe déjà.

Note

Cette étape peut être omise si vous êtes certain que le client n'existe pas.

Utiliser l'API de consultation des clients.
Il s'agit de la méthode ViewCustomersUsingFilters de l'API CustomerConsultationWebService.

Cette méthode permet de rechercher des clients en utilisant des filtres.
La recherche se fait idéalement via le SIRET du client, car cette information est unique, ou par son nom.

Ci-dessous, un exemple de corps de requête JSON pour rechercher un client par son nom et son prénom.

{
   "page": {
       "pageIndex": 1,
       "pageSize": 10
   },
   "filters": [
       {
           "property": 2,
           "constantValue": "DOE",
           "comparisonOperateur": 1,
           "inversion": false,
           "logicOperator": 1
       },
       {
           "property": 3,
           "constantValue": "John",
           "comparisonOperateur": 1,
           "inversion": false,
           "logicOperator": 1
       }
   ]
}

Si le client existe, l'API retournera, entre autres, son identifiant unique.
Le retour avec la requête effectuée ressemblera à ceci :

{
   "page": {
       "pageCount": 1
   },
   "customers": [
       {
           "id": "JDO001",
           "shortName": "JOHN DOE",
           "closed": false
       }
   ]
}

Ici, le client existe déjà et son identifiant est JDO001.
Si aucun client ne correspond aux filtres de recherche, la liste des clients sera vide :

{
	"page": {
		"pageCount": 0
	},
	"customers": []
}
Important

Ce n'est pas parce que la liste est vide que le client n'existe pas.
Pour vous assurer de retrouver un client, veillez à toujours renseigner des informations qui permettent de le retrouver facilement.

Note

Pour plus de précisions, veuillez consulter la documentation spécifique à cette API.
https://developers.cegid.com/api-details#api=cpa-expert-coresalesadministration&operation=CustomerConsultation-post-customerconsultationwebservice-viewcustomersusingfilters

Étape 2 : Rechercher la personne liée au client

Chaque client dans Cegid Expert est associé à une personne dans l'annuaire.
Avant de créer un client, il est donc nécessaire de s'assurer que la personne associée existe dans l'annuaire.

Note

Cette étape peut être omise si le client existe déjà ou si vous connaissez déjà l'identifiant de la personne qui sera liée au client à créer.

Vous pouvez vous référer au scénario "Création et modification d'une personne de l'annuaire" pour vérifier l'existence de la personne ou la créer et la modifier au besoin, et au final, obtenir son identifiant.

Étape 3 : Créer le client à partir de la personne de l'annuaire

Si le client n'existe pas, vous pouvez le créer en utilisant l'API de création des clients.

Note

Cette étape peut être omise si le client existe déjà.

Il s'agit de la méthode CreateCustomerFromAnnuary de l'API CustomerInsertionWebService.
Cette méthode nécessite l'identifiant de la personne de l'annuaire à laquelle le client sera lié.
En plus de l'identifiant de la personne, vous devez également fournir d'autres informations pour le client, telles que son futur identifiant, son compte auxiliaire, son compte collectif et son mois de clôture.

Ci-dessous le corps de la requête JSON utilisée pour créer le client JOHN DOE à partir de l'identifiant de la personne récupérée dans le scénario "Création et modification d'une personne de l'annuaire".

{
 "annuaryId": "153913ab-1022-4e02-9912-d99fbe6f1248",
 "customer": {
   "id": "JDO001",
   "subsidiaryAccount": "JDO001",
   "collectiveAccount": "411000",
   "closeMonth": 12
 }
}
Note

Pour plus de précisions, veuillez consulter la documentation spécifique à cette API.
https://developers.cegid.com/api-details#api=cpa-expert-coresalesadministration&operation=CustomerInsertion-post-customerinsertionwebservice-createcustomerfromannuary

Si la création du client est réussie, l'API retournera la valeur true.

Étape 4 : Modifier les informations du client

Si le client existe déjà ou après l'avoir créé, vous pouvez modifier certaines de ses informations en utilisant l'API de mise à jour des clients.
Il s'agit de la méthode UpdateSingleCustomer de l'API CustomerModificationWebService.

Important

Veuillez vous référer aux principes de mise à jour des données afin d'éviter de faire des erreurs lors de l'appel à cette méthode.

Le JSON ci-dessous va modifier les données de communication, les textes personnalisables, les dates personnalisables et les montants personnalisables du client JOHN DOE.

{
   "Id": "JDO001",
   "communication": {
       "phone1": "01023456789",
       "phone2": "",
       "phone3": "",
       "email": "jdoe@gmail.com",
       "webSite": ""
   },
   "customText": {
       "customText01": "Test 1",
       "customText02": "Test 2",
       "customText03": "Test 3"
   },
   "customDate": {
       "customDate01": "1984-12-24T11:00:00",
       "customDate02": "1900-01-01T00:00:00",
       "customDate03": "1900-01-01T00:00:00"
   },
   "customNumeric": {
       "customNumeric01": 10,
       "customNumeric02": 3.14,
       "customNumeric03": 9.99
   }
}
Note

Pour plus de précisions, veuillez consulter la documentation spécifique à cette API.
https://developers.cegid.com/api-details#api=cpa-expert-coresalesadministration&operation=CustomerModification-post-customermodificationwebservice-updatesinglecustomer