Compte

Les comptes peuvent être manipulés à travers l'objet ncThird dans l'API.

L'objet ncThird

Le compte récupéré ou à insérer via l'API est un objet comprenant les méthodes suivantes :
Guid : L'identifiant du compte
Label : Le nom du compte
Status : Le statut du compte (de la forme {Label:'XXX', Code:'XXX'})
Type : Le type du compte (de la forme {Label:'XXX', Code:'XXX'})
Extcode : Code externe (celui d'une application externe par exemple)
Comments : Commentaires
AccountingCode : Compte comptable
Website : Site web
FirstName : Le prénom du compte (Particulier)
Gender : La civilité du compte (Particulier) - Correspond au code de la liste Civité dans Koban
Phone : Le téléphone fixe
Cell : Le téléphone mobile
Fax : Le fax
EMail : L'EMail
OfficialNumber : Le SIRET
Vat : Le numéro de TVA
AssignedTo : A quelle personne est-il affecté (de la forme {FullName:'', Guid:'', Extcode:''})
Origin : L'origine du compte. A renseigner comme suit : { Code : 'XXXX' }. Le code doit être défini dans la liste Origine au niveau de l'application Koban
Tags : Liste des tags affectés (de la forme [{TagCategoryCode:'', Label:''}, {TagCategoryCode:'', Label:''}, ...])
MoreFields : Liste des valeurs de champ supplémentaire (de la forme [{FieldId:'', Value:''}, {FieldId:'', Value:''}, ...])
Address : L'adresse du compte (de la forme { Compl:'Adresse complementaire', Street:'Rue', ZipCode:'Code postal', City:'Ville', Coutry:'Code pays'})
DCreated : Timestamp UNIX pour la date de création
DUpdated : Timestamp UNIX pour la date de modification

Méthodes disponibles

• GET https://app-koban.com/api/v1/ncThird/GetUpdated Tester
  

  Renvoie la liste des comptes créés ou modifiés depuis une date de référence

  Paramètres :
  • updated : date timestamp UNIX. date de référence
  • structcode : Code de la structure. Affecter à chaine vide
  • l : Entier: Longueur de la liste renvoyée (pagination)
  • s : Entier: Index de départ (pagination)
  
  
• GET https://app-koban.com/api/v1/ncThird/GetByLabel Tester
  

  Renvoie la liste des comptes dont le label contient le terme recherché

  Paramètres :
  • search : String recherché
  
  
• GET https://app-koban.com/api/v1/ncThird/GetOne Tester
  

  Renvoie un compte à partir de son identifiant

  Paramètres :
  • id : Identifiant (Guid) du compte
• GET https://app-koban.com/api/v1/ncThird/GetStatus Tester
  

  Renvoie la liste des comptes modifiés ou créés depuis une date de référence et correspondant à un statut

  Paramètres :
  • updated : date timestamp UNIX. date de référence
  • status : Code du statut paramétré dans Koban (Ex. : CLI pour client, PRO pour prospect)
  • structcode : Code de la structure. Affecter à chaine vide
  • l : Entier: Longueur de la liste renvoyée (pagination)
  • s : Entier: Index de départ (pagination)
  
  
• POST https://app-koban.com/api/v1/ncThird/Many
  

  Crée ou modifie un ensemble de compte. Si un compte correspondant à la clé uniqueproperty existe, alors l'API effectue une création. Sinon l'API met à jour le compte.

  Paramètres :
  • uniqueproperty : Propriété sélectionnée pour vérifier si le compte doit être créé ou modifié. Peut prendre la valeur : Email (Email), Guid (Identifiant), Extcode (Code externe), NameAddress (Nom et code postal), AccountingCode (Compte comptable), ExtcodeThenEmail (Code externe et si il n'existe pas EMail). L'API vérifie qu'un compte correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
  • Corps de la requête : Liste des comptes en tableau d'objet ncThird JSON
• POST https://app-koban.com/api/v1/ncThird/PostOne
  

  Crée ou modifie un compte. Si un compte correspondant à la clé uniqueproperty existe, alors l'API effectue une création. Sinon l'API met à jour le compte.

  Paramètres :
  • uniqueproperty : Propriété sélectionnée pour vérifier si le compte doit être créé ou modifié. Peut prendre la valeur : Email (Email), Guid (Identifiant), Extcode (Code externe), NameAddress (Nom et code postal), AccountingCode (Compte comptable), ExtcodeThenEmail (Code externe et si il n'existe pas EMail). L'API vérifie qu'un compte correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
  • Corps de la requête : Compte sous forme d'objet ncThird JSON

Exemples

Création ou modification de plusieurs comptes

Cet exemple lance la création ou la modification de 3 comptes dans Koban à partir d'une application tierce :

• Marie DURAND - marie9855@gmail.com, dont nous disposons des coordonnées téléphonique, Particulier. Le code dans l'application tierce est 10001. Son centre d'intérêt est Cuisine.
• Hervé DUPOND - herve.dupont@outlook.com, dont nous ne disposons pas des coordonnées téléphonique, Particulier. Pas de code dans l'application tierce. Ses centres d'intérêts sont Bricolage et Poterie. Il est inscrit à la newsletter
• Société ACME, dont nous disposons des coordonnées téléphonique du standard, Professionnel. Son code dans l'application tierce est 10002. Pas de centre d'intérêt.

Paramétrage préalable de Koban dans ce cas :

• La liste origine paramétrée avec une valeur de liste "Origine Application tierce" dont le code est "TIERS".
• Un statut Prospect dont le code est "PRO". Deux types de compte Professionnel (Code PRO) et Particulier (Code PART).
• Une catégorie de tag "Centre d'intérêt" dont le code Koban est "INTERET". Cette catégorie dispose des tags Poterie, Cuisine, Bricolage, Escalade.
• Une liste de diffusion "Newsletter" dont le guid Koban est "nl_5704ffda0dc3640c748f8485" (Accessible au niveau des champs personnalisés du compte Paramètres > Comptes et Contacts > Personnalisation Compte)

L'appel se fera sur la clé ExtcodeThenEmail pour dédoublonner les comptes avant insertion ou mise à jour sur le code de l'application tierce et s'il n'est pas présent sur l'email.