WebHook Customer (V5.3)

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_customer : Table des tiers

Les tables lié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

"settings":
{
  "getIndicators": "1" // pour le verb GET et LIST permet de retourner les informations des indicateurs clients
}

verb: GET
resultType: simple

  "customer":{
    "codecustomer":"C0000001",
    "name":"ENTREPRISE DIJON GUICHARD",
    "baseuser_ID":"TENARDIER",
    "address1":"33 Avenue du Drapeau",
    "address2":"",
    "address3":"",
    "postalCode":"21000",
    "city":"DIJON",
    "phoneNumber":"03 90 11 22 33",
    "faxNumber":"03 90 11 22 44",
    "mobilePhoneNumber":"06 90 11 22 33",
    "email":"contact@guichard.com",
    "generictype_ID_customerType":"CTC",
    "generictype_ID_country":"FR",
    "generictype_ID_province":"",
    "generictype_ID_civility":"",
    "baseculture_ID":"FR-FR",
    "branchoffice_ID":"SXB"
  }

verb: GET
resultType: extended

  "customer":{
    "codecustomer":"C0000001",
    "name":"ENTREPRISE DIJON GUICHARD",
    "baseuser_ID":"TENARDIER",
    "address1":"33 Avenue du Drapeau",
    "address2":"",
    "address3":"",
    "postalCode":"21000",
    "city":"DIJON",
    "phoneNumber":"03 90 11 22 33",
    "faxNumber":"03 90 11 22 44",
    "mobilePhoneNumber":"06 90 11 22 33",
    "email":"contact@guichard.com",
    "generictype_ID_customerType":"CTC",
    "generictype_ID_country":"FR",
    "generictype_ID_province":"",
    "generictype_ID_civility":"",
    "baseculture_ID":"FR-FR",
    "branchoffice_ID":"SXB",
    "deliveryDays":"1A;1B;2A;2B;3A;3B;4A;4B;5A;5B",
    "openingDays":"1A;1B;2A;2B;3A;3B;4A;4B;5A;5B",
    "siretNumber":"",
    "vatIntra":"",
    "apeCode":"516K",
    "comment":"",
    "blocked":"0",
    "blockedComment":"",
    "message":"",
    "vacationStart":"",
    "vacationEnd":"",
    "gpsLongitude":"5.04372",
    "gpsLatitude":"47.33222",
    "accountNumber":"C0000001",
    "contactName":"",
    "currency_ID":"",
    "authorizedCredit":"0",
    "risk":"1",
    "language":"",
    "underSurveillance":"",
    "workforce":"25",
    "customer_ID_paying":"",
    "pricecategory_ID":"",
    "discountRate":"0",
    "website":"<https://www.guichard.com",>
    "legalStatus":"Société Anonyme avec Directoire",
    "generictype_ID_brand":"",
    "generictype_ID_deliveryMode":"",
    "generictype_ID_paymentMean":"",
    "generictype_ID_customerFamily":"",
    "confirmationEmail":"contact@guichard.com",
    "confirmationFax":"03 90 11 22 44",
    "generictype_ID_taxCode":"",
    "productdepot_ID":"",
    "generictype_ID_accountingCategory":"",
    "generictype_ID_customerPotential":"B",
    "skype":"contact@guichard.com",
    "generictype_ID_role":"",
    "unused":"0",
    "customergroup_ID":"",
    "generictype_ID_referencing":"2",
    "generictype_ID_distribution":"SELF",
    "generictype_ID_market":"BIG",
    "area":"",
    "baseuser_ID_favoriteTechnician":"TECH-01",
    "emailFormat":"",
    "isIndividual":"0",
    "facebook":"https://www.facebook.com/guichard/",
    "twitter":"https://twitter.com/guichard",
    "youtube":"https://www.youtube.com/watch?v=6jGbnEwQJ54",
    "linkedin":"https://www.linkedin.com/company/guichard",
    "activity":""
  }

verb: GET
resultType: extendedRelated
en complément du résultat pour resultType: extended on aura le détail pour les tables generictype_customerfamily, baseuser, generictype_country, generictype_province, productdepot, generictype_civility, baseculture, baseuser_favoriteTechnician, branchoffice et productdepot

verb: GET
resultType: simple, extended, extendedRelated
getIndicators: 1

verb: PUT

Exemple de recodification d’un prospect en client

J’ai un prospect ‘P0000001’ (type de tiers : CTP), que je veux recodifier en client ‘C0000001’ (type de tiers : CTC)

Ci-dessous les informations minimales à fournir en mode PUT :

Exemple de recodification d’un suspect en client

J’ai un suspect ‘S0000001’ (type de tiers : CTSUS), que je veux recodifier en client ‘C0000001’ (type de tiers : CTC)

Ci-dessous les informations minimales à fournir en mode PUT :

verb: LIST
resultType: simple, extended reprendre les définitions du GET

Valeurs possibles pour le tri "orderBy" :

nameAsc : par nom ascendant

Compléments :

Pour les verb LIST et GET, on ne renvoie pas les tiers de type "Temporaire"

verb: DELETE
La suppression d'un client (sw_data_customer) va supprimer en cascade les éléments dans la table liée sw_data_customeruser.

06 CRM 6.2