Archive web service

Modified on Thu, 08 Jun 2023 at 09:33 AM

This web service enables you to search for a document within a Yuki domain based on several search criteria. This web service runs via SOAP.


This web service can also be used to import multiple documents that are linked together. You can upload different types of documents (.cod, .csv, .pdf, .jpg, .xml ,etc). The documents will be merged together.

The data will always need to be converted first to a base64 string.


It is in the Archive web service in combination with an Accountant webservicekey important that the domain with which you want to exchange data is first linked to the session with the SetCurrentDomain.


Web address

You will find the web service, a test application, a description of the fields and the procedures at the web address below:


https://api.yukiworks.nl/ws/Archive.asmx


Archive methods


Companies
Returns all available administrations.

CostCategories
Returns a set of generally activated cost accounts.

Currencies
Returns all activated currency.

DocumentBinaryData
Returns the binary data of the requested document.

DocumentBundle
Documents that are bundled with a main document.

DocumentFolderCounts
Returns the numbers of documents in each folder of the archive.

DocumentFolderTabs
Returns all tabs in a folder.

DocumentFolders
Returns all folders in the archive.

DocumentImage
Returns the requested image of a document, according to the dimensions given as binary data.

DocumentImageCount
Returns the number of pages of a document.

Documents
Returns the documents in a folder, with options for sorting, date selection and row number selection.

DocumentsInFolder
Returns the documents in a folder, with options for sorting, date selection and row number selection.


DocumentsInTab
Returns the documents in a tab of a folder, with options for sorting, date selection and row number selection.

FindDocument
Returns the information of a single document.

Menu
Returns the menu that can be used in apps.

SearchDocuments
Searches for documents based on a search text. Use -1 for Folder or Tab argument, or '0001-01-01' for date selections, when those should not be used.

UploadDocument
Upload a document to Yuki.

UploadDocumentWithData
Upload a document to Yuki with the corresponding currency, amount, cost account and payment method.


General methods


AdministrationID
Returns an administration ID based on the name of an administration.

Administrations
Returns all administrations that can be approached via the access code used.

Authenticate
Returns a session ID based on a valid Web Service access code.


AuthenticateByUserName
Returns a session ID based on an existing Yuki username and password.


Domains

Returns all domains that can be approached via the access code used.

SetCurrentDomain
Set the current domain for the session.


GetCurrentDomain
The current Yuki domain of the session.

Language
The language of the current user.

SetLanguage
Set the language for the web service session.

SupportedLanguages
Returns the supported languages for the domain.


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article