PayslipPayrollPeriodPayslipTypePayrollComponentResultsByEmploymentIdAndPayrollRunId |
Download payslips of an employment for a payrollrun__Activity name :__ GetPayslipsByEmploymentIdAndPayrollRunId__Availability:__ This is endpoint is available for the Loket.nl application only. It is not available for external partiesDownload the payslips or its underlying payroll results of an employment for the specified payrollrun**Please note: this endpoint has two types of output:*** the payslip(s) as a single PDF-file* the underlying payroll result data for the payslip(s) in JSON-format This may be specified by providing the desired format in the `Accept` header of your request.
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 PayslipPayrollPeriodPayslipTypePayrollComponentResultsByEmploymentIdAndPayrollRunId 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 |
payrollrunId |
guid |
☑ |
|
The unique identifier of the payroll run |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie PayslipPayrollPeriodPayslipTypePayrollComponentResultsByEmploymentIdAndPayrollRunId 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) |
payrollComponent_category_key |
int32 |
Salariscomponent Categoriesleutel |
☐ |
|
payrollComponent_category_value |
string |
Looncomponent Categoriewaarde |
☐ |
|
payrollComponent_column_key |
int32 |
|
☐ |
|
payrollComponent_column_value |
string |
|
☐ |
|
payrollComponent_costsEmployer_key |
int32 |
|
☐ |
|
payrollComponent_costsEmployer_value |
string |
|
☐ |
|
payrollComponent_key |
int32 |
Salariscomponentsleutel |
☐ |
The number for the payroll component. This number has meaning to payroll professionals using Loket.nl who often know many of them by heart. |
payrollComponent_value |
string(14) |
|
☐ |
The description of the payroll component |
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 |
payslipType_key |
int32 |
Loonstrooksoortsleutel |
☐ |
|
payslipType_value |
string |
Loonstrooksoortwaarde |
☐ |
|
value |
decimal |
Waarde |
☐ |
Value/ amount (normaal tarief voor belasting, tabelloon) for the payrollcomponent. Only a 'normal' type payslip may have value for this. |
valueSpecialTariff |
decimal |
Waarde Speciaal Tarief |
☐ |
Value/ amount (speciaal tarief voor belasting) for the payrollcomponent. Both a 'normal' and 'special tariff' type payslip may a value for this. Also, both valueNormal and valueSpecialTariff may have a value at the same time. |
10-06-2024 18:51 Versie 24.1.3-BETA+4689