Yuki API link

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. 

This article describes the capabilities of a Yuki API link and how to establish an API link.

What can I do with the Yuki API link?

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.

Web services

By default, each domain has 1,000 web service calls (calls) per day available for free.

To increase the number of available web service calls, a user with the “Portal administrator” role has the option to add one of the following accountant features to the domain: 

• Yuki Webservice (from 1,000 to a maximum of 5,000 calls per day)
• Yuki Webservice Extended (from 5,000 to a maximum of 10,000 calls per day).

ATTENTION!

• In a domain with the Minimal version of Yuki, the Sales web service (1,000 calls per day) must be added to the domain as an accountant feature. In all other bundles, the Sales web service is included for free.
• To use the Purchase web service, a formal request must be sent by email to [email protected].
  You will then receive a Client ID/Secret by email from Yuki. You will need this in addition to the API key for authentication in order to gain access to the Purchase web service.

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

• Accounting web service:
  • Retrieve financial reports
  • Create general journal entries
• AccountingInfo web service:
  • Retrieve information about GL accounts and transactions
• Sales web service:
  • Create sales invoices (UBL)
• Upload web service:
  • Submit documents
• Archive web service:
  • Retrieve and submit documents
  • Access (via app) to the archive
• Contact web service:
  • Retrieve contact details (read-only)
  • Update or create contact
• PettyCash web service:
  • Import cash transactions
• Domains web service:
  • Create active and trial domains by accountants
  • Retrieve and create users in a domain.
• Projects web service:
  • Create projects (files)
  • Update existing projects (files).
• Back office web service:
  • Check outstanding questions for backoffice in administration
  • Retrieve backoffice workflow of administration
  • Check specific back office roles of portal users in domain
  • Update specific back office roles of portal users in domain.
• VAT web service:
  • Retrieve statuses of VAT returns submitted in Yuki (from AdminPulse).
• Purchase  web service:
  • Create purchase invoices.
    
    

ATTENTION!

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

How do I establish an API link?

The first step is to check whether there is already a link with the software with which you want to link Yuki. You can find all links here:  Integrations. Here you will find information about the specific link.

Is the software with which you want to connect not yet listed? Then we recommend asking the external party if they want to set up a link with Yuki. Yuki has a completely open API environment, which makes it very easy for other software to connect to Yuki.

If the software you want to link with already has a link, some settings need to be defined in that software or with the third-party provider of the link. 

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

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

The (access) rights to webservices in a domain or administration are leading and 'overrule' the (access) rights to web services as they are set on portal level.

For a detailed description of web service access at portal level, see article Set up web services in portal.

For a detailed description of web service access at domain or administration level, see article Set up web services in domain and/or administration.

Source code examples of links with the Yuki API

• Example of PHP SOAP ProcessSalesInvoices
• Example of PHP SOAP ProcessJournal
• Example of Classic ASP SOAP ProcessSalesInvoices
• Example of Classic ASP SOAP ProcessJournal
• Example of SOAP link with Visual Studio 2005
• Example of SOAP link with Visual Studio 2008
• Example of PHP HTTP-POST link with Upload web service
• Example of HTML HTTP-POST to Upload web service.

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.