API NL and SE

 

The Nmbrs have different payroll features available for NL and SE. Payroll related modules are country specific, therefore different functionalities have to be available to handle it. The API follows the same logic as the webapp and when there are different dashlets, the API offers different calls. 

 

Glossary

Dashlet: a specific functionality in Nmbrs 

dashlet.png

 

Shared calls

Most of the dashlets use the same call for NL and SE.  

 

Exactly the same 

  • Hour components
  • Wage components
  • Bank account

Differences within a call

Personal info

NL has more fields available to fill. The same call can be used in NL and SE, therefore in SE only the available fields will be shown.  

image-20200604-110644.png

Address

The house number / suffix is the only difference between NL and SE.

image-20200604-111017.png

Salary

In NL, there is the concept of salary table, but it does not exist in SE.

image-20200604-110822.png

Contract

Due to the WAB changes, NL has two more fields than SE regarding contracts: written contract and contract hours per week. 

image-20200604-111219.png

 

Different calls

Some dashlets are completely different in NL and SE, and consequently in the API.

 

Schedule 

NL -> Schedule [Schedule_Get, Schedule_GetAll_AllEmployeesByCompany, Schedule_GetCurrent, Schedule_GetList, Schedule_Update, Schedule_UpdateCurrent]

SE -> Time Schedule [TimeSchedule_AllEmployee_GetListByPeriod, TimeSchedule_DeleteByID, TimeSchedule_GetAll, TimeSchedule_GetListByPeriod, TimeSchedule_Insert]

image-20200604-111454.png

Time registration

Only exists in SE. 

image-20200604-111909.png

 

How to know which calls are from NL and SE?

On the specification, there is a tag NL-only or SE-only identifying which calls are country specific. 

Also, there is a error code that informs the developer when a call is not available for that specific country: 

3001: This call is not available in your country

For example, if the call TimeRegistration_GetList is called with authentication of a user that belongs to NL environment, then it will return the above error message. 

 

 

Comments

Knowledge base