Sales - ProcessSalesInvoices(sessionID, administrationId, xmlDoc)

Gewijzigd op Ma, 6 Dec, 2021 om 3:40 PM

Yuki Webservice - Verkoopfacturen

Voor klanten die hun verkoopfacturen met een geautomatiseerd systeem aanmaken buiten Yuki, bijvoorbeeld webshops (zoals Magento), ERP applicaties (bijvoorbeeld AutoTask), is er een behoefte aan een elektronische koppeling met Yuki voor de invoer van deze verkoopfacturen. Deze webservice is speciaal voor dit doeleinde ontwikkeld en is een alternatief voor het handmatig invoeren van verkoopfacturen binnen de Yuki webapplicatie.

Om het ontwikkelproces te vereenvoudigen, vind je onderaan op deze pagina een tweetal links naar voorbeeldapplicaties waarmee je deze webservice methode kunt aanroepen.

Procedure

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. Klik op het icoon 'Instellingen' in de navigatiebalk en vervolgens op 'Verkoopinstellingen'. Voor een uitgebreide beschrijving zie artikel Verkoopinstellingen.

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 uitgevoerde bewerkingen 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 factuurlay-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. In het artikel Sales ProcessSalesInvoices Response XML vind je hier een voorbeeld van.

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 artikel Sales - Functionele beschrijving velden verkoopfacturen XML.

ProcessSalesInvoices(sessionID, administrationId, xmlDoc)

Maakt op basis van de aangeleverde XML-verkoopfacturen aan.

Parameters

sessionID

De sessie ID zoals deze is verkregen met de methode Authenticate(accessKey).

administrationID

De identifier van de administratie. Voor een beschrijving waar je de administrationID kunt vinden zie Administratie ID.

xmlDoc

Het XML-fragment met de verkoopfacturen.

Webadres van het XML schema van de verkoopfacturen

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

Webadres van het XML schema van de webservice response

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

Voorbeelden