Facture

Les factures peuvent être manipulées à travers l'objet ncInvoice dans l'API.

L'objet ncInvoice

La facture récupérée via l'API est un objet comprenant les méthodes suivantes :
Guid : L'identifiant de la facture
Number : Le numéro de la facture. Obligatoire
Status : Statut de la facture. Peut prendre les valeurs PENDING, CLOSED, DRAFT
InvoiceDate : Date de la facture. Obligatoire
DueDate : Date d'échéance de la facture. 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
Contact : Objet ncContact permettant de récupérer le contact associé en mode insertion/modification. Seule la propriété de clé est obligatoire. Obligatoire
Order : Object ncOrder permettant d'associer le bon de commande associé en mode insertion/modification. Seule la propriété de clé est obligatoire
Header : En tête de document
PaymentMode : Le mode de paiement. A renseigner comme suit : { Code : 'XXXX' }. Le code doit être défini dans la liste Origine au niveau de l'application Koban
Origin : L'origine de la facture. A renseigner comme suit : { Code : 'XXXX' }. Le code doit être défini dans la liste Origine au niveau de l'application Koban
Asset : Définit si la facture est un avoir ou non (booléen) MarketingCampaign : UTM Campagne associée
Source : UTM Source associée
Canal : UTM Medium associé
Lines : Les lignes composant la facture. 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/ncInvoice/Many
  

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

  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
  • orderuniqueproperty : Propriété définissant la clé de bon de commande associé à la facture. Peut prendre la valeur : Number.
  • thirduniqueproperty : Propriété définissant la clé du compte associé à la facture. 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 factures en tableau d'objet ncInvoice JSON

Revenir à la liste des méthodes