invantive documentation
Invantive Support ForumsLog In / Sign Up

PayrollAdministrationConfigurationsByEmployerId: Loket.nl REST itgen_loketnl_payrolladministrationconfigurationsbyemployerid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: PayrollAdministration
  • Label: itgen_loketnl_payrolladministrationconfigurationsbyemployerid_plural

List of payroll administrations configurations for an employer Activity name : GetPayrollAdministrationConfigurationsByEmployerId

Get a list of all payroll administration configurations for an employer

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/{employerId}/payrolladministrations/configurations
  • Operation: get /providers/employers/{employerId}/payrolladministrations/configurations

Parameters

Name Data Type Required Default Documentation
employerId `` The unique identifier of the employer

Table Columns

The columns of the table PayrollAdministrationConfigurationsByEmployerId 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
clientNumber int32 Client Number The client number is a unique number for administrations that are used for payrolling. This field has no value if the administration is not used for payrolling.
defaults_calculateUsingWorkPattern_daysDailyRate char itgen_loketnl_defaults_calculateusingworkpattern_daysdailyrate Indicates whether the number of days of dailyrate should be calculated based on the workpattern. The number of days are normally calculated by the working hours.
defaults_calculateUsingWorkPattern_deviatingDaysAndHours char itgen_loketnl_defaults_calculateusingworkpattern_deviatingdaysandhours Indication whether the deviating hours per week and deviating SV-days per period are to be automatically calculated based on the workpattern. Please note (!) that any values in the deviatingHoursPerWeek and deviatingSvDaysPerPeriod fields (of this workingHours record) will be overwritten based on this calculation if true (and endDate=NULL)!
defaults_calculateUsingWorkPattern_hoursBrokenPeriod char itgen_loketnl_defaults_calculateusingworkpattern_hoursbrokenperiod Indicates whether the hours for the payrolling should be calculated based on the workpattern in broken periods. These are periods of in or out of service.
defaults_calculateUsingWorkPattern_hoursRegularPeriod char itgen_loketnl_defaults_calculateusingworkpattern_hoursregularperiod Indicates whether the hours for the payrolling should be calculated based on the workpattern for regular periods.
defaults_componentSet_payrollPeriodDataCollectiveCategory_key int64 itgen_loketnl_defaults_componentset_payrollperioddatacollectivecategory_key
defaults_componentSet_payrollPeriodDataCollectiveCategory_value varchar2 itgen_loketnl_defaults_componentset_payrollperioddatacollectivecategory_value
defaults_componentSet_payrollPeriodDataCollectiveComponentSet_description varchar2 itgen_loketnl_defaults_componentset_payrollperioddatacollectivecomponentset_description
defaults_componentSet_payrollPeriodDataCollectiveComponentSet_id guid itgen_loketnl_defaults_componentset_payrollperioddatacollectivecomponentset_id
defaults_componentSet_payrollPeriodDataCollectiveComponentSet_registrationLevel varchar2 itgen_loketnl_defaults_componentset_payrollperioddatacollectivecomponentset_registrationlevel The level at which the set is defined.
defaults_componentSet_payrollPeriodDataEmployeeSelfService_description varchar2 itgen_loketnl_defaults_componentset_payrollperioddataemployeeselfservice_description
defaults_componentSet_payrollPeriodDataEmployeeSelfService_id guid itgen_loketnl_defaults_componentset_payrollperioddataemployeeselfservice_id
defaults_componentSet_payrollPeriodDataEmployeeSelfService_registrationLevel varchar2 itgen_loketnl_defaults_componentset_payrollperioddataemployeeselfservice_registrationlevel The level at which the set is defined.
defaults_componentSet_payrollPeriodDataIndividual_description varchar2 itgen_loketnl_defaults_componentset_payrollperioddataindividual_description
defaults_componentSet_payrollPeriodDataIndividual_id guid itgen_loketnl_defaults_componentset_payrollperioddataindividual_id
defaults_componentSet_payrollPeriodDataIndividual_registrationLevel varchar2 itgen_loketnl_defaults_componentset_payrollperioddataindividual_registrationlevel The level at which the set is defined.
defaults_componentSet_payrollPeriodDataLeave_description varchar2 itgen_loketnl_defaults_componentset_payrollperioddataleave_description
defaults_componentSet_payrollPeriodDataLeave_id guid itgen_loketnl_defaults_componentset_payrollperioddataleave_id
defaults_componentSet_payrollPeriodDataLeave_registrationLevel varchar2 itgen_loketnl_defaults_componentset_payrollperioddataleave_registrationlevel The level at which the set is defined.
defaults_componentSet_payrollPeriodDataWerkkosten_description varchar2 itgen_loketnl_defaults_componentset_payrollperioddatawerkkosten_description
defaults_componentSet_payrollPeriodDataWerkkosten_id guid itgen_loketnl_defaults_componentset_payrollperioddatawerkkosten_id
defaults_componentSet_payrollPeriodDataWerkkosten_registrationLevel varchar2 itgen_loketnl_defaults_componentset_payrollperioddatawerkkosten_registrationlevel The level at which the set is defined.
defaults_employmentContractType_key int32 itgen_loketnl_defaults_employmentcontracttype_key
defaults_employmentContractType_value varchar2 itgen_loketnl_defaults_employmentcontracttype_value
defaults_employmentDurationType_key int32 itgen_loketnl_defaults_employmentdurationtype_key
defaults_employmentDurationType_value varchar2 itgen_loketnl_defaults_employmentdurationtype_value
defaults_grossWageType_key int32 itgen_loketnl_defaults_grosswagetype_key
defaults_grossWageType_value varchar2(50) itgen_loketnl_defaults_grosswagetype_value
defaults_mdvNotification char itgen_loketnl_defaults_mdvnotification Indicate if a Mdv (melding dienstverband) should be send.
defaults_netWageType_key int32 itgen_loketnl_defaults_netwagetype_key
defaults_netWageType_value varchar2(50) itgen_loketnl_defaults_netwagetype_value
defaults_payslipAvailableForEmployeeDay int64 itgen_loketnl_defaults_payslipavailableforemployeeday The default day (number) of the period on which payslips will be made available for employees.
defaults_typeOfEmployee_key int32 itgen_loketnl_defaults_typeofemployee_key
defaults_typeOfEmployee_value varchar2 itgen_loketnl_defaults_typeofemployee_value
description varchar2(50) Description Description of the administration
endDate datetime End Date The last day the administration is active.
holidayAllowanceBaseForCalculation_key int32 itgen_loketnl_holidayallowancebaseforcalculation_key
holidayAllowanceBaseForCalculation_value varchar2(50) itgen_loketnl_holidayallowancebaseforcalculation_value
holidayAllowancePercentage double Holiday Allowance Percentage The percentage of the holidayAllowance.
id guid ID The unique identifier of an object (GUID/UUID)
payrollPeriodType_key int32 Payroll Period Type Key
payrollPeriodType_value varchar2(50) Payroll Period Type Value
startDate datetime Start Date The first day the administration is active.
synchronize_contactInformation char itgen_loketnl_synchronize_contactinformation Synchronize contact information from employer to administration
synchronize_nameAndAddress char itgen_loketnl_synchronize_nameandaddress Synchronize name and address information from employer to administration
yearEndBaseForCalculation_key int32 itgen_loketnl_yearendbaseforcalculation_key
yearEndBaseForCalculation_value varchar2(50) itgen_loketnl_yearendbaseforcalculation_value
yearEndPercentage double Year End Percentage The percentage of the year end bonus.

Release Notes

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