MAGDA Sociale Zekerheid
Inleiding
Diensten gebruikt voor het ophalen van gegevens omtrent een onderneming of vestiging. Het gaat om gegevens uit het KBO, tewerkstellinggegevens en financiële gegevens.
Protocol
Idem als bij alle Magda connectoren.
Specifieke applicatie eigenschappen
Specifieke applicatie eigenschappen, los van de algemene eigenschappen die de toegang regelen.
Info volgt.
Services en functies
givefBetalingenHandicap
Vraag voor een persoon gegevens op omtrent uitbetalingen in kader van een handicap.
Workflow expressie 1
${magda.givefBetalingenHandicap(String insz, String startDate, String endDate, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
startDate | String | ‘2020-01-01' | Startdatum referteperiode |
endDate | String | ‘2025’01-01’ | Einddatum referteperiode |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Workflow expressie 2
Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
${magda.givefBetalingenHandicap(String insz, String startDate, String endDate, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
startDate | String | ‘2020-01-01' | Startdatum referteperiode |
endDate | String | ‘2025’01-01’ | Einddatum referteperiode |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object terug met uitbetalingsgegevens voor een persoon in kader van een handicap.
giveDossierHandicap
Zoek gegevens in het handicapdossier van een persoon.
Workflow expressie
${magda.giveDossierHandicap(String ssin, String date, String uri, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
date | String | ‘2020-01-01' | Referentedatum |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object terug met handicapgegevens voor een persoon.
giveDossierHandicapByPeriod
Zoek gegevens in het handicapdossier van een persoon (voor een specifieke periode).
Workflow expressie
${magda.giveDossierHandicapByPeriod(String ssin, String beginDate, String endDate, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
beginDate | String | ‘2020-01-01' | Startdatum referteperiode |
endDate | String | ‘2025-01-01' | Einddatum referteperiode |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object terug met handicapgegevens voor een persoon binnen een opgegeven referteperiode.
giveDossierHandicapWithHc
Zoek gegevens in het handicapdossier van een persoon en filter op handicapcode of categorie.
Workflow expressie
${magda.giveDossierHandicapWithHc(String ssin, String date, String uri, String hc, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
date | String | ‘2020-01-01' | Refertedatum |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hc | String | ‘VAPH’ | Filter op handicapcode of categorie (mogelijke waardes hangen af van je specifieke aansluiting bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object terug met handicapgegevens voor een persoon voor de opgegeven refertedatum en rekening houdend met de gekozen filter.
giveHandicap
Vraag de handicapstatus op voor een bepaalde persoon.
Workflow expressie 1
${magda.giveHandicap(String insz, String date, String begin, String end, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
date | String | ‘2020-01-01' | Refertedatum |
begin | String | ‘2011-01-01' | Startdatum referteperiode |
end | String | ‘2025-01-05’ | Einddatum referteperiode |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Workflow expressie 2
Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
${magda.giveHandicap(String insz, String date, String begin, String end, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
date | String | ‘2020-01-01' | Refertedatum |
begin | String | ‘2011-01-01' | Startdatum referteperiode |
end | String | ‘2025-01-05’ | Einddatum referteperiode |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object terug met de handicapstatus voor de opgegeven persoon.
giveLeefloonbedragen
Vraag uitgekeerde leefloonbedragen op voor de gegeven persoon.
Workflow expressie 1
${magda.giveLeefloonbedragen(String insz, String year, String numberOfYearsBack, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
year | String | ‘2020' | Refertejaar |
numberOfYearsBack | String | ‘2' | Referteperiode (aantal jaren voorafgaand aan het refertejaar) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Workflow expressie 2
Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
${magda.giveLeefloonbedragen(String insz, String year, String numberOfYearsBack, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
year | String | ‘2020' | Refertejaar |
numberOfYearsBack | String | ‘2' | Bepaalt de referteperiode (aantal jaren voorafgaand aan het refertejaar) |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object met uitgekeerde leefloonbedragen voor de opgegeven persoon.
giveLivingWagePeriods
Vraag uitgekeerde leefloonbedragen op voor de gegeven persoon en voor een specifieke periode.
Workflow expressie
${magda.giveLivingWagePeriods(String ssin, String startDate, String endDate, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
ssin | String | ‘85010212345’ | Rijksregisternummer |
startDate | String | ‘2020-01-01’ | Startdatum voor de referteperiode |
endDate | String | ‘2025-07-31' | Einddatum voor de referteperiode |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object met leefloonbedragen uitgekeerd aan een persoon voor een bepaalde periode.
giveLivingWagePeriodsWithUri
Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
Workflow expressie
${magda.giveLivingWagePeriodsWithUri(String ssin, String startDate, String endDate, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
ssin | String | ‘85010212345’ | Rijksregisternummer |
startDate | String | ‘2020-01-01’ | Startdatum voor de referteperiode |
endDate | String | ‘2025-07-31' | Einddatum voor de referteperiode |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object met leefloonbedragen uitgekeerd aan een persoon voor een bepaalde periode.
geefLoopbaanARZA
Vraag loopbaangegevens op voor een zelfstandige.
Workflow expressie
${magda.geefLoopbaanARZA(String ssin, String uri, String startDate, String endDate, String hoedanigheid)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
ssin | String | ‘85010212345’ | Rijksregisternummer |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
startDate | String | ‘2020-01-01’ | Startdatum voor de referteperiode |
endDate | String | ‘2025-07-31' | Einddatum voor de referteperiode |
hoedanigheid | String | - | IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
Output
Je krijgt een object met loopbaangegevens voor een zelfstandige.
giveReplacementIncome
Vraag gegevens vervangingsinkomen.
Workflow expressie
${magda.giveReplacementIncome(String insz, String uri, String begin, String end, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
ssin | String | ‘85010212345’ | Rijksregisternummer |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
startDate | String | ‘2020-01-01’ | Startdatum voor de referteperiode |
endDate | String | ‘2025-07-31' | Einddatum voor de referteperiode |
dossierId | String (GUID) | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object met gegevens over vervangingsinkomen voor een persoon.
giveSociaalStatuut
Check of een persoon voldoet aan bepaalde sociale statuten.
Workflow expressie 1
${magda.giveSociaalStatuut(String ssin, Map<String, String> socialeStatuten, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
ssin | String | ‘85010212345’ | Rijksregisternummer |
socialeStatuten | Map<String,String> | - | Filter op specifieke sociale statuten |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Workflow expressie 2
${magda.giveSociaalStatuut(String ssin, Map<String, String> socialeStatuten, String locatie, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
ssin | String | ‘85010212345’ | Rijksregisternummer |
socialeStatuten | Map<String,String> | - | Filter op specifieke sociale statuten |
locatie | String | ‘REGIO_GENT’ | Bijkomende filter voor locatie |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object met info of de persoon al dan niet voldoet aan het sociaal statuut.
giveSociaalStatuutWithPeriod
Check of een persoon voldoet aan een bepaald sociale statuut binnen de opgegeven periode.
Workflow expressie
${magda.giveSociaalStatuutWithPeriod(String ssin, String sociaalStatuut, String beginDatum, String eindDatum, String uri, String hoedanigheid, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
ssin | String | ‘85010212345’ | Rijksregisternummer |
sociaalStatuut | String | - | Filter op specifiek sociaal statuut |
beginDatum | String | ‘2025-01-01’ | Startdatum voor de referteperiode |
eindDatum | String | ‘2025-07-30' | Einddatum voor de referteperiode |
uri | String | - | Aansluiting bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
hoedanigheid | String | - | IDPC-code, uniek aansluitingsnummer bij Magda (deze info verkrijg je tijdens het onboardingproces bij Magda) |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object met info of de persoon al dan niet voldoet aan het sociaal statuut binnen de opgegeven referteperiode.