# LeaveBalancesByEmployerId The leave balance for all employments __Activity name :__ GetLeaveBalancesByEmployerId Returns the yearly leave balances for all employments Select loket.nl (REST) API URL: /providers/employers/{employerId}/leavebalances Insert loket.nl (REST) API URL: /providers/employers/{employerId}/leavebalances Update loket.nl (REST) API URL: /providers/employers/{employerId}/leavebalances Delete loket.nl (REST) API URL: /providers/employers/{employerId}/leavebalances Select loket.nl (REST) API Operation: get /providers/employers/{employerId}/leavebalances - Catalog: `LoketNlRest` - Schema: `LeaveBalance` - Field Selection Method: NotRequired - Base Path: `_embedded[*]` This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API. ## 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 of Table Function The columns of the table function `LeaveBalancesByEmployerId` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `employee_dateOfBirth` | `datetime` | | ☐ | The date of birth | | `employee_employeeNumber` | `int32` | | ☐ | The employee number to uniquely identify a employee within a employer. | | `employee_firstName` | `string(28)` | | ☐ | The first name of the employee | | `employee_formattedName` | `string(82)` | | ☐ | Formatted name of the employee based on the value of `howToFormatLastName` | | `employee_id` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) | | `employee_initials` | `string(6)` | | ☐ | The initials of the employee | | `employee_lastName` | `string(25)` | | ☐ | The last name of the employee | | `employee_lastNamePartner` | `string(25)` | | ☐ | The last name of the partner of the employee | | `employee_photo` | `string` | | ☐ | 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)` | | ☐ | The prefix of the employee | | `employee_prefixPartner` | `string(10)` | | ☐ | The prefix of the partner of the employee | | `endDate` | `datetime` | | ☐ | The date on which the employment ends. NL: DatumUitDienst | | `historicalStartDate` | `datetime` | | ☐ | 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` | | ☐ | 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` | | ☐ | The unique identifier of an object (GUID/UUID) | | `payrollAdministration_name` | `string(70)` | | ☐ | Name of the payroll administration | | `startDate` | `datetime` | | ☐ | The date on which this employment starts. NL: DatumInDienst |