PayrollPeriodResultPayrollPeriodPayslipTypesByPayrollAdministrationIdAndPayrollPeriodId |
Get payroll results for the given payroll period__Activity name :__ GetPayrollPeriodResultsByPayrollAdministrationIdAndPayrollPeriodId Returns the payroll results for the payroll period.__Note :__ This endpoint is related to the `GetPayrollRunResultsByPayrollRunId` endpoint.Both endpoints return the same output just in a different way. This endpoint returns the current state of the payroll results for the given period where as `GetPayrollRunResultsByPayrollRunId` returns the payroll results for the given payroll run (a payroll run can contain payroll results for multiple payroll periods). It's possible for payroll results to be created after the end of the payroll period it zelf. For example, the payroll periode 01-2020 ends at 31-01-2020 (in case of a monthly payroll period) it is possible that the payroll run for period 07-2020 contains payroll results for the period 01-2020 due to a retroactivity change for that period. This change in the payroll run for payroll period 07-2020 would require the system to reaquire the results for period 01-2020 (as they changed).
Catalogus: LoketNlRest
Schema: PayrollResults
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 PayrollPeriodResultPayrollPeriodPayslipTypesByPayrollAdministrationIdAndPayrollPeriodId 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 |
---|---|---|---|---|
payrollAdministrationId |
guid |
☑ |
|
The unique identifier of an administration |
payrollComponentSet |
guid |
☐ |
|
A predefined set of payroll components to filter what payroll components are returned |
payrollPeriodId |
int32 |
☑ |
|
The unique identifier of the payroll period |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie PayrollPeriodResultPayrollPeriodPayslipTypesByPayrollAdministrationIdAndPayrollPeriodId 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) |
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 |
☐ |
|
10-06-2024 18:51 Versie 24.1.3-BETA+4689