Set up REST API Loket link

Modified on Mon, 31 Mar at 3:18 PM

Disclaimer

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


Loket.nl is integrated with Yuki. The link with Loket makes it possible to automatically retrieve salary slips, journal entries and payroll tax assessments from Loket and then automatically import them into Yuki.


Only salary slips and journal entries for the current month can be retrieved automatically via the Loket link. With regard to payroll tax assessments, Yuki can automatically retrieve payroll tax assessments from the previous and current month.


ATTENTION!

An activated Loket link for a domain can be used for all administrations in that domain.

This means that all administrations in Yuki get an active payroll contract.


To realize the REST API Loket link with Yuki, the following steps must be taken:

  1. Create default user in Loket.nl
  2. Set up REST API Loket link in portal
  3. Change domain contract
  4. Set up REST API Loket link in domain and administration.

Step 1: Create default user in Loket.nl

To realize the link, a default user must be created in Loket.nl especially for the link.


Please note the following when creating this user:

  • The user must be a new default Loket.nl user (explicitly not a web service user) that is specifically created for the link and is not used for anything else.
  • The user must be active (not blocked).
  • The user must have access to the employer. This can be done through teams or by creating the user directly with the employer.
  • The user must have the appropriate rights, either individually or through the team (see article Rechten bestand RESTful API):
    • Raadplegen dienstverbanden (Consult employee records)
    • 940 journaliseren (Journalize 940)
    • Exporteren journaalrun (Export journal run)
    • Raadplegen loonaangifte (Consult payroll tax assessment)
    • Raadplegen loonoutput (Consult payroll output). 


For more information see also Handleiding koppeling externe partijen of Loket.nl. If you have any questions about creating users in Loket.nl, you can ask Loket.nl.


Stap 2: Set up REST API Loket link in portal

To link Loket with Yuki, two things need to be set up in the portal:

  • Authorization by Loket 
    To do this, log in via the portal using the login details (username and password) from your Loket.nl account.
  • Set up automatic import of payroll documents
    Specify whether or not payroll documents should be retrieved automatically. If yes, specify which payroll documents and when they should be retrieved. 


Only a user with the 'Portal administrator' or 'Portal back office' role can set up the REST API Loket link in the portal.


Authorization by Loket

In the accountant portal, click on the Settings icon at the top right of your screen.



Then click on Loket settings in the now-opened screen.


The following screen is opened:



Click on the Connect with Loket button to set up the Loket link.


The following screen is opened:



Enter the login details (username and password) of your Loket.nl account and then click on the Login button.


The following screen is opened:



Click on the Toestaan button.


When the Loket link has been established correctly, a green checkmark will appear behind Loket authorized.



Set up automatic import of payroll documents

Yuki can automatically retrieve pay slips, journal entries and payroll tax assessments from Loket.


The automatic retrieval of payroll documents from Loket can be enabled by selecting the Automatically import payroll documents option.


ATTENTION!

All the settings you define here for automatically importing payroll documents apply to all domains and administrations you manage with an active payroll contract.



You then define the settings for the automatic import of the payroll documents:

  • Import pay slips automatically or not
  • Import journal entries automatically or not
  • Import payroll tax assessment automatically or not
  • First day of current month from when payroll documents are automatically imported
  • Last day of the current month on which payroll documents are automatically imported.


TIP!

Yuki recommends leaving at least seven days between the option 'First day of current month from which payroll documents are automatically imported' and the option 'Last day of the current month on which salary documents are automatically imported'.


Then click on the Save button.


Step 3: Change domain contract

In a domain the accountant must activate the REST API Loket link by clicking on the Contract button and then clicking on the Add accountant features button.


For a detailed description, see article Manage accountant features.


Step 4: Set up REST API Loket link in domain and administration

To link Loket with Yuki, three things need to be arranged/set up in the domain:

  • Enter client number and payroll tax number
  • Authorization by Loket 
  • Set up automatic import of payroll documents
    Specify whether or not payroll documents should be retrieved automatically. If yes, which payroll documents and when should they be retrieved.


Only a user with the 'Portal administrator' role or a 'Back office' role in the domain can set up and then use the REST API Loket link in the domain and the administration.


Enter Client number and payroll tax number

To set the client number and payroll tax number in the domain, open the appropriate domain. At the top left of your screen, click on the Switch domain icon and then click on My domain.


In the now-opened screen, click on the name of the administration that should be linked to Loket.



In the now-opened screen, open the Administration tab and then click on the Edit button.


Enter the client number of your Loket.nl account in the Contact code field in Yuki. Click on the Save button. 

The client number can only be found in the Classic version of Loket.

To open the Classic version of Loket, click on the 'Ga naar Loket.nl Classic' menu option in Loket.



On the 'Adm' tab you will find the Client number of your Loket.nl account.



Then open the Taxes tab.



Enter the payroll tax number in the Payroll tax number field. Then click on the Save button.


Authorization by Loket

Move your mouse over the HR icon in the navigation bar and then click on Loket Rest service in the now-opened screen (Loket service is the old Loket link).


Only a user with the 'Portal administrator' role or a 'Back office' role in the domain can use the Loket link in the domain.


In the now-opened screen, click on the Settings button (cog icon). The following screen is opened:



If the administration should use the same access code as the portal, select the Use the access codes set in the portal option.


If the administration needs to be linked to another Loket.nl environment, do NOT enable this option.


Then click on the Log in wiht your Loket.nl account button. The following screen is opened:



Enter the login details (username and password) of your Loket.nl account and then click on the Login button.


The following screen is opened:



Click on the Toestaan button.


When the Loket link is established correctly, a green check mark appears behind Loket authorized.



Set up automatic import of payroll documents

Yuki can automatically retrieve pay slips, journal entries and payroll tax assessments from Loket.


The automatic retrieval of payroll documents from Loket can be enabled by selecting the Automatically import payroll documents option.


ATTENTION!

If you want to use the same import settings in the administration as those of the portal, select the Use the portal payroll import settings option.



You then define the settings for the automatic import of the payroll documents for the administration:

  • Import pay slips automatically or not
  • Import journal entries automatically or not
  • Import payroll tax assessment automatically or not
  • First day of current month from when payroll documents are automatically imported
  • Last day of the current month on which payroll documents are automatically imported.


TIP!

Yuki recommends leaving at least seven days between the option 'First day of current month from when payroll documents are automatically imported' and the option 'Last day of the current month on which payroll documents are automatically imported'.


Then click on the Save button.


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 at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article