YearEndStatementForYearByPayrollAdministrationId |
Download year-end statement of a payroll administration for a year__Activity name :__ GetYearEndStatementForYearByPayrollAdministrationId__Availability:__ This is endpoint is available for the Loket.nl application only. It is not available for external partiesDownload the year-end statements of a payroll administration (of its underlying employment) for a year.The year-end statements at administration level are effectively a collection of year-end statements for its underlying employments. With this endpoint it may also be required at the administration level in one call._Please note: this endpoint may only be used to acquire a report in the pdf-type format_
Catalogus: LoketNlRest
Schema: Year-endStatementAtAdministrationLevel
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 YearEndStatementForYearByPayrollAdministrationId 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 |
---|---|---|---|---|
includeEmployeeSelfService |
boolean |
☐ |
|
If true; then the year-end statements for employments of which the employee has access to the employee self service module will be included in the response. If false; this specific group will be excluded. |
payrollAdministrationId |
guid |
☑ |
|
The unique identifier of an administration |
year |
int32 |
☑ |
|
The payroll year |
Kolommen van Tabelfunctie
De kolommen van de tabelfunctie YearEndStatementForYearByPayrollAdministrationId worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype.
Naam |
Datatype |
Label |
Verplicht |
Documentatie |
---|---|---|---|---|
DOCUMENT |
byte[] |
Document |
☐ |
|
10-06-2024 18:51 Versie 24.1.3-BETA+4689