Please enable JavaScript to view this site.

Navigation: » No topics above this level «


Year-end statements for the payroll administration__Activity name :__ GetYearEndStatementsByPayrollAdministrationIdGet a list of year-end statements (i.e. list of years for which year-end statements are available) for a payrolladministration.The year-end statements at administration level are effectively a collection of year-end statements for its underlying employments. However it may also be required at the administration level in one call.

Catalog: LoketNlRest

Schema: Year-endStatementAtAdministrationLevel

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}/yearendstatements

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

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

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

Field Selection Method: NotRequired

Base Path: _embedded[*]

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

Table Function Parameters

The following parameters can be used to control the behaviour of the table function YearEndStatementsByPayrollAdministrationId. 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


Table Function Columns

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


Data Type







The year for which a year-end statement is available.


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