PayslipsByEmploymentId |
List of payslips for an employment__Activity name :__ GetPayslipsByEmploymentId__Availability:__ This is endpoint is available for the Loket.nl application only. It is not available for external partiesGet a list of payslips for the specified employment, including the GUID of the corresponding payroll run.The function of this endpoint is dependent on the role of the user;* For users with the role of 'werknemer'; The endpoint only returns results for payrollruns that have the status 'approved' AND for which results of the payroll are available for ESS (based on the ESS-date of the payrollrun) .* For users with any other role (in most cases); the endpoin returns results for approved payrollruns irregardless of the 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 PayslipsByEmploymentId 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 |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie PayslipsByEmploymentId worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype.
Naam |
Datatype |
Label |
Verplicht |
Documentatie |
---|---|---|---|---|
approvalTime |
datetime |
Goedkeuringstijd |
☐ |
The time at which the payslip was approved. |
numberOfPayslips |
int32 |
Aantal Loonstroken |
☐ |
The number of different types of payslips for the given payroll period. |
payrollPeriod_periodEndDate |
datetime |
Einddatum Loonperiode |
☐ |
The last day of the period for which the tax return message was created |
payrollPeriod_periodNumber |
int32 |
Nummer Verloningsperiode |
☐ |
The period number of the payroll period the record relates to |
payrollPeriod_periodStartDate |
datetime |
Startdatum Verloningsperiode |
☐ |
The first day of the period for which the tax return message was created |
payrollPeriod_testYear |
boolean |
Loonverwerking Periode Testjaar |
☐ |
Indicates whether the payroll periode is part of a test year.In Loket it is possible to run a year of a payrolladministration as a so-called test year. This is typically done to test the configuration of a new payroll administration, by running payrollruns within the context of a test year. Please note: if the payroll run belongs to a test year the results of the run should not be regarded as actual data but as test data. |
payrollPeriod_year |
int32 |
Loonverwerking Jaarperiode |
☐ |
The year of the payroll period the record relates to |
payrollrunId |
guid |
Salarisrun ID |
☐ |
The unique identifier of an object (GUID/UUID) |
10-06-2024 18:51 Versie 24.1.3-BETA+4689