Bons de commande

Les bons de commandes peuvent être manipulés à travers l'objet ncOrder dans l'API.

L'objet ncOrder

Le bon de commande récupéré via l'API est un objet comprenant les méthodes suivantes :
Guid : L'identifiant du bon de commande
Number : Le numéro du bon de commande. Obligatoire
Extcode : Le code externe du bon de commande
Status : Statut du bon de commande. Peut prendre les valeurs PENDING, CLOSED, DRAFT
Dateorder : Date du bon de commande. Obligatoire
Third : Objet ncThird permettant de récupérer le compte associé en mode insertion/modification. Seule la propriété de clé est obligatoire. Obligatoire
ShippingAddress : Adresse de livraison (de la forme { Compl:'Adresse complementaire', Street:'Rue', ZipCode:'Code postal', City:'Ville', Coutry:'Code pays'})
CurrencyCode : Code devise
Deposit : Object ncDeposit permettant d'associer le dépot. Seule la propriété de clé est obligatoire (de la forme { Guid: 'XXXXX' })
Deal : Object ncDeal permettant d'associer l'opportunité associée en mode insertion/modification. Seule la propriété de clé est obligatoire
Quote : Object ncQuote (de la forme { Guid: 'XXXXXX'}) permettant de récupérer le devis associé à la commande (uniquement en consultation)
Comments : Commentaires
PaymentMode : Code Mode de règlement. Le code doit être défini dans la liste Mode de règlement au niveau de l'application Koban
DeliveryMode : Mode de livraison
UtmCampaign : UTM Campagne associée
eShop : Code de la boutique en ligne de provenance
eShopStatus : Statut de la commande sur la boutique en ligne. Si la valeur est paid, alors la commande est soldée, la facture correspondante créée dans Koban et le paiement sur cette facture enregistré. Si la valeur est invoiced, alors la commande est soldée, la facture correspondante est créée et validée dans Koban
eShopInvoiceNumber : Dans le cas ou eShopStatus est à paid ou invoiced, permet de spécifier le numéro de facture de la boutique en ligne. Si cette valeur est renseignée, alors le compteur de facture de Koban ne sera pas appliqué sur la facture créée.
Structure : Structure de rattachement
Lines : Les lignes composant le bon de commande. 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
• DeclinaisonCode : Spécifie la déclinaison du produit associé

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

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

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

  Paramètres :
  • updated : date timestamp UNIX. date de référence
  • l : Entier: Longueur de la liste renvoyée (pagination)
  • s : Entier: Index de départ (pagination)
  
  
• GET https://app-koban.com/api/v1/ncOrder/GetByDate Tester
  

  Renvoie la liste des bons de commande entre deux dates

  Paramètres :
  • st : Entier: Index de départ (pagination)
  • s : Entier: Longueur de la liste renvoyée (pagination)
  • from : date timestamp UNIX. date de début de la plage
  • to : date timestamp UNIX. date de fin de la plage
  
  
• POST https://app-koban.com/api/v1/ncOrder/Many
  

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

  Paramètres :
  • uniqueproperty : Propriété sélectionnée pour vérifier si le bon de commande doit être créé ou modifié. Peut prendre la valeur : Number. L'API vérifie qu'un bon de commande 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 bon de commande. Peut prendre la valeur : Extcode, Guid.
  • thirduniqueproperty : Propriété définissant la clé du compte associé au produit. 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).
  • Corps de la requête : Liste des bons de commande en tableau d'objet ncOrder JSON

Revenir à la liste des méthodes