# LeaveBalanceWorthByEmployerId The leave balanceworth for all employments __Activity name :__ GetLeaveBalanceWorthByEmployerId Returns the yearly leave balances and their worth for all employments This is a read-only table function. The Loket.nl REST API may not support changing the data, or the Invantive UniversalSQL driver for Loket.nl REST does not support it. In the latter case, use the table NativePlatformScalarRequests to upload data to the Loket.nl REST API. - Catalog: `LoketNlRest` - Schema: `LeaveBalance` ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `employerId` | `guid` | ☑ | | The unique identifier of the employer | | `referenceDate` | `datetime` | ☐ | | Set a reference date for the following logic 1. To determine the active `function` and `department` of the employment 2. To calculate `usageAfterToday` and `usageThroughToday` 3. To determine the year for which the leave balance is returned If not provided, "today" is used | ## Columns The columns of the table `LeaveBalanceWorthByEmployerId` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `employee_dateOfBirth` | `datetime` | Employee Date of Birth | ☐ | The date of birth | | `employee_employeeNumber` | `int32` | | ☐ | The employee number to uniquely identify a employee within a employer. | | `employee_firstName` | `string(28)` | Employee First Name | ☐ | The first name of the employee | | `employee_formattedName` | `string(82)` | Employee Formatted Name | ☐ | Formatted name of the employee based on the value of `howToFormatLastName` | | `employee_id` | `guid` | Employee ID | ☐ | The unique identifier of an object (GUID/UUID) | | `employee_initials` | `string(6)` | Employee Initials | ☐ | The initials of the employee | | `employee_lastName` | `string(25)` | Employee Last Name | ☐ | The last name of the employee | | `employee_lastNamePartner` | `string(25)` | | ☐ | The last name of the partner of the employee | | `employee_photo` | `string` | Employee 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. | | `employee_prefix` | `string(10)` | Employee Name Prefix | ☐ | The prefix of the employee | | `employee_prefixPartner` | `string(10)` | Employee Partner Name Prefix | ☐ | The prefix of the partner of the employee | | `endDate` | `datetime` | End Date | ☐ | The date on which the employment ends. NL: DatumUitDienst | | `historicalStartDate` | `datetime` | Historical Start Date | ☐ | The historical date on which the employee was first employed. This field is used when an employee has multiple employments in time. In most cases this field should be used as the date on which the employee started working for the company. NL: HistorischeDatumInDienst | | `id` | `guid` | ID | ☐ | The unique identifier of an object (GUID/UUID) | | `incomeRelationshipNumber` | `int32` | | ☐ | 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. NL: NummerInkomstenVerhouding | | `nonPayrollAdministration_description` | `string(50)` | | ☐ | Description of the administration | | `nonPayrollAdministration_id` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) | | `nonPayrollAdministration_name` | `string(70)` | | ☐ | Name of the non payroll administration | | `organizationalEntity_department_code` | `int32` | | ☐ | | | `organizationalEntity_department_description` | `string` | | ☐ | | | `organizationalEntity_department_key` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) | | `organizationalEntity_deviatingFunctionDescription` | `string(50)` | | ☐ | The deviating function description of the employment. This description deviates from the value of the `function` field. | | `organizationalEntity_deviatingFunctionGroup` | `string(5)` | | ☐ | The deviating function group description of the employment. Only applies when a deviating function description is defined. | | `organizationalEntity_endDate` | `datetime` | | ☐ | The end date of the entity. The date is up to and including. | | `organizationalEntity_function_description` | `string(50)` | | ☐ | | | `organizationalEntity_function_group` | `string(5)` | | ☐ | | | `organizationalEntity_function_key` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) | | `organizationalEntity_placeOfEmployment` | `string(24)` | | ☐ | The standard working location (standplaats) for the employment. | | `organizationalEntity_standardFunction_category` | `int32` | | ☐ | | | `organizationalEntity_standardFunction_code` | `string(6)` | | ☐ | | | `organizationalEntity_standardFunction_key` | `int32` | | ☐ | | | `organizationalEntity_standardFunction_value` | `string` | | ☐ | | | `organizationalEntity_startDate` | `datetime` | | ☐ | The start date of the entity. A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. | | `payrollAdministration_clientNumber` | `int32` | | ☐ | 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. | | `payrollAdministration_description` | `string(50)` | | ☐ | Description of the administration | | `payrollAdministration_id` | `guid` | Payroll Administration ID | ☐ | The unique identifier of an object (GUID/UUID) | | `payrollAdministration_name` | `string(70)` | Payroll Administration Name | ☐ | Name of the payroll administration | | `startDate` | `datetime` | Start Date | ☐ | The date on which this employment starts. NL: DatumInDienst |