Deze webservice stelt je in staat om vanuit je eigen applicatie bestanden direct naar je administratie in Yuki te uploaden. Deze webservice werkt via HTTP POST.
Bestanden kunnen één voor één worden gepost met contenttype 'multipart/form-data' en 'application/x-www-form-urlencoded'.
Om het ontwikkelproces te vereenvoudigen vind je onderaan op deze pagina een paar links naar voorbeeldapplicaties waarmee je deze webservice methode kunt aanroepen.
TIP!
In plaats van de Upload webservice kun je ook de Archive webservice gebruiken. De Archive webservice heeft het voordeel dat je twee bestanden tegelijk kunt versturen, bijvoorbeeld de PDF en UBL XML.
Webadres
De webservice, een testapplicatie, een omschrijving van de velden en de procedures vind je op het webadres hieronder:
https://api.yukiworks.nl/docs/Upload.aspx
Authenticatie
Accountants met portaal
Accountants met een portaal authenticeren met behulp van de WebserviceAccessKey. Deze kan in het portaal worden aangemaakt.
Gebruikers
Gebruikers kunnen authenticeren met behulp van de WebserviceAccessKey of met een gebruikersnaam en wachtwoord.
Status response
Deze webservice biedt twee opties om het resultaat van de POST-actie terug te koppelen:
- Met een XML-bericht (default wijze van terugkoppeling)
Het XML-bericht is in de response van deze webservice uit te lezen. Het bevat daarin de status van de upload en de eventuele validatiemeldingen. - Via een redirect
Met deze optie kun je een webadres opgeven die bepaalt waarheen geredirect wordt als de upload is mislukt of geslaagd.
Parameters
Domain
De naam van het domein waarin je documenten wilt aanleveren.
UserName
De gebruikersnaam waarmee je toegang hebt tot je domein in Yuki. Deze parameter is verplicht indien er niet met een WebServiceAccessKey wordt geauthenticeerd.
WebServiceAccessKey
De WebServiceAccessKey kan in het domein of het portaal worden aangemaakt. Deze toegangscode kan webservice toegang verlenen op administratie- of domeinniveau. Voor een beschrijving van het aanmaken van de toegangscode zie artikelen Webservices in portaal instellen en Webservices in domein en/of administratie instellen.
Administration
De ID van de administratie waarnaar je het document wilt uploaden. Voor een beschrijving van het ophalen van de Administratie ID zie artikel Administratie ID.
Folder
De ordner waarin je het document wilt opslaan. De standaardwaarde van deze parameter is '7' (ordner 'Uitzoeken Yuki'). Mogelijke opties zijn:
Folder ID Omschrijving
| 0 | Overig |
| 1 | Inkoop |
| 2 | Verkoop |
| 3 | Bank |
| 4 | HRM |
| 5 | Belasting |
| 6 | Verzekering |
| 7 | Uitzoeken Yuki |
| 8 | Overig financieel |
| 100 | Zelf te ordenen |
| 101 | Correspondentie |
| 102 | Meetings |
FolderTab
Het tabblad van de ordner waarin je het document wilt opslaan. De defaultwaarde van deze parameter is leeg.
ProjectID
De HID van het project waaraan je het document wilt koppelen. Het meegeven van deze parameter maakt de parameter 'ProjectCode' overbodig. Een gebruiker met de rol 'Directie' dient wel de bundel Medium, Large of Unlimited te hebben gekozen via de Yuki Store in het domein.
ProjectCode
De code van het project waaraan je het document wilt koppelen. Deze parameter wordt alleen gebruikt als de parameter 'ProjectID' niet wordt meegegeven. Een gebruiker met de rol 'Directie' dient wel de bundel Medium, Large of Unlimited te hebben gekozen via de Yuki Store in het domein.
File
Het aan te leveren document.
ResponseType
Deze parameter bepaalt de wijze waarop deze webservice het resultaat van de POST-actie terugkoppelt. Indien 'XML' dan zal het resultaat van de POST-actie in XML-formaat in de browser worden weggeschreven. Indien 'Redirect' dan wordt er na de POST-actie een redirect uitgevoerd. De defaultwaarde van deze parameter is 'XML'.
RedirectUrlSuccess
Deze parameter (string) is alleen verplicht in combinatie met ReponseType 'Redirect' en bepaalt de url waarheen geredirect wordt als de upload is geslaagd. Er wordt aan deze url een extra parameter 'DocumentID=' toegevoegd met als waarde de ID (GUID) van het opgeslagen document in Yuki.
RedirectUrlFailed
Deze parameter is alleen verplicht in combinatie met ReponseType 'Redirect' en bepaalt de url waarheen geredirect wordt als de upload is mislukt. Er wordt aan deze url een extra parameter 'DocumentID=' toegevoegd met als waarde de ID (GUID) van het opgeslagen document in Yuki.
Voorbeelden
Was dit artikel nuttig?
Dat is fantastisch!
Hartelijk dank voor uw beoordeling
Sorry dat we u niet konden helpen
Hartelijk dank voor uw beoordeling
Feedback verzonden
We stellen uw moeite op prijs en zullen proberen het artikel te verbeteren