Résumé
Manipulation de l'entité Customer (Clients) en lecture/écriture/suppression via un objet métier depuis une application externe.
Tables
Les tables utilisées sont :
...
sw_data_customerextension : Table des indicateurs tiers
sw_data_customeruser : Table des utilisateurs liés aux tiers
Critères d'activation
WHK_Customer est défini dans la gestion des webhooks du studio.
Règles métier
verb: PUT
Type de tiers
Le type de tiers est mis par défaut à ‘Client' (generictype_ID_customerType = ‘CTC’) si non fourni lors d’une création
Les types de tiers gérés sont CTC : Client et CTE : Temporaire
Est un particulier
A la fin de la création/modification d’un client si celui-ci est un particulier (sw_data_customer.isIndividual = 1), il y aura automatiquement :
création automatique d’un nouveau contact rattaché au client en tant que contact principal (avec sw_data_customercontact.mainContact mis à 1) s’il n’existe pas encore
modification automatique du contact principal s’il existe déjà (sw_data_customercontact.mainContact = 1)
Fonctionnement
settings parameters
Bloc de code | ||
---|---|---|
| ||
"settings": { "getIndicators": "1" // pour le verb GET et LIST permet de retourner les informations des indicateurs clients } |
...
Bloc de code | ||
---|---|---|
| ||
{ "customer": { "codecustomer": "C0000001", /* Code globalement unique du client (Varchar (255))*/ "name": "ENTREPRISE DIJON GUICHARD", /* Nom du client (Varchar (255))*/ "address1": "33 Avenue du Drapeau", /* Adresse 1 (Varchar (255))*/ "address2": null, /* Adresse 2 (Varchar (255))*/ "address3": null, /* Adresse 3 (Varchar (255))*/ "postalCode": "21000", /* Code postal (Varchar (16))*/ "city": "DIJON", /* Ville (Varchar (64))*/ "phoneNumber": "03 90 11 22 33", /* N° de téléphone (Varchar (64))*/ "faxNumber": "03 90 11 22 44", /* N° de télécopie (Varchar (64))*/ "mobilePhoneNumber": "06 90 11 22 33", /* N° de portable (Varchar (64))*/ "email": "contact@guichard.com", /* Email (Varchar (255))*/ "website": "<https://www.guichard.com",> /* Site internet (Varchar (255))*/ "siretNumber": null, /* N° siret (Varchar (40))*/ "generictype_ID_customerType": "CUSTOMER_TYPE-CTC", /* Code type de tiers. Mettre CUSTOMER_TYPE-CTC pour un client. (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = CUSTOMER_TYPE). Si non transmis, initialisé par défaut à CTC.*/ "generictype_ID_country": "COUNTRY-FR", /* Code pays (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = COUNTRY)*/ "baseuser_ID": "GRO-OUES", /* Code utilisateur (ForeignKey () - sw_data_baseuser.codebaseuser)*/ "deliveryDays": "1A;1B;2A;2B;3A;3B;4A;4B;5A;5B;", /* Jours de livraison (Varchar (255))*/ "openingDays": "1A;1B;2A;2B;3A;3B;4A;4B;5A;5B;", /* Jours d'ouverture (Varchar (255))*/ "comment": "", /* Commentaires (Text (65535))*/ "blocked": "0", /* Client bloqué (Valeurs possibles : 0,1) (Bool ())*/ "blockedComment": "", /* Commentaires client bloqué (Text (65535))*/ "message": "", /* Message (Text (65535))*/ "vacationStart": "", /* Début des congés (Date ())*/ "vacationEnd": "", /* Fin des congés (Date ())*/ "underSurveillance": "0", /* Client sous surveillance (Valeurs possibles : 0,1) (Bool ())*/ "generictype_ID_customerFamily": "CUSTOMER_FAMILY-GROSARTG", /* Code famille client (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = CUSTOMER_FAMILY)*/ "generictype_ID_paymentMean": "PAYMENT_MEAN-N30", /* Code mode de règlement (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = PAYMENT_MEAN)*/ "generictype_ID_deliveryMode": "DELIVERY_MODE-CHRO", /* Code mode de livraison (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = DELIVERY_MODE)*/ "pricecategory_ID": "GR", /* Code catégorie tarifaire (ForeignKey () - sw_data_pricecategory.codepricecategory)*/ "discountRate": "0.00", /* Taux de remise (Double ())*/ "authorizedCredit": "0", /* Encours autorisé (Valeurs possibles : 0,1) (Bool ())*/ "apeCode": "516K", /* Code APE (Varchar (64))*/ "vatIntra": null, /* TVA intracommunautaire (Varchar (64))*/ "legalStatus": "Société Anonyme avec Directoire", /* Forme juridique (Varchar (64))*/ "workforce": "23", /* Effectif (Int ())*/ "customer_ID_paying": null, /* Code client payeur (ForeignKey () - sw_data_customer.codecustomer)*/ "generictype_ID_taxCode": "TAX_CUSTOMER-0", /* Code TVA client (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = TAX_CUSTOMER)*/ "risk": "1", /* Risque (Varchar (64))*/ "language": "FR", /* Code langue (ForeignKey () - sw_sys_language.codelanguage)*/ "accountNumber": "C0000001", /* N° de compte principal (Varchar (64))*/ "currency_ID": "EUR", /* Code devise ForeignKey () - sw_data_currency.codecurrency)*/ "generictype_ID_province": null, /* Code province (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = PROVINCE)*/ "generictype_ID_civility": "CIVILITY-SA", /* Code civilité (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = CIVILITY)*/ "customergroup_ID": "", /* Code groupe client (ForeignKey () - sw_data_customergroup.codecustomergroup)*/ "confirmationFax": "03 90 11 22 44", /* N° de télécopie de confirmation (Varchar (64))*/ "confirmationEmail": "contact@guichard.com", /* Email de confirmation (Varchar (255))*/ "generictype_ID_accountingCategory": "", /* Code catégorie comptable (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = ACCOUNTING_CATEGORY)*/ "generictype_ID_customerPotential": "CUSTOMER_POTENTIAL-B", /* Code potentiel client (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = CUSTOMER_POTENTIAL)*/ "generictype_ID_role": "", /* Code rôle (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = ROLE)*/ "unused": "0", /* Client inactif (Valeurs possibles : 0,1) (Bool ())*/ "generictype_ID_referencing": "PRODUCT_REFERENCING-NOTSTRICT", /* Code mode de référencement articles (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = PRODUCT_REFERENCING)*/ "generictype_ID_distribution": "DISTRIBUTION-SELF", /* Code type de distribution (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = DISTRIBUTION)*/ "generictype_ID_market": "MARKET-BIG", /* Code type de magasin (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = MARKET)*/ "area": "", /* Superficie (Double ())*/ "baseculture_ID": "FR-FR", /* Code culture (ForeignKey () - sw_data_baseculture.codebaseculture)*/ "baseuser_ID_favoriteTechnician": "TECH-01", /* Code technicien préféré (ForeignKey () - sw_data_baseuser.codebaseuser)*/ "branchoffice_ID": "SXB", /* Code de l'agence de rattachement (ForeignKey () - sw_data_branchoffice.codebranchoffice)*/ "emailFormat": "", /* Format d'email (Varchar (255))*/ "isIndividual": "0", /* Client est un particulier (Valeurs possibles : 0,1) (Bool ())*/ "skype": "contact@guichard.com", /* Skype (Varchar (255))*/ "facebook": "https://www.facebook.com/guichard/", /* Facebook (Varchar (255))*/ "twitter": "https://twitter.com/guichard", /* Twitter (Varchar (255))*/ "youtube": "https://www.youtube.com/watch?v=6jGbnEwQJ54", /* YouTube (Varchar (255))*/ "linkedin": "https://www.linkedin.com/company/guichard", /* LinkedIn(Varchar (255))*/ "activity": "", /* Activité (Text (65535))*/ "internalcodecustomer": null, /* CodeCustomer original de weavy s'il y a eu transcodage (Varchar (255)) */ /* Champs supplémentaires en surcharge DIVINF */ "divinf_t035_ID": "RG", /* Code remise (ForeignKey () - sw_data_divinf_t035.codedivinf_t035)*/ "divinf_t072_ID_promotacod": "", /* Code promotion (ForeignKey () - sw_data_divinf_t072.codedivinf_t072)*/ "divinf_t072_ID_promoremcod": "", /* Code remise promotion (ForeignKey () - sw_data_divinf_t072.codedivinf_t072)*/ "divinf_t001_ID_tafam": "GMS", /* Code famille de tarification (ForeignKey () - sw_data_divinf_t001.codedivinf_t001)*/ "divinf_t001_ID_tafamx": "", /* Code famille de tarification exceptionnelle (ForeignKey () - sw_data_divinf_t001.codedivinf_t001)*/ "divinf_t002_ID_refam": "", /* Code classe de remise (ForeignKey () - sw_data_divinf_t002.codedivinf_t002)*/ "divinf_t002_ID_refamx": "", /* Code classe de remise exceptionnelle (ForeignKey () - sw_data_divinf_t002.codedivinf_t002)*/ "divinf_rem1": "0.00", /* Remise 1 (Double ())*/ "divinf_rem2": "0.00", /* Remise 2 (Double ())*/ "divinf_rem3": "0.00", /* Remise 3 (Double ())*/ "divinf_remtyp1": "2", /* Type de remise 1 (Valeurs possibles : 1 (Cumulé), 2 (Succesif), 3 (Différé PB), 4 (Différé PN)) (Int ())*/ "divinf_remtyp2": "2", /* Type de remise 2 (Valeurs possibles : 1 (Cumulé), 2 (Succesif), 3 (Différé PB), 4 (Différé PN)) (Int ())*/ "divinf_remtyp3": "2", /* Type de remise 3 (Valeurs possibles : 1 (Cumulé), 2 (Succesif), 3 (Différé PB), 4 (Différé PN)) (Int ())*/ "divinf_pricecategory_ID_tarCod": "", /* Code tarif TTC (ForeignKey () - sw_data_pricecategory.codepricecategory)*/ "divinf_dev": "EUR", /* Code devise (Varchar (64))*/ "divinf_rftctrcod": "1", /* Tiers soumis au référencement (Valeurs possibles : 1 (Non), 2 (Oui)) (Int ())*/ /* Optionnel : pour mettre à jour les champs dynamiques selon paramétrage */ /* Exemple 1 : */ "dynamicfields": [{ "fieldname": "CLI40", "fieldvalue": "7" }, { "fieldname": "CLI50", "fieldvalue": "8" }, { ... }] /* Exemple 2 : */ /* A partir de la version SUMMER'215.4, le mappage direct des champs dynamiques est possible en utilisant le nom du champ en bdd */ "v_CLI40": "7", "v_CLI50": "8", ... }, "customeruser": [ { "codecustomeruser": "C0000001-95", /* Code globalement unique de l'utilisateur lié au client (Varchar (255))*/ "customer_ID": "C0000001", /* Code tiers. Optionnel : reprendre le code client du bloc json "customer", si non fourni reprend automatiquement le code client (ForeignKey () - sw_data_customer.codecustomer)*/ "baseuser_ID": "95", /* Code utilisateur (ForeignKey () - sw_data_baseuser.codebaseuser)*/ "generictype_ID_category": "CUSTOMERUSER_LINK-1" /* Code catégorie (ForeignKey () - sw_data_generictype.codegenerictype avec datatype = CUSTOMERUSER-LINK)*/ }, { "codecustomeruser": "C0000001-TECH1", "customer_ID": "C0000001", "baseuser_ID": "TECH1", "generictype_ID_category": "CUSTOMERUSER_LINK-2" }] } |
...
Pour les verb LIST et GET, on ne renvoie pas les tiers de type "Temporaire"
verb: DELETE
Une La suppression d'un tiers client (sw_data_customer) va supprimer en cascade les éléments dans la table liée sw_data_customeruser.