Sign in

v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Payroll period data on administration level

List of payroll period data on payroll administration level

Activity name : <a href="https://developer.loket.nl/Activities/GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId" target="_blank">GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId</a>

Get a list of all payroll period data for all the active employment in the given payroll period for the give payroll administration. Payroll period data relates to a single payroll period.

This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.

Metadata : Possible options for the query string parameters can be acquired (GET) via the /metadata endpoint. The URI for this endpoint is ../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/metadata.

Defaults : Default values for the query string parameters can be acquired via the /defaults endpoint. The URI for this endpoint is ../v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/defaults.

get/v2/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata

Path parameters

payrollAdministrationIdstring uuid required

The unique identifier of an administration

payrollPeriodIdinteger required

The unique identifier of the payroll period

Query parameters

payslipTypeinteger required

Controles which payroll period data is returned either for the normal payslip of the tarif payslip.

payrollComponentSetstring uuid

A predefined set of payroll components to filter which payroll components are returned.

Note: Either payrollComponentSet or payrollComponentCategory or payrollComponentId must have a value.

payrollComponentCategoryinteger

A predefined category of payroll components to filter which payroll components are returned.

Note: Either payrollComponentSet or payrollComponentCategory or payrollComponentId must have a value.

payrollComponentIdinteger

A payroll components to filter on.

Note: Either payrollComponentSet or payrollComponentCategory or payrollComponentId must have a value.

This parameter will soon become available.

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Response

OK