PayrollPeriodComponentsByPayrollAdministrationIdAndPayrollPeriodId: Loket.nl REST itgen_loketnl_payrollperiodcomponentsbypayrolladministrationidandpayrollperiodid_plural
read only REST
- Catalogus:
LoketNlRest - Schema:
PayrollPeriodDataOnAdministrationLevel - Label: itgen_loketnl_payrollperiodcomponentsbypayrolladministrationidandpayrollperiodid_plural
Lijst van loonperiodegegevens op het niveau van de loonadministratie Activiteitnaam : GetPayrollPeriodDataByPayrollAdministrationIdAndPayrollPeriodId
Haal een lijst op van alle loonperiodegegevens voor alle actieve dienstverbanden in de opgegeven loonperiode voor de opgegeven loonadministratie. Loonperiodegegevens hebben betrekking op één loonperiode.
Dit eindpunt retourneert alleen objecten waarvoor het dienstverband voldoet aan de filterinstellingen die op gebruikersniveau zijn ingesteld. Let op: filterinstellingen worden ingesteld voor een combinatie van gebruiker <-> werkgever <-> client.
Metadata : Mogelijke opties voor de queryparameters kunnen worden opgevraagd (GET) via het /metadata endpoint. De URI voor dit eindpunt is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/metadata.
Standaardwaarden : Standaardwaarden voor de querystringparameters kunnen worden opgevraagd via het eindpunt /defaults. De URI voor dit eindpunt is ../providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/payrollperioddata/defaults.
Kan alleen gegevens ophalen.
API-bron
- Eindpunt:
/providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata - Operatie:
get /providers/employers/payrolladministrations/{payrollAdministrationId}/payrollPeriods/{payrollPeriodId}/payrollperioddata
Parameters
| Name | Datatype | Required | Default | Documentation |
|---|---|---|---|---|
payroll |
`` | De unieke identificatie van een administratie | ||
payroll |
`` | Een vooraf gedefinieerde categorie looncomponenten om te filteren welke looncomponenten worden teruggegeven. Let op: Een van payroll of payroll of payroll moet een waarde hebben. |
||
payroll |
`` | Een looncomponent om op te filteren. Let op: Een van payroll of payroll of payroll moet een waarde hebben.Deze parameter wordt binnenkort beschikbaar. |
||
payroll |
`` | Een vooraf gedefinieerde set looncomponenten om te filteren welke looncomponenten worden teruggegeven. Let op: Een van payroll of payroll of payroll moet een waarde hebben. |
||
payroll |
`` | De unieke identificatie van de loonperiode | ||
payslip |
`` | Bepaalt welke loonperiodegegevens worden teruggegeven, voor de normale loonstrook of voor de tariefloonstrook. |
Tabelkolommen
De kolommen van de tabel PayrollPeriodComponentsByPayrollAdministrationIdAndPayrollPeriodId worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype. Voor elke vereiste kolom moet bij het invoegen en bijwerken steeds een nieuwe, niet-lege waarde worden opgegeven.
| Name | Datatype | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
cost |
varchar2 |
Kostenplaatscode | |||
cost |
varchar2 |
Kostenplaats Omschrijving | |||
cost |
int32 |
Kostenplaatssleutel | |||
cost |
varchar2 |
Kostendragercode | |||
cost |
varchar2 |
Kostendrager Omschrijving | |||
cost |
int32 |
Kostensleutelcode | |||
distribution |
int32 |
Code voor Distributie-eenheid | |||
distribution |
varchar2 |
Distributieeenheid Omschrijving | |||
distribution |
guid |
Distributie-eenheid Sleutel | De unieke identificatie van een object (GUID/UUID) | ||
employee_ |
int32 |
itgen_loketnl_employee_employeenumber | Het personeelsnummer om een medewerker binnen een werkgever uniek te identificeren | ||
employee_ |
varchar2 |
Medewerker Voornaam | De voornaam, doopnaam of christelijke naam als onderdeel van de persoonlijke naam van een persoon. | ||
employee_ |
varchar2 |
Medewerker Geformatteerde Naam | Vooraf opgemaakte gebruikersnaam voor weergave: <lastname>", "<initials>" "<prefix | ||
employment_ |
guid |
Dienstverband ID | De unieke identificatie van een object (GUID/UUID) | ||
employment_ |
int32 |
itgen_loketnl_employment_incomerelationshipnumber | Het inkomensverhoudingsnummer dat vereist is in de belastingaangifte.Samen met het burgerservicenummer (BSN) en het loonbelastingnummer identificeert het inkomensverhoudingsnummer een dienstverband uniek. | ||
employment_ |
int32 |
itgen_loketnl_employment_payrollid | Het payrollingnummer voor dit dienstverband van de werknemer.Wordt gebruikt door de loonberekeningsmodule.Dit nummer wordt automatisch gegenereerd en kan door de gebruiker niet worden gewijzigd. | ||
is |
char |
Is Aanvulling | Deze booleaanse waarde bepaalt wat de salarisberekening doet met de waarde van de looncomponent als de looncomponent waarden heeft in zowel de loonperiode-specifieke gegevens (dit endpoint) als in de niet-loonperiode-specifieke configuratie van het dienstverband (het is mogelijk waarden te configureren voor looncomponenten die meerdere loonperiodes en zelfs delen daarvan omspannen). * Wanneer ingesteld op false, overschrijft de waarde van de looncomponent de in de niet-loonperiode-specifieke gegevens opgegeven waarde door de opgegeven waarde in de loonperiode-specifieke gegevens. * Wanneer ingesteld op true, wordt de waarde van de loonperiode-specifieke gegevens opgeteld bij de waarde van de niet-loonperiode-specifieke gegevens.Let op: een waarde kan een negatief getal zijn.Bijvoorbeeld, een loonperiodespecifieke waarde van 20 en een niet-loonperiodespecifieke waarde van -8 resulteren effectief in 12 voor de salarisberekening.Deze booleaanse waarde kan alleen op true worden ingesteld bij componenten waarvoor payroll geldt. |
||
payroll |
char |
itgen_loketnl_payrollcomponent_canbesupplemented | Geeft aan of het attribuut voor deze looncomponent de waarde supplement kan hebben.Raadpleeg de beschrijving van het attribuutveld voor een toelichting. |
||
payroll |
int32 |
Salariscomponent Categoriesleutel | |||
payroll |
varchar2 |
Looncomponent Categoriewaarde | |||
payroll |
int32 |
itgen_loketnl_payrollcomponent_deductionorpayment_key | |||
payroll |
varchar2 |
itgen_loketnl_payrollcomponent_deductionorpayment_value | |||
payroll |
varchar2 |
Looncomponentomschrijving | De beschrijving van het looncomponent | ||
payroll |
int32 |
Salariscomponentsleutel | Het nummer van het looncomponent.Dit nummer heeft betekenis voor salarisprofessionals die Loket.nl gebruiken en kennen het vaak uit hun hoofd. | ||
payroll |
datetime |
Einddatum Loonperiode | De laatste dag van de periode waarop de loonperiodegegevens betrekking hebben | ||
payroll |
int32 |
Nummer Verloningsperiode | De periode (maand [1 tot 12], 4 weken [1 tot 13] of week [1 tot 53]) van de loonperiode waarin de loongegevens verwerkt moeten worden. | ||
payroll |
datetime |
Startdatum Verloningsperiode | De eerste dag van de periode waarop de loonperiodegegevens betrekking hebben | ||
payroll |
int32 |
Loonverwerking Jaarperiode | Het jaar van de loonperiode waarin de loongegevens verwerkt moeten worden | ||
payslip |
int32 |
Loonstrooksoortsleutel | |||
payslip |
varchar2 |
Loonstrooksoortwaarde | |||
shift_ |
decimal |
Dienst Bonuspercentage | Het bonuspercentage dat in de salarisberekeningen wordt gebruikt voor de uren die in deze dienst zijn gemaakt. | ||
shift_ |
decimal |
Weekuren Full-time Dienstverband | De fulltime uren voor een dienstverband dat aan deze dienst is gekoppeld. | ||
shift_ |
int32 |
Dienstnummer | Het nummer van de dienst.Loket.nl ondersteunt maximaal 5 diensten per loonadministratie. | ||
value |
decimal |
Value | Afhankelijk van de geselecteerde looncomponent veranderen de mogelijke waarde(n) voor dit veld (dynamische bedrijfsregels). |
Release Notes
Wat is er per release veranderd in de tabellen, kolommen, attributen en mogelijkheden van de driver: