Sales webservice

Gewijzigd op Wed, 26 Jan 2022 om 05:40 PM

Met deze webservice kun je op basis van een aangeleverd XML-bericht verkoopfacturen in Yuki aanmaken. Deze webservice werkt via SOAP. De functionaliteit om gebruik te maken van de Sales webservice is reeds toegevoegd aan alle bundles vanaf Small. 

Heb je een Minimal bundle en wil je toch gebruik maken van de Sales webservice, dan kan je accountant de Accountancy feature 'Yuki Sales Webservice' toevoegen aan het desbetreffende domein. Let er dan wel op dat alle facturen in de xml de Process status 'True'  en EmailToCustomer 'False' krijgen.


Webadres

De webservice en een omschrijving van de velden en de procedures vind je op het webadres hieronder:


https://api.yukiworks.be/ws/Sales.asmx


Sales Methodes


ProcessSalesInvoices(sessionID, administrationId, xmlDoc)

De Yuki verkoopfacturen webservice maakt op basis van de aangeleverde XML verkoopfacturen aan.



Definieer indien nodig eerst de factuurinstellingen

Indien je in je facturen gebruik maakt van de betaalwijze incasso of als je je verkoopfacturen wilt e-mailen, dien je eerst de factuurinstellingen te definiëren. Deze vind je via de module 'Boekhouding', vervolgens klik je links in het scherm op 'Verkoop' en daarna op 'Factuurinstellingen'. Voor een uitgebreide beschrijving zie Factuurinstellingen.


Stel de XML met de verkoopfacturen op

Verzamel de factuurgegevens in een XML-document en bied deze aan onze webservice aan. De webservice valideert het XML-document met het XML-schema (XSD). Indien het XML-document niet door de validatie heen komt, wordt het proces geannuleerd en antwoordt de webservice met een gedetailleerde validatiemelding.


Roep de webservice methode aan met het betreffende XML bericht


Validatie

Na een succesvol doorlopen validatieproces worden de facturen uit het XML-document gehaald en één voor één verwerkt. Tijdens de verwerking van een factuur worden nieuwe contactpersonen (klanten) en producten automatisch aangemaakt. Bestaande contactpersonen worden aan de hand van een referentie of aan de hand van naam- en adresgegevens gematcht. Bestaande producten worden gematcht op beschrijving. Indien de productgegevens zoals prijs, btw-percentage of grootboekrekeningnummer afwijken van de reeds opgeslagen gegevens, worden de nieuwe gegevens in de huidige factuur meegenomen. 


Verwerking

Tijdens de verwerking van een incomplete of niet correct opgestelde factuur, wordt deze geannuleerd waarbij alle bewerkingen die tijdens het verwerken van de factuur ongedaan worden gemaakt. De eventuele aanmaak van nieuwe contactpersonen en/of producten wordt dan direct teruggedraaid. Een factuur kan incompleet zijn wanneer er bijvoorbeeld nieuwe producten zonder prijzen of btw-percentages worden aangeboden, of wanneer er nieuwe contactpersonen zonder adresgegevens worden aangeboden. Een goed ingevoerde factuur kan indien gewenst na verwerking automatisch met een e-mail naar de klant als document worden verzonden. Indien je de naam van een bestaande lay-out hebt meegegeven in het XML-document, wordt deze factuur lay-out tevens gehanteerd.


Status response

Aan het einde van het verwerkingsproces stelt de webservice een response XML-document op, met daarin de verwerkingsstatus van de facturen en de eventuele validatiemeldingen. Dit XML-document is gespecificeerd in een XML-schema (XSD) en kan eventueel door jouw applicatie worden verwerkt. 

De status en verwerking van de facturen worden bepaald aan de hand van een aantal parameters die per factuur moeten worden gespecificeerd.


Voor een functionele beschrijving van de velden in de verkoopfacturen XML zie Sales - Functionele beschrijving velden verkoopfacturen XML.  


Algemene methodes


Authenticate(accessKey)

Geeft een sessie-ID op basis van een geldige Web Service toegangscode.

AuthenticateByUserName(userName, password)

Geeft een sessie-ID op basis van een bestaande Yuki gebruikersnaam en wachtwoord.

Domains(sessionID)

Geeft alle domeinen die via de gebruikte toegangscode benaderd kunnen worden.

SetCurrentDomain(sessionID, domainID)

Zet het huidige domein voor de sessie.

GetCurrentDomain(sessionID)

Haalt de ID op van het huidige domein voor de sessie.













Was dit artikel nuttig?

Dat is fantastisch!

Hartelijk dank voor uw beoordeling

Sorry dat we u niet konden helpen

Hartelijk dank voor uw beoordeling

Laat ons weten hoe we dit artikel kunnen verbeteren!

Selecteer tenminste een van de redenen

Feedback verzonden

We waarderen uw moeite en we gaan proberen om het artikel te verbeteren