Please enable JavaScript to view this site.

Navigation: » No topics above this level «


Download accumulations and balances reports__Activity name :__ GetAccumulationsAndBalancesReportByPayrollAdministrationIdAcquire the reports for either accumulations or balances at the payroll administration level. Currently this endpoint supports following report types to be requested:* baseForCalculationBalancesAtStartOfYear (grondslag begin jaar)* leaveBalancesAtStartOfYear (verlof begin jaar)* leaveAccrualWithinYear (opbouw verlof ulsa)_Please note: this endpoint may only be used to acquire a report in the pdf-type format_

Catalog: LoketNlRest

Schema: PayrollAdministrationReports

This is a read-only table function. The (REST) API may not support changing the data or the Invantive SQL driver for (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the (REST) API.

Select (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/accumulationsandbalancesreport

Insert (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/accumulationsandbalancesreport

Update (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/accumulationsandbalancesreport

Delete (REST) API URL: /providers/employers/payrolladministrations/{payrollAdministrationId}/accumulationsandbalancesreport

Field Selection Method: NotRequired

Select (REST) API Operation: get /providers/employers/payrolladministrations/{payrollAdministrationId}/accumulationsandbalancesreport

Table Function Parameters

The following parameters can be used to control the behaviour of the table function AccumulationsAndBalancesReportByPayrollAdministrationId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.


Data Type


Default Value





The unique identifier of an administration




The type of report that is requested. (Werte: baseForCalculationBalancesAtStartOfYear, leaveBalancesAtStartOfYear, leaveAccrualWithinYear)




A valid year for which the information is requested.


Table Function Columns

The columns of the table function AccumulationsAndBalancesReportByPayrollAdministrationId are shown below. Each column has an SQL data type.


Data Type









13-05-2022 15:37 Version 22.1.40-BETA+3374