invantive documentation
Invantive Support ForumsLog In / Sign Up

DeclarationsByEmployerId: Loket.nl REST itgen_loketnl_declarationsbyemployerid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: Declarations
  • Label: itgen_loketnl_declarationsbyemployerid_plural

List of declarations for the employees of an employer Activity name : GetDeclarationsByEmployerId

Returns a list of declarations for the employments of the employer

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/{employerId}/employees/employments/declarations
  • Operation: get /providers/employers/{employerId}/employees/employments/declarations

Parameters

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

Table Columns

The columns of the table DeclarationsByEmployerId 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
calculatedDistanceByRoutingService double itgen_loketnl_calculateddistancebyroutingservice The value calulated by the routing service
dateOfLastChangeByEmployee datetime itgen_loketnl_dateoflastchangebyemployee The time the declaration was last changed
dateOfSubmissionByEmployee datetime itgen_loketnl_dateofsubmissionbyemployee The time the declaration was submitted
declarationComment varchar2(1000) itgen_loketnl_declarationcomment The comment left by the employee
declarationDate datetime itgen_loketnl_declarationdate The date to which the declaration is applicable. As requested by the employee.
declarationStatus_key int32 itgen_loketnl_declarationstatus_key
declarationStatus_value varchar2 itgen_loketnl_declarationstatus_value
employmentInformation_department_code int32 itgen_loketnl_employmentinformation_department_code
employmentInformation_department_description varchar2 itgen_loketnl_employmentinformation_department_description
employmentInformation_department_key guid itgen_loketnl_employmentinformation_department_key The unique identifier of an object (GUID/UUID)
employmentInformation_employeeNumber int32 itgen_loketnl_employmentinformation_employeenumber The employee number to uniquely identify an employee within an employer
employmentInformation_firstName varchar2(28) itgen_loketnl_employmentinformation_firstname The first name, given name, forename or Christian name as part of a persons personal name.
employmentInformation_formattedName varchar2(82) itgen_loketnl_employmentinformation_formattedname Formatted name of the employee based on the value of howToFormatLastName
employmentInformation_function_description varchar2(50) itgen_loketnl_employmentinformation_function_description
employmentInformation_function_group varchar2(5) itgen_loketnl_employmentinformation_function_group
employmentInformation_function_key guid itgen_loketnl_employmentinformation_function_key The unique identifier of an object (GUID/UUID)
employmentInformation_id guid itgen_loketnl_employmentinformation_id The unique identifier of an object (GUID/UUID)
employmentInformation_incomeRelationshipNumber int32 itgen_loketnl_employmentinformation_incomerelationshipnumber The income relationship number that is required in the tax return. Together with the citizen service number (burgerservicenummer, BSN) and wage tax number, the income relationship number uniquely identifies an employment.
employmentInformation_payrollAdministration_clientNumber int32 itgen_loketnl_employmentinformation_payrolladministration_clientnumber 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.
employmentInformation_payrollAdministration_description varchar2(50) itgen_loketnl_employmentinformation_payrolladministration_description Description of the administration
employmentInformation_payrollAdministration_id guid itgen_loketnl_employmentinformation_payrolladministration_id The unique identifier of an object (GUID/UUID)
employmentInformation_payrollAdministration_name varchar2(70) itgen_loketnl_employmentinformation_payrolladministration_name Name of the payroll administration
employmentInformation_photo varchar2 itgen_loketnl_employmentinformation_photo A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
id guid ID The unique identifier of an object (GUID/UUID)
numberOfUnits double Number of Units The number of units requested
payrollComponent_deductionOrPayment_key int32 itgen_loketnl_payrollcomponent_deductionorpayment_key
payrollComponent_deductionOrPayment_value varchar2 itgen_loketnl_payrollcomponent_deductionorpayment_value
payrollComponent_description varchar2(14) Payroll Component Description The description of the payroll component
payrollComponent_deviatingDescription varchar2(50) itgen_loketnl_payrollcomponent_deviatingdescription A longer and more user-friendly description of the payroll component.
payrollComponent_key int32 Payroll Component Key The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know it by heart.
payrollComponent_routeType_key int32 itgen_loketnl_payrollcomponent_routetype_key
payrollComponent_routeType_value varchar2 itgen_loketnl_payrollcomponent_routetype_value
processedInPayrollPeriod_periodEndDate datetime itgen_loketnl_processedinpayrollperiod_periodenddate The last day of the period
processedInPayrollPeriod_periodNumber int32 itgen_loketnl_processedinpayrollperiod_periodnumber The period (month [1 to 12] , 4 weeks [1 to 13] or week [1 to 53]) of the payroll period
processedInPayrollPeriod_periodStartDate datetime itgen_loketnl_processedinpayrollperiod_periodstartdate The first day of the period
processedInPayrollPeriod_year int32 itgen_loketnl_processedinpayrollperiod_year The year of the payroll period
reasonForDeviatingFromCalculatedDistance varchar2(1000) itgen_loketnl_reasonfordeviatingfromcalculateddistance The reason why the employee deviated form the calculated distance.

Release Notes

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