invantive documentation
Invantive Support ForumsLog In / Sign Up

AvailablePayrollComponentSetsByPayrollAdministrationId: Loket.nl REST itgen_loketnl_availablepayrollcomponentsetsbypayrolladministrationid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: PayrollComponentSet
  • Label: itgen_loketnl_availablepayrollcomponentsetsbypayrolladministrationid_plural

Available payroll component sets Activity name : GetAvailablePayrollComponentSetsByPayrollAdministrationId Get the available payroll components sets that are available at this level. A payroll component set defines a set of payroll components to be used as a sjabloon preventing the need for users to constatnly select the same set of payroll components. Payroll component set are commonly used when entering payroll period data (variabele gegevens) either for a single employment or for multiple employments (browser variabele gegevens). They are also used as a filter when exporting payroll run results.

Both at the provider level and payroll administration the user may define sets and which components it includes. This endpoint will return an aggregated view of the applicable sets and its corresponding component based on the defined sets at provider and administration level.

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/payrolladministrations/{payrollAdministrationId}/availablepayrollcomponentsets
  • Operation: get /providers/employers/payrolladministrations/{payrollAdministrationId}/availablepayrollcomponentsets

Parameters

Name Data Type Required Default Documentation
payrollAdministrationId `` The unique identifier of an administration

Table Columns

The columns of the table AvailablePayrollComponentSetsByPayrollAdministrationId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
description varchar2(50) Description
id guid ID The unique identifier of the payroll component set that is to be used as default set when editing payroll periode data for all employments of a payroll administration
isDefaultForBrowserPayrollPeriodData char itgen_loketnl_isdefaultforbrowserpayrollperioddata The default set is defined on payroll administration level. To be used for the "browser variabele gegevens" to indication which set of component should be displayed by default.
isDefaultForPayrollPeriodData char itgen_loketnl_isdefaultforpayrollperioddata The default set is defined on payroll administration level. To be used for the "variabele gegevens" for an employment to indication which set of component should be displayed by default.
isDefinedOnProviderLevel char itgen_loketnl_isdefinedonproviderlevel The set is defined at either the provider or at the payroll administration level. If this indication is true then the set was defined at provider, if false than it is defined at payroll administration level.
type_key int32 itgen_loketnl_type_key
type_value varchar2 itgen_loketnl_type_value

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: