LeaveBalancesByEmployerId__embeddedLeaveBalance |
The leave balance for all employments__Activity name :__ GetLeaveBalancesByEmployerId Returns the yearly leave balances for all employments
Catalogus: LoketNlRest
Schema: LeaveBalance
Dit is een alleen-lezen tabelfunctie. De Loket.nl REST API biedt mogelijk geen ondersteuning voor het wijzigen van de data of het Invantive UniversalSQL-stuurprogramma voor Loket.nl REST ondersteunt dit niet. In het laatste geval gebruikt u de tabel NativePlatformScalarRequests om gegevens te uploaden naar de Loket.nl REST-API.
Parameters van Tabelfunctie
De volgende parameters kunnen worden gebruikt om het gedrag van de tabelfunctie LeaveBalancesByEmployerId__embeddedLeaveBalance in te stellen. Voor verplichte parameters moet altijd een waarde worden opgegeven, maar optionele parameters hoeven in het algemeen geen waarde te hebben en de uitvoering zal standaard een vooraf bepaald gedrag vertonen. Waarden kunnen worden gespecificeerd op basis van positie en naam. In beide gevallen worden alle niet-gespecificeerde parameters geëvalueerd aan de hand van hun standaardwaarden.
Waardespecificatie op positie gebeurt door alle waarden van de eerste tot de laatste benodigde waarde op te sommen. Bijvoorbeeld: een `select * uit tabel(waarde1, waarde2, waarde3)` op een tabel met vier parameters zal de standaardwaarde voor de vierde parameter gebruiken en de opgegeven waarden voor de eerste drie.
Waardespecificatie op naam gebeurt door alle waarden die een waarde vereisen op te sommen. Bijvoorbeeld met `selecteer * uit tabel(naam1 => waarde1, naam3 => waarde3)` op dezelfde tabel zullen de standaardwaarden voor de tweede en vierde parameter worden gebruikt en de opgegeven waarden voor de eerste en derde.
Naam |
Datatype |
Verplicht |
Standaardwaarde |
Documentatie |
---|---|---|---|---|
employerId |
guid |
☑ |
|
The unique identifier of the employer |
referenceDate |
datetime |
☐ |
|
Set a reference date for the following logic1. To determine the active `function` and `department` of the employment2. To calculate `usageAfterToday` and `usageThroughToday`3. To determine the year for which the leave balance is returnedIf not provided, "today" is used |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie LeaveBalancesByEmployerId__embeddedLeaveBalance worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype.
Naam |
Datatype |
Label |
Verplicht |
Documentatie |
---|---|---|---|---|
accrual |
double |
|
☐ |
The amount of leave units accrued for the leave type in the year |
balance |
double |
Saldo |
☐ |
The remaining leave balance for the year and leave type. The balance takes into account the leave usage in the future. |
balancePreviousYear |
double |
Saldo vorig Jaar |
☐ |
The remaining leave balance from the previous year for the leave type |
employee_dateOfBirth |
datetime |
Medewerker Geboortedatum |
☐ |
The date of birth |
employee_employeeNumber |
int32 |
|
☐ |
The employee number to uniquely identify a employee within a employer. |
employee_firstName |
string(28) |
Medewerker Voornaam |
☐ |
The first name of the employee |
employee_formattedName |
string(82) |
Medewerker Geformatteerde Naam |
☐ |
Formatted name of the employee based on the value of `howToFormatLastName` |
employee_id |
guid |
Werknemer ID |
☐ |
The unique identifier of an object (GUID/UUID) |
employee_initials |
string(6) |
Medewerker Initialen |
☐ |
The initials of the employee |
employee_lastName |
string(25) |
Medewerker Achternaam |
☐ |
The last name of the employee |
employee_lastNamePartner |
string(25) |
|
☐ |
The last name of the partner of the employee |
employee_photo |
string |
Medewerkersfoto |
☐ |
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) |
Medewerker Voorvoegsel |
☐ |
The prefix of the employee |
employee_prefixPartner |
string(10) |
Medewerker Voorvoegsel Partner |
☐ |
The prefix of the partner of the employee |
endDate |
datetime |
Einddatum |
☐ |
The date on which the employment ends. NL: DatumUitDienst |
expires |
double |
|
☐ |
<ul><li>This field is only relevant for the following leave types:</li><li><strong>Wettelijk verlof:</strong> Accrued statutory leave from previous years that expires on July 1 of the selected year.</li><li><strong>Bovenwettelijk verlof:</strong> Accrued extra-legal leave from 5 years ago and earlier, which expires on Jan 1 of the selected year + 1.</li><li><strong>Verlof:</strong> The sum of the two leave types above.</li></ul> |
historicalStartDate |
datetime |
Historische Startdatum |
☐ |
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 |
leaveType_balanceExceedsYear |
boolean |
|
☐ |
Indicates whether the balance at the end of the year for this leave type carries over to the next year. |
leaveType_key |
int32 |
Verloofsoortsleutel |
☐ |
The key for the leave type. |
leaveType_value |
string |
Verlofsoortwaarde |
☐ |
The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type. |
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 |
Salarisadministratie ID |
☐ |
The unique identifier of an object (GUID/UUID) |
payrollAdministration_name |
string(70) |
Naam Salarisadministratie |
☐ |
Name of the payroll administration |
startDate |
datetime |
Startdatum |
☐ |
The date on which this employment starts. NL: DatumInDienst |
usageAfterReferenceDate |
double |
|
☐ |
The amount of leave units used for the leave type in the year after `referenceDate` |
usageThroughReferenceDate |
double |
|
☐ |
The amount of leave units used for the leave type starting from the beginning of the year up to and `referenceDate` |
usageTotal |
double |
Gebruikstotaal |
☐ |
The total amount of leave units used for the leave type in the year. |
year |
int32 |
Jaar |
☐ |
The year to which the balance of the leave type applies. |
10-06-2024 18:51 Versie 24.1.3-BETA+4689