ProcessSalesInvoices

Introductie

Deze pagina beschrijft de functionele uitwerking in de software van een aantal van de velden in de verkoopfacturen XML. Deze dient te worden aangeleverd met de webservicemethode Sales - ProcessSalesInvoices(sessionID, administrationId, xmlDoc).

Het doornemen van het XML Schema is aanbevolen.

Webadres van het XML schema van de verkoopfacturen

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

Voorbeeld

<SalesInvoices xmlns="urn:xmlns:http://www.theyukicompany.com:salesinvoices" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SalesInvoice>
    <Reference>XX-1234</Reference>
    <Subject>Testfactuur - 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>BTW 6%</VATDescription>
          <GLAccountCode></GLAccountCode>
          <Remarks />
        </Product>
      </InvoiceLine>
    </InvoiceLines>
  </SalesInvoice>  
</SalesInvoices>

Omschrijving velden

Hieronder vind je een omschrijving van de velden. Het XML schema bevat zelf ook een omschrijving van de velden en welke waarden en datatypes erin worden verwacht.

SalesInvoice: Reference

In dit veld kun je het factuurnummer opnemen.

  • Factuur wordt buiten Yuki afgehandeld, afgedrukt en/of verzonden. De factuur heeft dus een factuurnummer buiten yuki gekregen
    Reference bevat het factuurnummer en het veld Process heeft de waarde true ,zodat Yuki weet dat de factuur met de aangeleverde gegevens direct mag worden verwerkt
  • Factuur moet nog binnen Yuki met de hand worden verwerkt, afgedrukt en/of verzonden, de factuur krijgt dan een factuurnummer van Yuki
    Reference weglaten en het veld Process moet de waarde false bevatten.

SalesInvoice: PaymentMethod

De betaalwijze van de factuur. Mogelijke opties:
  • Unspecified ( Bij de betaalwijze van de factuur wordt dan in Yuki Overschrijving ingevuld )
  • ElectronicTransfer ( Overschrijving )
  • DirectCollection (betaalwijze incasso dient eerst in de factuurinstellingen te worden geactiveerd)
  • CreditCard
  • DebitCard ( pin betaling )
  • Cash
  • iDeal
  • Online

SalesInvoice: Process

Met dit veld geef je aan of je de factuur direct wilt verwerken. Als je ervoor kiest om de factuur te verwerken dien je ook het juiste factuurnummer op te geven in het veld Reference.

Bij de waarde true wordt de factuur in Yuki verwerkt en indien aangegeven verstuurd. Is de waarde false dan wordt de factuur klaargezet in "Te verzenden" en moet de factuur nog verwerkt worden.

Als de TAG Process ontbreekt, gaat Yuki uit van de waarde false

SalesInvoice: EmailToCustomer

Als je ervoor kiest om een factuur te verwerken kun je in dit veld aangeven of je wilt dat deze factuur direct via Yuki naar de klant moet worden ge-emaild. Deze functionaliteit dient eerst in de factuurinstellingen te worden ingesteld. Indien je niet wil dat de factuur verstuurd wordt kun je het weglaten of de waarde false opnemen

SalesInvoice: Layout

In dit veld kun je de gewenste factuurlayout opgeven. Als je deze leeg laat wordt de standaard facuurlayout genomen.

SalesInvoice: Date

De factuurdatum.

SalesInvoice: DueDate

De vervaldatum.

SalesInvoice: PriceList

In dit veld kun je de gewenste prijslijst opgeven. Als je deze leeg laat wordt de standaard prijslijst genomen. Let op: de prijzen, btwcodes en omzetrekeningen die je meegeeft in de factuur zijn leidend.

SalesInvoice: Currency

Als het veld niet ingevuld is, is de default waarde EUR

Als er geen prijslijst opgegeven is, wordt naar de standaard prijslijst gekeken. Als die niet in VV is dan krijg je de melding The pricelist's currency "EUR" does not match with the invoice's

Als de Currency afwijkt van de vreemde valuta in de prijslijst, krijg je onderstaande melding The pricelist's currency "USD" does not match with the invoice's

Als currency niet gevuld is en de pricelist wel en die is in vreemde valuta dan krijg je onderstaande melding The pricelist's currency "USD" does not match with the invoice's

SalesInvoice: ProjectID

De HID van het dossier waaraan je het document wilt koppelen. Het meegeven van deze parameter maakt de parameter "ProjectCode" overbodig. De optie voor dossiers dient wel te zijn geactiveerd in het contract.

SalesInvoice: ProjectCode

De code van het dossier waaraan je het document wilt koppelen. Deze parameter wordt alleen gebruikt als de parameter "ProjectID" niet wordt meegegeven. De optie voor dossiers dient wel te zijn geactiveerd in het contract.

SalesInvoice: Remarks

De ingegeven informatie komt niet op de factuur maar wordt als notitie bij de verkoopfactuur opgeslagen.

Contact: Contact

In het Contact element wordt de relatie/klant van een factuur opgegeven. Er zal eerst naar een bestaande relatie in het adresboek van Yuki gezocht worden. Er wordt gezocht:

  • Indien een relatiecode is opgegeven: Op relatiecode via het veld ContactCode
  • Indien niet gevonden of geen relatiecode opgegeven: Op volledige naam via het veld FullName

Indien geen bestaande relatie wordt gevonden wordt een nieuwe relatie aangemaakt.

Contact: gevonden met ContactCode = relatiecode op de adreskaart

  • Als een relatiecode wordt gebruikt worden de adresgegevens van een bestaande relatie altijd overschreven met de huidige waarde in het xml-bronbestand.
  • Om een veld niet te overschrijven kan het element volledig worden weggelaten uit het xml-bronbestand.
  • Om een veld leeg te maken moet het element als lege node worden opgenomen (bijv <CocNumber />).

Contact: gevonden met FullName = naam of bedrijfsnaam op de adreskaart

  • Als een relatie met dezelfde naam wordt gevonden worden alleen de lege velden van die relatie aangevuld met gegevens uit het xml-bronbestand.
  • Voor de adresgegevens geldt ook dat alleen gegevens worden aangevuld als de bestaande gegevens overeenkomen. Bijv. Het adres 'Dorpstraat 40, Ons Dorp' zal worden aangevuld tot 'Dorpstraat 40, 1234 XX, Ons Dorp' indien in de xml het adres en woonplaats hetzelfde zijn en ook de postcode is opgegeven.

Contact: EmailAddress

Het is mogelijk om 1 e-mailadres mee te geven. Dit adres wordt bij de adreskaart van de klant opgeslagen en krijgt het type "Factuur". Als het adres op termijn wijzigt kun je dit bij een nieuwe factuur via de webservice meesturen, het "oude" e-mailadres wordt dan type 'Overig' en het nieuwe type 'Factuur'

Contact: BankAccount

Indien een rekeningnummer wordt opgegeven wordt deze als bankrekening voor de relatie opgeslagen. Het rekeningnummer wordt ook gebruikt als rekeningnummer voor deze factuur. Het is dus mogelijk om meerdere rekeningnummers voor dezelfde klant aan te leggen.

InvoiceLine: Description

De omschrijving van de factuurregel. Als dit veld leeg is of niet aanwezig wordt de omschrijving uit Product Description gebruikt

InvoiceLine: Remarks

Dit is een extra omschrijving die je kunt meegeven per factuurregel. De tekst wordt onder de huidige regel op een nieuwe regel geplaatst.
Tip: een newline geef je aan met de code &#13;

InvoiceLine: ProductQuantity

De kwantiteit van het verkoopartikel in de factuurregel.

InvoiceLine: LineAmount

Hier kan een regelbedrag opgegeven worden. Wanneer dit bedrag is opgegeven wordt de berekening van het regelbedrag op basis van het opgegeven aantal producten (ProductQuantity) en de prijs (/Product/SalesPrice) overgeslagen. Wanneer /Product/VATIncluded gelijk is aan true is dit bedrag inclusief BTW, anders is het bedrag exclusief BTW.
Let op: Het wordt niet aangeraden dit veld te gebruiken, er wordt namelijk afgeweken van de Yuki rekenmethodes!

InvoiceLine: LineVATAmount

Hier kan een regel-btw-bedrag opgegeven worden. Wanneer dit bedrag is opgegeven wordt de berekening van het regel-btw-bedrag op basis van het regelbedrag en het gebruikte btw-percentage overgeslagen.
Let op: Het wordt niet aangeraden dit veld te gebruiken, er wordt namelijk afgeweken van de Yuki rekenmethodes!

Product: Description

De omschrijving van het verkoopartikel met een maximum lengte van 60 karakters. Langere omschrijvingen worden ingekort. Deze moet uniek zijn. Als het veld InvoiceLine: Description leeg is wordt de Product: Description op de factuur afgedrukt

Product: Reference

De referentie van het verkoopartikel met een maximum lengte van 40 karakters. Langere referenties worden ingekort. Deze moet uniek zijn.

Product: Category

Dit veld kan in de toekomst gebruikt worden voor het toekennen van categorien. Momenteel zijn alleen de waarden NULL en 13 toegestaan (13=categorie verkoopartikelen). Het veld Leeg is niet toegestaan

Product: SalesPrice

De verkoopprijs van het verkoopartikel. Dit veld mag leeg of met een 0-waarde worden meegegeven indien het verkoopartikel al reeds is aangemaakt en kan worden gevonden op basis van omschrijving/referentie.

Product: VATPercentage

Het btw-percentage van het verkoopartikel. Dit veld wordt gebruikt in combinatie met het veld "VATType" om de btwcode op te halen. Als er geen btwcode met deze combinatie bestaat, wordt de factuur geannuleerd.

Product: VATIncluded

Met dit veld geef je aan of de verkoopprijs inclusief btw is. Dit veld wordt gebruikt in combinatie met de velden "SalesPrice" en "VATType" om het btwbedrag en de verkoopprijs berekenen. De waarde "false" wordt standaard gebruikt als dit veld leeg wordt meegegeven in combinatie met een verkoopprijs.

Product: VATType

Met dit veld geef je het btwtype van het verkoopartikel aan. Dit veld wordt gebruikt in combinatie met de velden "SalesPrice" en "VATType" om het btwbedrag en de verkoopprijs berekenen. Mogelijke combinaties van btwpercentage en btwcode:

BtwtypePercentage  Omschrijving
00%Vrijgesteld van btw
1VariabelBtw hoog tarief
2VariabelBtw laag tarief
40%Btw 0%
60%Export buiten de EU
70%Export binnen de EU
8LandspecifiekInstallatie/afstandverkopen binnen de EU
170%Btw verlegd
190%Export goederen EU (leveringen 2010)
200%Export diensten EU (diensten 2010)

Product: GLAccountCode

De code van de grootboekrekening in Yuki. Als dit veld leeg is of een ongeldige waarde, een niet actief grootboekrekeningnummer is ook ongeldig, bevat wordt standaard de grootboekrekening met code "80000" gebruikt.

Product: Remarks

Deze opmerking wordt in Yuki aan het verkoopartikel toegevoegd en is dus niet op de factuur te zien.
Comments