Set up web services in domain and/or administration

Modified on Mon, 2 Mar at 2:15 PM

Disclaimer

All screenshots in the article were taken in the Dutch version of Yuki.

The settings you can configure in a domain depend on the selected bundle (and any additional features) and your user role(s) within the domain.

In Yuki you can integrate with Mollie (online payment provider), web services (methods for data exchange with third-party applications), Peppol (e-invoicing) and Rabobank (automatic submission of bank transactions).

A web service contains one or more methods for the exchange of information with applications/services of external parties. Just think of financial data, submitting data of sales invoices and access and/or upload to the Yuki archive.

Only a user with a 'Back office' role in the domain or the role 'Management' can set (access) rights to web services in the domain and/or administration(s) by means of the web service API key and Administration ID.

In Yuki, you can realize the following Integrations:

Mollie
By linking with Mollie, your customers can pay directly from their sales invoice via popular payment methods such as iDEAL and credit card.
Web services
Methods of exchanging information with third-party applications/services such as financial data, sales invoice data, uploading to the Archive in Yuki, etc.
Peppol
Peppol is a European initiative to standardize e-invoicing. It enables safer sending and receiving of e-invoices to and from governments and other contacts that are also in the secure Peppol network.
Bank connections
Rabobank accounting link with Yuki allowing full automatic delivery of all bank transactions from business checking and savings accounts, foreign currency accounts and G accounts.

Access to Web services

All settings for web services are centralized within your domain and divided into logical categories.

To access these settings:

click on the Settings icon in the navigation bar
then, in the now-opened screen, in the Integrations section click on Web services.

Web service links

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

Should there be a need for more Web service then 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).

Available web services

There are currently twelve Web services available. These web services contain one or more methods of exchanging information:

Accounting web service: Retrieve financial reporting (such as open items and the current balance sheet and Create memorandum entries.
AccountingInfo web service: Retrieving information about general ledger accounts and transactions
Sales web service: Creating sales invoices

ATTENTION!
When submitting sales invoices from e.g. a Webshop, the Small, Medium, Large or Unlimited bundle must be selected by a user with the 'Management' role via the Yuki Store in the domain, because the sales invoices are generated and processed in Yuki based on the data from the link.

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 webservice is included for free.

Upload web service: Retrieve and submit documents
Archive web service: Retrieve and submit documents and View (via app) the archive.
Contact web service: Retrieve relation data and Update or create a relation.
PettyCash web service: Import of cabinet transactions
Domains web service: Create active and trial domains by accountant and Retrieve and create users in a domain.
Projects web service: Creation of new projects (files) and Modification of existing projects (files).
Backoffice web service: Check open queries for backoffice in administration, Retrieve backoffice workflow from administration, Check specific backoffice roles of portal users in domain and Update specific backoffice roles of portal users in domain.
VAT web service: Retrieve statuses of VAT returns submitted in Yuki (from AdminPulse).

For a detailed description of the link between Yuki and Adminpulse, see article Forward status of VAT return submitted from Yuki (NL).
Purchase web service: creation of purchase invoices.

ATTENTION!
To use the Purchase webservice, a formal request must be sent by email to support@yuki.nl.
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 webservice.

For a description of all the available web services in Yuki, see article Yuki API link.

Web service links access

The following steps are required for successful interfacing with external software:

API key and Administration ID:
These must be generated in Yuki to grant external software access without requiring login.
Rights management:
The access rights for web services set at domain or administration level are leading and thus 'override' the settings at portal level.
Realize access to external software:
Add API key and/or the Administration ID in software.

If the software application you want to link with already has a link, then a number of settings need to be defined in that software or with the third party providing the link.

Step 1. Generate web service API key (WebserviceAccessKey) and Administration ID

The web service API key and Administration ID can be generated from different places in Yuki:

click on the Switch domain icon above the navigation bar
click on My domain
click on the administration name
then, in the now-opened screen, click on Web services.
OR
hover your mouse over the Home icon in the navigation bar
click on My domain
click on the administration name
then, in the now-opened screen, click on Web services.
OR
Click on the Settings icon in the navigation bar
then, in the now-opened screen, click on Web services.

TIPS!

If you want to link multiple administrations, you need to create multiple web service API keys.
If you no longer trust the security of an API key, generate a new one!

The following screen is opened:

In this screen click on the + button in order to activate the web services in the domain or the administration and generate a web service API key.

The following screen is opened:

Step 2. Rights management

Specify in the above screen whether you want to generate a web service API key for a 'Domain' or an 'Administration' (select the correct administration), select the web services (all web services or a selection thereof) for which you to grant (access) rights and then click on the Save button.

TIPS!

Select only specific web services to which you want to grant access when building your own link.
If you want to interface with an existing software application then you must select ‘All web services’.

Step 3. Realize access to external software

Then, copy the API key and/or Administration ID to use in your application. In many software applications, the “Access code” field is present.