What is an API?

An application programming interface (API) is a collection of programming jobs (often indicated as interfaces) that calls the functions of a program. It is a method that makes it possible for two programs to communicate with each other.


So this API makes it possible for applications or services of external parties to exchange information with Yuki for the domains in which you have access rights.


ATTENTION!

For your safety Yuki will improve her SOAP web services security from the 1st of April 2019.

Our links will then only accept connections with TLS 1.2 security or higher. For most of the link implementations (this is for applications that are connected with Yuki in order to send or retrieve data) no problems will arise. 

How do I establish an API link?

To give an external system access to information in Yuki, you can generate a web service API key and Administration ID (or have it generated) with which such a system can also access without logging in.

This web service API key  can be used to give a web service access on portal, domain or administration level.


For a detailed description of web service access at portal level, see article Webservices in portaal instellen.

For a detailed description of web service access at domain or administration level, see article Webservices in domein en.of administratie instellen.

What can I do with the Yuki API link?


Financial monitor widgets


  • Post financial monitor charts on your intranet web pages


Web services


  • Retrieve financial reports such as the outstanding items and the current trial balance
  • Create sales invoices (UBL)
  • Create general journal entries
  • Retrieve and submit documents
  • Search in the archive
  • Retrieve contact data
  • Update or create contact data
  • Import of cash transactions
  • Create active and trial domains
  • Check and/or update specific back office roles of portal users in domain
  • Retrieve and create users in domain
  • Create projects (dossiers) and update existing projects (dossiers)
  • Check outstanding questions for backoffice in administration
  • Retrieve back office workflow in administration.
  • Retrieve statuses of VAT returns submitted in Yuki (from AdminPulse).


In case of illegal use we can block the access to our API.


In the portal the accountant must open the domain details of a domain with the bundle pricing price model. Next he or she must click the 'Manage bundle plan' button and then activate the Yuki Webservice or Yuki Webservice Extended feature.


In a domain without the bundle pricing price model the acountant has to activate the Yuki Webservice or Yuki webservice Extended via the Yuki Store in the domain.

Financial monitor widgets

The financial monitor offers several charts with respect to the financial data in Yuki. Yuki makes these charts available as widgets so for example, they can be shown on an own intranet.


For a detailed description of the financial monitor widgets see article Financial monitor widgets.

Available web services

At this moment there are nine web services available. These web services contain one or more methods for the exhange of information:


Source code examples of links with the Yuki API



At the bottom of this article you can download the 'voorbeeldbestanden resultaten webservices.zip' file.

This file contains a dozen examples of XML results of web services.