Introduction

Cette page décrit le déploiement fonctionnel d'une série de champs dans les factures de vente XML. Ces derniers doivent être livrés avec la méthode service web Sales-ProcessSalesInvoices (sessionID, admi, xmlDoc).

L'adoption du Schéma XML  est recommandée.

Adresse web du Schéma XML des factures de vente.

http://www.yukiworks.nl/schemas/SalesInvoices.xsd

Exemple

<SalesInvoices xmlns="urn:xmlns:http://www.theyukicompany.com:salesinvoices" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <SalesInvoice>
   <Reference>XX-1234</Reference>
   <Subject>Facture test - 1</Subject>
   <PaymentMethod>ElectronicTransfer</PaymentMethod>
   <PaymentID>1234-456</PaymentID>
   <Process>true</Process>
   <EmailToCustomer>false</EmailToCustomer>
   <Layout />
   <Date>2012-06-22</Date>
   <DueDate>2012-07-22</DueDate>
   <PriceList />
   <Currency />
   <ProjectID />
   <ProjectCode />
   <Remarks />
   <Contact>
     <ContactCode>1122</ContactCode>
     <FullName>Apple Sales International</FullName>
     <FirstName />
     <MiddleName />
     <LastName />
     <Gender>Male</Gender>
     <CountryCode>NL</CountryCode>
     <City>Rotterdam</City>
     <Zipcode>1234 AA</Zipcode>
     <AddressLine_1>Bergweg 25</AddressLine_1>
     <AddressLine_2 />
     <Website />
     <CoCNumber />
     <VATNumber />
     <ContactType>Company</ContactType>
     <BankAccount />
     <PhoneHome />
     <MobileHome />
   </Contact>
   <ContactPerson>
     <FirstName>Steve</FirstName>
     <LastName>Jobs</LastName>
     <Gender>Male</Gender>
     <EmailAddress>steve@apple.com</EmailAddress>
   </ContactPerson>
   <InvoiceLines>
     <InvoiceLine>
       <Description>Regel 1</Description>
       <Remarks />
       <ProductQuantity>2</ProductQuantity>
       <Product>
         <Description>Product 1</Description>
         <Reference>TP-1122</Reference>
         <Category xsi:nil="true" />
         <SalesPrice>14,88</SalesPrice>
         <VATPercentage>6,00</VATPercentage>
         <VATIncluded>true</VATIncluded>
         <VATType>2</VATType>
         <VATDescription>TVA  6 %</VATDescription>
         <GLAccountCode></GLAccountCode>
         <Remarks />
       <Product>
     <InvoiceLine>
   <InvoiceLines>
 <SalesInvoice>  
<SalesInvoice>

Description des champs

Ci-dessous, vous trouverez une description des champs. Le schéma XML contient également une description des champs et des valeurs et types de données qui y sont attendues.

SalesInvoice : Référence

Dans ce champ, vous pouvez mentionner le numéro de facture.

• La facture est traitée, imprimée et/ou envoyée en dehors de Yuki. La facture a donc reçu un numéro de facture en dehors de Yuki.

• La Reference (référence) contient le numéro de facture et le champ Process (traitement) a la valeur true (vrai) de sorte que Yuki sait que la facture et ses données livrées peuvent être traitées directement.

• La facture doit encore être traitée manuellement dans Yuki, imprimée et/ou envoyée, et reçoit un numéro de facture de Yuki.

• Ne pas tenir compte de Reference (référence) et le champ Process (traitement) doit contenir la valeur false (faux).

SalesInvoice : PaymentMethod

La méthode de paiement de la facture. Options possibles :

• Unspecified (Pour la méthode de paiement de la facture, Virement est alors complété dans Yuki).

• ElectronicTransfer (Virement)

• DirectCollection (le mode de paiement par encaissement doit d'abord être activé dans les paramètres de facture)

• CreditCard

• DebitCard (paiement par pin)

• Cash

• iDeal

• En ligne

SalesInvoice : Process

Ce champ vous permet d'indiquer que vous voulez directement traiter la facture. Si vous choisissez de traiter la facture, vous devez indiquer le bon numéro de facture dans le champ Reference.

Avec la valeur true, la facture est traitée dans Yuki et envoyée si c'est indiqué. Si la valeur est false, la facture est dans ce cas préparée dans « À envoyer » et doit encore être traitée.

Si le TAG Process manque, Yuki sort de la valeur false.

SalesInvoice : EmailToCustomer

Si vous choisissez de traiter une facture, vous pouvez signaler dans ce champ si vous voulez que cette facture soit envoyée directement par courriel au client par l'intermédiaire de Yuki. Cette fonctionnalité doit d'abord être activée dans les paramètres de facture. Si vous ne voulez pas que la facture soit envoyée, vous pouvez laisser tomber la valeur false.

SalesInvoice : Layout

Dans ce champ, vous pouvez mentionner la disposition souhaitée de la facture. Si vous laissez ce champ vide, la disposition de facture standard est utilisée.

SalesInvoice : Date

La date de la facture.

SalesInvoice : DueDate

La date d'échéance de la facture.

SalesInvoice : PriceList

Dans ce champ, vous pouvez mentionner la liste de prix souhaitée de la facture. Si vous laissez ce champ vide, la liste de prix standard est utilisée. Attention : les prix, les codes TVA et les comptes de chiffre d'affaires que vous indiquez dans la facture sont contraignants.

SalesInvoice : Currency

Si le champ n'est pas complété, la valeur par défaut est EUR.

Si aucune liste de prix n'est mentionnée, il convient de consulter la liste de prix standard. Si elle n'est pas dans VV, vous recevez alors la notification : The pricelist's currency "EUR" does not match with the invoice's (la devise « EUR » de la liste de prix ne correspond pas à celle de la facture)

Si la Currency est différente de la devise étrangère de la liste de prix, vous recevez la notification ci-dessous : The pricelist's currency "USD" does not match with the invoice's (la devise « USD » de la liste de prix ne correspond pas à celle de la facture).

Si la Currency n'est pas complétée dans la liste de prix et est celle de la devise étrangère, vous recevez la notification ci-dessous : The pricelist's currency "USD" does not match with the invoice's (la devise « USD » de la liste de prix ne correspond pas à celle de la facture).

SalesInvoice : ProjectID

Il s'agit du HID du dossier auquel vous souhaitez lier le document. La mention de ce paramètre rend le paramètre « ProjectCode » superflu. L'option pour les dossiers doit correctement être activée dans le contrat.

SalesInvoice : ProjectCode

Le code du dossier auquel vous souhaitez lier le document. Ce paramètre est uniquement utilisé si le paramètre « Project ID » n'est pas affiché. L'option pour les dossiers doit correctement être activée dans le contrat.

SalesInvoice : Remarques

L'information saisie ne figure pas sur la facture mais est stockée comme note avec la facture de vente.

Contact : Contact

Dans l'élément Contact, se trouve mentionné la relation/le client d'une facture. Il suffira de chercher en premier lieu une relation existante dans le carnet d'adresse de Yuki. Il est recherché :

• Si un code de relation est mentionné : Sur le code de relation par le champ ContactCode (code de contact)

• Si on ne trouve rien ou pas de code de relation : Sur le nom complet par le champ FullName (nom entier)

Si aucune relation existante n'est trouvée, une nouvelle relation est créée.

Contact : trouvé avec ContactCode = code de relation sur la carte de visite.

• Si un code de relation est utilisé, les données d'adresse d'une relation existante sont toujours écrasées par la valeur actuelle du fichier source xml.

• Pour ne pas écraser le champ, l'élément peut être totalement laissé de côté du fichier source xml.

• Pour rendre un champ vide, l'élément doit être mentionné comme nœud vide (par ex. <CocNumber/>)

Contact : trouvé avec FullName = nom de l'entreprise sur la carte de visite

• Si une relation portant le même nom est trouvée, seul les champs vides sont complétés par les données du fichier source xml.

• Pour les données d'adresse, seules les nouvelles données sont également complétées si les données existantes correspondent. Ex. L'adresse « Dorpstraat40, Ons Dorp » sera complétée par « Dorpstraat 40, 1234 XX, Ons Dorp » si dans le xml l'adresse et la localité sont identiques et que le code postal est signalé.

Contact : EmailAddress

Il est possible de mentionner 1 adresse de courriel. Cette adresse est stockée sur la carte de visite et reçoit le type « Facture ». Si l'adresse change à terme, vous pouvez envoyer une nouvelle facture par le service web, l'ancienne adresse de courriel est alors du type « Autre » et la nouvelle de type « Facture ».

Contact : BankAccount

Si un numéro de compte est mentionné, il est stocké comme compte bancaire pour la relation. Le numéro de compte est également utilisé comme numéro de compte pour cette facture. Il est donc possible de créer plusieurs numéros de compte pour le même client.

InvoiceLine : Description

La description de la ligne de facture. Si ce champ est vide ou absent, la description est reprise dans Product Description.

InvoiceLine : Remarques

Il s'agit d'une description supplémentaire que vous pouvez indiquer par ligne de facture. Le texte est placé sous la ligne actuelle sur une nouvelle ligne.

Conseil : une nouvelle ligne est indiquée par le code &#13 ;

InvoiceLine : ProductQuantity

Il s'agit de la quantité de l'article de vente dans la ligne de facture.

InvoiceLine : LineAmount

Ici, il est possible de mentionner le montant de la ligne. Lorsque ce montant est mentionné, le calcul du montant de la ligne sur la base du nombre de produits mentionné (ProductQuantity) et le prix (/Product/SalesPrice) sont stockés. Quand /Product/VATIncludes (produit/TVA comprise) est sur true, ce montant comprend la TVA ; dans le cas contraire, ce montant est hors TVA.

Attention : Il n'est pas conseillé d'utiliser ce champ, car l'on diverge notamment des méthodes de calcul de Yuki !

InvoiceLine : LineVATAmount

Ici, il est possible de mentionner le montant de TVA de la ligne. Lorsque ce montant est indiqué, le calcul du montant de la TVA de la ligne sur la base montant de la ligne et du pourcentage de TVA utilisé est réalisé.

Attention : Il n'est pas conseillé d'utiliser ce champ, car l'on diverge notamment des méthodes de calcul de Yuki !

Product : Description

Il s'agit de la description de l'article de vente d'une longueur maximale de 60 caractères. Les descriptions plus longues sont raccourcies. Elle doit être unique. InvoiceLine : Si Description est vide, c'est le Product qui est imprimé sur la facture. La description est imprimée sur la facture.

Product : Référence

Il s'agit de la référence de l'article de vente d'une longueur maximale de 40 caractères. Les références plus longues sont raccourcies. Elle doit être unique.

Product : Category

Ce champ peut être utilisé à l'avenir pour attribuer des catégories. Pour le moment, seules les valeurs NULL et 13 sont autorisées (13 = catégorie des articles de vente) Le champ Vide n'est pas autorisé.

Product : SalesPrice

Le prix de vente de l'article de vente. Ce champ peut être vide ou comporter la valeur 0 si l'article de vente est déjà créé et peut se trouver sur la base de la description/de la référence.

Product : VATPercentage

Le pourcentage de TVA de l'article de vente. Ce champ est utilisé en combinaison avec le champ « VATType » pour récupérer le code TVA. Si aucun code TVA n'existe avec cette combinaison, la facture sera annulée.

Product : VATIncluded

Avec ce champ, vous indiquez si le prix de vente comprend la TVA. Ce champ est utilisé en combinaison avec les champs « SalesPrice » et « VATType » pour calculer le montant de la TVA et le prix de vente. La valeur « false » est utilisée d'office si ce champ vide est mentionné en combinaison avec le prix de vente.

Product : VATType

Avec ce champ, vous mentionnez le type de TVA de cet article de vente. Ce champ est utilisé en combinaison avec les champs « SalesPrice » et « VATType » pour calculer le montant de la TVA et le prix de vente. Les combinaisons possibles du pourcentage de TVA et du code de TVA sont les suivantes :

Product : GLAccountCode

Le code du compte de grand livre dans Yuki. Si ce champ est vide ou contient une valeur non valable, un numéro de compte de grand livre inactif n'est également pas valable ; on utilise d'office le compte de grand livre « 80000 ».

Product : Remarques

Cette remarque est ajoutée dans Yuki comme article de vente et n'est donc pas visible sur la facture.