Nmbrs® API enumerations

The following page is a collection of different enumerations required in Nmbrs® API calls. 

↓ Absence 

API calls

Comment

The comment needs to be inserted as a string. 

Percentage

You can insert the percentage by filling in a value between 0 and 100.

Dossier

You can insert the dossier type by filling in the field <Dossier>string</Dossier> with on of the following values:

1.  Ziekte
2.  Ziekte door zwangerschap (vangnet)
3.  Ziekte heringetreden arbeidsgehandicapte (vangnet)
4.  Ziekte door orgaandonatie (vangnet)
5.  Zwangerschapverlof
6.  Adoptie / Pleegzorg
7.  Ziekte door bevalling

↓ Active

Active

Used in List_GetByCompany and List_GetByDebtor of EmployeeService for filtering employees).

Value

Int

active

0

notActive

1

all

2

↓ BankAccountType

BankAccountType

Value

Int

None

0

Bankrekening1

1

Spaarloon

2

Bankrekening2

3

Bankrekening3

4

Bankrekening4

5

Bankrekening5

6

Standaard

7

Levensloop

8

↓ Company period 

When the user creates a company the company period is chosen. The company periods indicated the payment cycle of a company. After company period is created it can't be changed. 

Company Period type

To get company period type use operation Company_GetCurrentPeriod from CompanyService or Employee_GetCurrent from EmployeeService.

To get the CompanyId for method Company_GetCurrentPeriod see How to get CompanyId?

To get EmployeeId for method Employee_GetCurrent see How to get EmployeeId?

If the request is success you will get a period in the format = yyyy-pp-type where:

  • M - month company. Total of 12 periods.
  • W4 - 4 week company. Total of 13 periods.
  • W1 - 1 week company. Total of 52 periods. In year 2026 there are 53 periods. 

Current period of the compay

Most information in Nmbrs is period based. With methods above you can also get the current period of the company. To know the current period of the company is important when you want to get information from or to send information to Nmbrs. 

When you know the current period of the company you know that all information that you will send in current period will be processed in payroll. 

↓ ContractType and EmployementType 

Contract Type

Contract Type Number
Labour Agreement 14
Internship Agreement 15
On-call Agreement 16
Engagement Agreement 17
External Employment Contract 18

 

Employment Type

EmployementType Number
Arbeidsovereenkomst 1
Deelvisser 4
Musicus/artiest 6
Stagiair 7
Wet Sociale Werkvoorziening (WSW) 10
Uitzendkracht 11
Publiekrechtelijke aanstelling 18
Opting-in regeling 79
Overige fictieve dienstbetrekkingen 81

↓ Employee Address

Countrycode

Country codes: http://nmbrs.zendesk.com/entries/20157212-land-code

Type

HomeAddress  
PostAddress  
WeekendAddress  
AbsenceAddress  
HolidaysAddress

↓ Employee documents

Employee document type <emp:GuidDocumentType>

API Guid Description
b7c39468-7acc-4b34-899b-f7989a044eca Contract
1c044ac5-da75-42f8-bf7b-ea6195c3cbbf Certificate
07c8a39b-06aa-4903-8372-2713f35ee8a9 Picture
8461e504-d35e-4639-90d3-286d42349efc Employee Picture
c586bcb1-c909-4fcc-a204-af3303f073c1 Identity document
726fa8fb-2350-493e-aa7e-5a8b7446ddc8 Wage Tax Declaration
d9dc1190-eb6b-4e04-bba3-39e900205307 Employee Login File
c21d471a-2d8c-47a7-b8c4-9bde8d188b13 Other
b66be3b9-f524-4f86-9ed6-6b2ea6d5a2c7 Planning

 

↓ Lease car contract

ReasonNoContribution 

Int 

Description

0

Niet van toepassing

1

Afspraak via werkgever met Belastingdienst

2

Werknemer heft beschikking Belastingdienst

3

Andere bewijs personen- en bestelauto

5

Doorlopend afwisselend gebruik bestelauto

6

0% bijtelling (N.v.t. na 2018)

7

Werknemer heft verklaring uitsluitend zakelijk gebruik bestelauto Belastingdienst

ContributionPrivatePercentage

Int 

Description

0

Handmatig

1

25,00% / Overige

2

20,00% / diesel 20%

3

14,00% / Diesel 14%

4

20,00% / Benzine 20% (N.v.t. na 2018)

5

14,00% / Benzine 14% (N.v.t. na 2018)

6

0,00%  / Auto’s zonder bijtelling (N.v.t. na 2018)

7

35,00% / Auto’s 15 jaar en ouder

8

4,00% / 4%

9

7,00% / 7%

10

15,00% / 15%

11

21,00% / 21%

12

22,00% / 22%

13

4,00% / 4% t/m 50.000, 22% vanaf 50.000

14

7,00% / 7% t/m 50.000, 25% vanaf 50.000

 

↓ Leave

Type of leave

Int 

Description

Type1

Leave group 1 that is set up in the environment

Type2

Leave group 2 that is set up in the environment

Type3

Leave group 3 that is set up in the environment

Type4 

Leave group 4 that is set up in the environment

Soort

 

Int 

Description

Withdrawal

1

Is  "Opname" in the interface 

Store

2

Is "Opbouw" in the interface 

Expired

3

Verlopen

 

↓ Personal info

IdentificationType

Type  Description
0 Not specified
1 Dutch passport
2 Tourists card (youth)
3 Municipal id card
4 Residence permit (A-E)
5 New Residence permit
6 W-Document
7 Unidentified Persons Passport
8 Refugee Passport Residence permit
9 Foreign passport with
10 National id card
11 EU Passport

Gender

Gender
undefined
male
female

CountryOfBirthISOCode

Country codes: http://nmbrs.zendesk.com/entries/20157212-land-code

NationalityCode

Nationality codes: http://nmbrs.zendesk.com/entries/20157217-Code-nationaliteiten

BurgerlijkeStaat (Marital state)

Type  Type for GetAll method Description
- 10 Not specified
Duurz. Gescheiden 6 Permanently divorced
Gehuwd 1 Married
Ongehuwd 2 Unmarried
Reg. Partner 7 Registered partner
Samenwonend 5 Living together
Weduwe/Weduwnaar 8 Widow/Widower

Naamstelling (Named)

Type  Description
0 Not specified
1 Only own name
2 Only partnername
3 Partner name own name
4 Own name partner name

↓ Salary

Type salary

ID (Salary_v2) Type (Salary) Description
0 None Not specified
1 Bruto_Salaris_Fulltime Gross payment full time
2 Bruto_Salaris_Partime Gross payment part time
3 Bruto_Uurloon Gross hourly wage
4 Netto_Salaris_Partime_incl_looncomp Nett payment part time including added components
5 Netto_Salaris_Partime_excl_looncomp Nett payment part time excluding added components
6 Netto_Uurloon_excl_looncomp Nett hourly wage excluding added components
7 Werkgerverslasten Payment based on employer costs
8 Netto_Uurloon_incl_looncomp Nett hourly wage including added components

↓ SVW

SVW

 API code Description  
1 A | Niet verzekeringsplichtig omdat persoon ook niet verzekerd is voor AWBZ  
2 B | Niet verzekeringsplichtig omdat persoon ook militair ambtenaar is in werkelijke dienst of met buitengewoon verlof  
7 G | Niet verzekeringsplichtig omdat persoon buitenlands artiest of buitenlands beroepssporter is of behoort tot een buitenlands artiestengezelschap of sportploeg waarbij code loonbelastingtabel 221, 224 of 225 is toegepast.  
8 H | Wel verzekeringsplichtig, geen tarief toegepast omdat persoon binnenlands artiest is waarbij code loonbelastingtabel 220 is toegepast  
11 K | Wel verzekeringsplichtig, normaal tarief  
12 L | Wel verzekeringsplichtig, afwijkend tarief zeelieden  
13 M | Wel verzekeringsplichtig, verlaagd tarief  
14 N | Wel verzekeringsplichtig, meer tarieven toegepast  

SVW Contribution

 API code Description (Inkomens afhankelijke bijdrage ZVW)
1 0 | None
2 1 | Hoog% + Vergoeding inkomensafhankelijke bijdrage Werkgever
3 2 | Laag% + Vergoeding inkomensafhankelijke bijdrage Werkgever
6 3 | Laag% + Zonder inkomensafhankelijke bijdrage Werkgever

Influence Insurance

 API code Description (Invloed verzekeringsplicht)
0 0 | Geen invloed
A A | Familie van eigenaar
4 B | Vorige eigenaar
5 D | Oproep/invalkracht zonder verplichting om te komen
6 E | Oproep/invalkracht met verplichting om te komen

Premium Reduction

 API code Description (Premiekorting)
1 0 | Geen arbeidsgehandicaptenkorting
8 5 | Werknemer met een arbeidshandicap
9 6 | Werknemer van 50 jaar of ouder die vanuit een bepaalde uitkeringssituatie in dienst is getreden
18 10 | Overgangsregeling Premievrijstelling WAO/WIA basis premie (60,5 jaar tot 62 jaar)

↓ Wagetax

Wagetax <loonheffing>

API code Description
true Wagetax is applied
false Wagetax is not applied

Wage tax/ reduced fare <Loonheffingkorting>

API code Description
true Wage tax/ reduced fare is applied
false Wage tax/ reduced fare is not applied

Advantage rule <Voordeelreg>

API code Description
true Advantage rule is applied
false Advantage rule is not applied

Color table <KleurTabel>

API code Description
1 White
2 Green

Period table <TijdvakTabel>

API code Description
2 Month table
3 Week Table
4 4-Week Table
5 Day table

Special table <SpecialeTabel>

API code Description
0 None
3 A/G Employee Insurance Obligation Only
5 B/H Employee Wage Tax Obligation Only
6 C/I Employee Wage Tax Obligation and No Insurance Obligation Wlz
7 D/J Employee Wage Tax Obligation and Insurance Obligation Wlz Only
210 Contractors, Homeworkers and Equivalents
220 Domestic Artist or Professional Athlete
221 Foreign Artist or Professional Athlete
224 Foreign Artist Groups or Sports Teams
225 Foreign Artist Reduced Rate Based on Min. Agreement
226 F/L Employee No Wage Tax Obligation and Insurance Obligation Wlz Only
227 K Employee No Wage Tax Obligation and Insurance Obligation ANW Only
228 E Employee No Wage Tax Obligation and Insurance Obligation AOW/ANW Only
280 Student Conditions
940 52%-Rate Anonymous Employee
999 Other Cases No Table Applied

Income type <SoortInkomen>

API code Description
11 Wage or salary officials Public Service Law 1929
12 Wage and salary employees subsidized or budgeted institutions, including implementing Agency social security ZFS
13 Wage or Salary Directors of NV / BV, Insured for Employee Insurances
14 Wage or salary other employees Not Insured by Law on Occupational Disability Insurance
15 Wage and salary Employees not listed
17 Wage or Salary Directors of NV / BV, Not Insured for Employee Insurances
18 Redundancy of a Government Institution
21 Pensions, Annuities, etc. (not 23 (War and Resistance Pensions)
22 Payment AOW
23 War and Resistance Pensions
24 Payment ANW
31 Payment ZW and Voluntary ZW
32 Payment WAO and private insurance disease, disability and accident
33 Payment nWW
34 Payment IOAW
35 Continuation Payment nWW
36 Payment WAZ
37 WAJONG
38 Concurrence (simultaneously or sequentially) Payment WAJONG with WAZ or WAO
39 Payment IVA
40 Payment WGA
42 Payment Bbz
43 Payment WWB
45 Payment IOAW
46 Supplementary Benefits Law
50 Payment other Social Security Laws incl. Accident Laws 1921, 1922 and 1919
52 Payment Law on Income Provisions for Older unemployed

Special annual salary rate <JaarloonBT>

API value  Description
amount The yearly estimated employee income including reservation(s), example: 25000.00

Different special rate (optional) <AfwBijzTariefLH>

API value  Description
percentage the special rate percentage, example: 43.00

Vacation-vouchers <VakantieBonnen>

API value  Description
0 No Holiday Vouchers
1 Holiday Vouchers < 20 Holidays
2 Holiday Vouchers > 20 Holidays

30% Arrangement <CodeCalc30PercRule>

API value  Description
0 None
1 Gross Deduction / Net Compensation
2 Reduced Salary / Net Compensation

Opmerkingen

Mogelijk gemaakt door Zendesk