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
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'})
Chaque objet dispose également d'une propriété Updated spécifiant la dernière date de modification.

Méthodes disponibles

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 :

Chaque compte aura son origine définie comme "Origine Application tierce" et sera intégré en tant que Prospect.

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

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.

POST /api/v1/ncThird/PostMany?uniqueproperty=ExtcodeThenEmail HTTP/1.1
Host: app-koban.com X-ncApi: XXXXXXXXXXXX X-ncUser: XXXXXXXXXXXX Accept: application/json Content-Type: application/json Cache-Control: no-cache
[{ "Label":"DURAND", "FirstName":"Marie", "EMail":"marie9855@gmail.com", "Phone":"04 11 22 55 11", "Mobile":"06 44 86 48 55", "Extcode":"10001", "Status":{ "Code":"PRO" }, "Type":{ "Code":"PART" }, "Tags":[{ "TagCategoryCode":"INTERET","Label":"Cuisine" }], "Origin":{ "Code":"TIERS" } }, { "Label":"DUPOND", "FirstName":"Hervé", "EMail":"herve.dupont@outlook.com", "Status":{ "Code":"PRO" }, "Type":{ "Code":"PART" }, "MoreFields":[ { "FieldId": "nl_5704ffda0dc3640c748f843a", "Value": "true" } ], "Tags":[{ "TagCategoryCode":"INTERET", "Label":"Bricolage" }, { "TagCategoryCode":"INTERET", "Label":"Poterie" }], "Origin":{ "Code":"TIERS" } }, { "Label":"ACME", "Phone":"04 88 55 11 44", "Extcode":"10002", "Status":{ "Code":"PRO" }, "Type":{ "Code":"PRO" }, "Origin":{ "Code":"TIERS" } } ]

Résultat
201 Created { "Result": [ "XXXXXXXXXXXX", "XXXXXXXXXXXX", "XXXXXXXXXXXX" ], "Success": true, "Message": null, "Errors": null }

Revenir à la liste des méthodes