Documentatie‎ > ‎Home‎ > ‎Yuki API Documentatie‎ > ‎

Upload webservice

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.


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 Webservice toegangscode (WebserviceAccessKey).

Administration

De ID van de administratie waarnaar je het document wilt uploaden. Voor een beschrijving van het ophalen van de Administratie ID zie Administratie ID.

Ordner

De ordner waarin je het document wilt opslaan. De standaardwaarde van deze parameter is '7' (ordner 'Uitzoeken Yuki'). Mogelijke opties zijn:

Ordner IDOmschrijving
0Overig
1Inkoop
2Verkoop
3Bank
4HRM
5Belasting
6Verzekering
7Uitzoeken Yuki
8Overig financieel
100Zelf te ordenen
101Correspondentie
102Meetings

FolderTab

Het tabblad van de ordner waarin je het document wilt opslaan. De defaultwaarde van deze parameter is leeg.

ProjectID

De HID van het dossier waaraan je het document wilt koppelen. Het meegeven van deze parameter maakt de parameter 'ProjectCode' overbodig. De Yuki Dossiers module dient wel te zijn geactiveerd in het contract.

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 Yuki Dossiers module dient wel te zijn geactiveerd in het contract.


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.

Zie ook: