How to insert salary based on a salary table via the API

As an integration partner, the need to insert a salary based on a salarys table via the API can occur. This article provides guidance on this process by combining the technical aspects with the functional ones.

A salary table constitutes of three parts:

  • salary table
  • salary table scale
  • salary table step

To insert the salary, you can use the call SalaryTable_Insert. Here is a step by step on how to use it: 

1. Get the GuidSalaryTable

First, get the guid of the salary table linked to a specific company using SalaryTable2_Get.

The call will return only the salary table that is set up on Company -> Salary Settings (NL). 

<SalaryTable2_Get>
<CompanyId>123456</CompanyId>
<Period>2</Period>
<Year>2023</Year>
</SalaryTable2_Get>

mceclip0.png

2. Get the GuidSalaryTableScale

Use the call SalaryTable2_GetScales to get a list of scales of the company salary table.

<SalaryTable2_GetScales>
<CompanyId>123456</CompanyId>
<Period>2</Period>
<Year>2023</Year>
</SalaryTable2_GetScales>

3. Get the GuidSalaryTableStep

Use the call SalaryTable2_GetSteps to get a list of steps from a specific scale. 

<SalaryTable2_GetSteps xmlns="https://api.nmbrs.nl/soap/v3/CompanyService">
<CompanyId>123456</CompanyId>
<Scale>
<Scale>5</Scale>
</Scale>
<Period>11</Period>
<Year>2022</Year>
</SalaryTable2_GetSteps>

4. Insert salary table step to employee

Use call SalaryTable_Insert to insert a new salary table

<SalaryTable_Insert xmlns="https://api.nmbrs.nl/soap/v3/EmployeeService">
<EmployeeId>{{employeeId}}</EmployeeId>
<SalaryTableId>{{GuidSalaryTable}}</SalaryTableId>
<SalaryTableScaleId>{{GuidSalaryTableScale}}</SalaryTableScaleId>
<SalaryTableStepId>{{GuidSalaryTableStep}}</SalaryTableStepId>
<StartDate>2020-02-10T00:00:00</StartDate>
</SalaryTable_Insert>

Comments

Knowledge base