Prerequisites

Before getting started, please carefully read the following to make sure you fulfill all requirements for the integration to work:

1. You are an admin of your Nmbrs instance or an admin shared their access with you. This is necessary for retrieving the API credentials as explained later in this guide:
   1. Log into your Nmbrs account.
   2. Click on the “User Profile” tab. You can find it on the top right corner of the page:
   
   3. Navigate to the "PROFILE" section of the "USER PROFILE" page, and make sure that your account has the "Administrator" type. If you are not an administrator, find out who is the "Administrator" in your company's Nmbrs instance, and ask them to assign your account the "Administrator" type or to take over the setup process:
2. In general, this guide is written for Nmbrs Business tenants (unless you are part of an accountancy firm, you will have a Business tenant). If you have an Nmbrs Accountant tenant, the guide should still work, however, if you only want give access to the data of a particular client, you may need to log in into the Business sub-tenant of your client with an admin account. 

Find your API domain

Your API domain is the same domain that you use to log in to your Nmbrs account.

Open your Nmbrs login page, you should be able to view your domain here.

Find your User type

1. Click on the “User Profile” tab. You can find it on the top right corner of the page:
   
2. Navigate to the "PROFILE" section of the "USER PROFILE" page, and note down the User type of your account. If you are an administrator, it will likely be "Administrator Gebruiker (Client)" as well (another common user type is "(Scenario 3) General Manager Payroll & HR"). You will need this for the next step. 
   

Assign Permissions

1. Click on the settings cog in the left sidebar, then "TEMPLATE USERS" (it may also be called "USER TEMPLATES"):
   
2. Scroll down until you see the User type of your user that you noted down earlier (it should be in the 'Master Client' section). In this example, the User type was "Administrator Gebruiker", so we are looking for this name. After you have found it, click on the respective cog in the "API" column:
   
   
   
3. Select the relevant service, for example, "Employee Services", from the dropdown:
   
   
   You will find all relevant permissions for your integration listed in the connection flow:
   
   Please note: These might be different for your integration. You will see the correct permissions for your integration, once you go through the connection flow.
   
   
4. Ensure all the right permissions are enabled under each service:
   

Generate API credentials

1. Log into your Nmbrs account.
2. Open the “User Profile” tab. You can find it in the top right corner of the page.
   
   
   
3. In the “User Profile” page, click on the “API TOKEN” tab.
   
   
   

4. Click on the “Activate API Account” button
   
   
   

5. A token should be generated and displayed.
   
   
   

6. Copy the email and token and paste them into the connection flow page. Then click on “Set up Integration”.