invantive documentation
Invantive Support ForumsAanmelden / Inschrijven

PayrollAdministrationByPayrollAdministrationId: Loket.nl REST itgen_loketnl_payrolladministrationbypayrolladministrationid_plural

read only REST

  • Catalogus: LoketNlRest
  • Schema: PayrollAdministration
  • Label: itgen_loketnl_payrolladministrationbypayrolladministrationid_plural

Details van een loonadministratie Activiteitsnaam : GetPayrollAdministrationByPayrollAdministrationId

Haal de details op van een enkele loonadministratie

Kan alleen gegevens ophalen.

API-bron

  • Eindpunt: /providers/employers/payrolladministrations/{payrollAdministrationId}
  • Operatie: get /providers/employers/payrolladministrations/{payrollAdministrationId}

Parameters

Name Datatype Required Default Documentation
payrollAdministrationId `` De unieke identificatie van een administratie

Tabelkolommen

De kolommen van de tabel PayrollAdministrationByPayrollAdministrationId 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
address_city varchar2(24) City Plaats van het adres
address_country_isoCode varchar2(2) Land ISO-code De ISO 3166-1 alpha-2-waarde voor het land
address_country_key int32 Landsleutel De sleutel voor het land.Mogelijke waarden zijn op te vragen via het metadata-endpoint
address_country_value varchar2(50) Landwaarde De naam van het land
address_furtherIndication_key int32 Adres Verdere Indicatiesleutel De sleutel van de nadere aanduiding.Mogelijke waarden zijn op te vragen via het metadata-endpoint
address_furtherIndication_value varchar2 Adres Verdere Indicatiewaarde De omschrijving van de nadere aanduiding; de mogelijke waarden zijn "WW" en "AB"
address_houseNumber int32 Huisnummer Huisnummer van het adres
address_houseNumberAddition varchar2(4) Huisnummertoevoeging Een aanvulling om het huis-, deur- of postbusnummer nader aan te duiden.Wordt bijvoorbeeld gebruikt om een kamer- of verdiepingsnummer aan te geven naast het huisnummer.
address_location varchar2(35) Location De locatie, bedoeld om het adres verder te specificeren
address_postalCode varchar2(9) Postcode De postcode van het adres
address_province_key int32 Adres Provinciesleutel De sleutel voor de provincie.Mogelijke waarden zijn op te vragen via het metadata-endpoint
address_province_value varchar2(50) Adres Provinciewaarde De naam van de provincie.Alleen de Nederlandse provincies worden ondersteund en niet vertaald
address_street varchar2(24) Street Straatnaam van het adres
administrationNumber varchar2(15) Administratienummer Het administratienummer is een vrij veld dat gewoonlijk wordt gebruikt om het debiteurnummer vast te leggen.
cao_key int32 CAO-sleutel
cao_value varchar2(50) CAO-waarde
claTaxReturnCBSCode int32 itgen_loketnl_clataxreturncbscode De CBS-code van de cao (NL: CAO-nummer), die wordt gebruikt voor de aangifte loonheffingen.Als er geen cao van toepassing is, kan dit veld worden gevuld met de waarde 9999.Let erop dat deze waarde ook leeg kan zijn (dit wordt niet aanbevolen, maar is mogelijk).
clientNumber int32 Klantnummer Het clientnummer is een uniek nummer voor administraties die worden gebruikt voor loonverwerking.Dit veld heeft geen waarde als de administratie niet wordt gebruikt voor loonverwerking.
contact_name varchar2(50) Contactpersoon Naam Naam van de contactpersoon van de administratie
contact_phoneNumber varchar2(15) Telefoonnummer Het algemene telefoonnummer van de administratie
description varchar2(50) Description Omschrijving van de administratie
deviatingPostalAddress_city varchar2(24) Afwijkend Postadres Stad Plaats van het adres
deviatingPostalAddress_country_isoCode varchar2(2) Afwijkend Postadres Land ISO-code De ISO 3166-1 alpha-2-waarde voor het land
deviatingPostalAddress_country_key int32 Afwijkend Postadreslandsleutel De sleutel voor het land.Mogelijke waarden kunnen worden opgevraagd via het metadata-eindpunt
deviatingPostalAddress_country_value varchar2(50) Afwijkende Postadres Landwaarde De naam van het land
deviatingPostalAddress_furtherIndication_key int32 Afwijkend Postadres Verdere Indicatiesleutel De sleutel van de nadere aanduiding.Mogelijke waarden kunnen worden opgevraagd via het metadata-eindpunt
deviatingPostalAddress_furtherIndication_value varchar2 Afwijkende Postadres Verdere Indicatiewaarde De omschrijving van de nadere aanduiding; de mogelijke waarden zijn "WW" en "AB"
deviatingPostalAddress_houseNumber int32 Afwijkend Postadres Huisnummer Huisnummer van het adres
deviatingPostalAddress_houseNumberAddition varchar2(4) Afwijkend Postadres Huisnummertoevoeging Een aanvulling om het huis-, deur- of postbusnummer nader aan te duiden.Wordt bijvoorbeeld gebruikt om een kamer- of verdiepingsnummer aan te geven naast het huisnummer.
deviatingPostalAddress_location varchar2(35) Afwijkend Postadres Locatie De locatie, bedoeld om het adres verder te specificeren
deviatingPostalAddress_poBox int32 Afwijkend Postadres Postbus Postbus
deviatingPostalAddress_postalCode varchar2(9) Afwijkend Postadres Postcode De postcode van het adres, alleen leeg toegestaan als het land niet Nederland (NL) is.
deviatingPostalAddress_street varchar2(24) Afwijkende Postadresstraat Straatnaam van het adres
employerId guid itgen_loketnl_employerid De id van de werkgever waartoe deze loonadministratie behoort.
endDate datetime Einddatum De laatste dag waarop de loonadministratie actief is.
groupClassification_key int32 itgen_loketnl_groupclassification_key
groupClassification_value varchar2 itgen_loketnl_groupclassification_value
groupCode int32 Groepscode Nummer (geheel getal) dat wordt gebruikt voor het groeperen van administraties.
id guid ID De unieke identificatie van een object (GUID/UUID)
loonmodel_key int32 itgen_loketnl_loonmodel_key
loonmodel_value varchar2(50) itgen_loketnl_loonmodel_value
name varchar2(70) Name Naam van de administratie
payrollPeriodType_key int32 Loonverwerking Periodesoortsleutel
payrollPeriodType_value varchar2(50) Loonverwerking Periodesoortwaarde
payrollTaxesNumber varchar2(12) itgen_loketnl_payrolltaxesnumber Het loonheffingennummer is het nummer dat wordt gebruikt voor de loonaangifte bij de Belastingdienst.
shortName varchar2(12) Korte Naam Verkorte naam van de administratie
startDate datetime Startdatum De eerste dag waarop de loonadministratie actief is.

Release Notes

Wat is er per release veranderd in de tabellen, kolommen, attributen en mogelijkheden van de driver: