Devis

Les devis peuvent être manipulés à travers l'objet ncQuote dans l'API.

L'objet ncQuote

Le devis récupéré via l'API est un objet comprenant les méthodes suivantes :
Guid : L'identifiant du devis
Number : Le numéro du devis. Obligatoire
Status : Statut du devis. Peut prendre les valeurs PENDING, DRAFT
Datesent : Date d'envoi du devis.
Third : Objet ncThird permettant de récupérer le compte associé en mode insertion/modification. Seule la propriété de clé est obligatoire. Non obligatoire si une opportunité est renseignée
Deal : Object ncDeal permettant d'associer l'opportunité associée en mode insertion/modification. Seule la propriété de clé est obligatoire. Obligatoire
Sections : Les sections du devis. Obligatoire. Chaque section est décomposée de la façon suivante:

• Label : Le libellé de la section. Obligatoire
• Lines : Les lignes composant la section du devis. Obligatoire. Chaque ligne est décomposée de la façon suivante :
  • Product : Produit associé. Doit être de type ncProduct avec la propriété Reference renseignée
  • Quantity : Quantité
  • Vat : Taux de TVA
  • Red : Réduction (float)
  • Ht : Montant HT (float)
  • Ttc : Montant TTC (float)
  • Prht : Prix de revient (float)
  • UnitPrice : Prix unitaire (float)
  • Extcode : Code externe (provenant d'une autre application par exemple)
  • Comments : Commentaires sur la ligne

Chaque objet dispose également d'une propriété Updated spécifiant la dernière date de modification. Enfin les informations de montant sont également présentes.

Méthodes disponibles

• POST https://app-koban.com/api/v1/ncQuote/Many
  

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

  Paramètres :
  • uniqueproperty : Propriété sélectionnée pour vérifier si le devis doit être créé ou modifié. Peut prendre la valeur : Number. L'API vérifie qu'un devis correspondant à cette clé existe. Si il existe, il effectue une modification, sinon il effectue une création
  • dealuniqueproperty : Propriété définissant la clé de l'opportunité associée au devis. Peut prendre la valeur : Extcode, Guid.
  • Corps de la requête : Liste des bons de commande en tableau d'objet ncQuote JSON
• GET https://app-koban.com/api/v1/ncQuote/GetOne Tester
  

  Renvoie un devis à partir de son identifiant

  Paramètres :
  • id : Identifiant (Guid) du devis

Revenir à la liste des méthodes