Loket.nl REST API Data Model
PayrollPeriodResultsByEmploymentIdAndYear |
Get payroll period results of an employment for a year__Activity name :__ GetPayrollPeriodResultsByEmploymentIdAndYearDownload the payroll results (conform overzicht strook) of an employment per payroll period for the provided year.**Please note the following:** There is a major functional difference between acquiring the payslips per payroll run or acquiring payroll results per payroll period(in this case a year). In Loket, for each (approved) run there will be payroll results for that run. Each employment with any results in that payroll run will have (one or more) payslips, these are the payroll results/ payslips for that run. Often these results relate to the payroll period for which that payroll run is performed, but the results may apply to other payroll periods. __For example:__ the payroll run for March may contain results that apply to the months January and/or February. (this may occur within a specific year)* Requesting payslips/results per RUN will provide you all payroll results from that specific payrollrun regardless of the period it applies to.* Requesting PERIOD results will provide you all (approved) payroll results for that period regardless of the payroll run it comes from.De facto the payslips/results per RUN are your actual payslips (loonstrook). The results per period are more useful as an overview per period (overzichtstrook).One more remark: the response of this endpoint is dependent on the role of the user. If the user has role 'werknemer' than the results shown are only based on those approved payroll runs where the ESS-date is on or before today. For other users the results will contain data from all approved payroll runs regardless of ESS-date.
Catalogus: LoketNlRest
Schema: Payslip
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 PayrollPeriodResultsByEmploymentIdAndYear 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 |
|---|---|---|---|---|
employmentId |
guid |
☑ |
|
The unique identifier of the employment |
year |
int32 |
☑ |
|
The payroll year |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie PayrollPeriodResultsByEmploymentIdAndYear worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype.
Naam |
Datatype |
Label |
Verplicht |
Documentatie |
|---|---|---|---|---|
employmentId |
guid |
Dienstverband ID |
☐ |
The unique identifier of an object (GUID/UUID) |
10-06-2024 18:51 Versie 24.1.3-BETA+4689
