Breadcrumbs

MAGDA Gezin

Inleiding

Gegevens opvragen over voordelen en/of toeslagen verkregen voor kinderen binnen het kader van het groeipakket.

Use cases

  • Automatisch nagaan of een aanvrager recht heeft op kinderbijslag (kindvoordelen) binnen het groeipakket voor een bepaalde referteperiode.

  • Nagaan of de erkenning van een zorgbehoefte (Groeipakket) voor een kind lopende is, werd toegekend, of werd geweigerd.

  • Vooraf invullen of valideren van gezinsgegevens bij aanvragen die rekening houden met toegekende kinderbijslag (bv. inkomensgerelateerde premies of reductietarieven).

  • Raadplegen van historische betalingsperiodes voor auditdoeleinden.

Setup

Idem als bij alle MAGDA-connectoren. Zie MAGDA algemene setup.

Specifieke applicatie eigenschappen

Geen.

Services en functies

Overzicht

Functie

Retourtype

Info

giveKindVoordelen

GeefKindVoordelenResponse

Basisvoordelen toegekend aan gezinnen met kinderen

giveZorgtoeslag

GeefZorgtoeslagResponse

Bijkomende voordelen toegekend aan gezinnen met kinderen die een extra zorgbehoefte met zich meebrengen

Elke functie hieronder is, naast de workflow expressie, ook rechtstreeks aanroepbaar vanuit Java-code door MagdaCamundaConnector (bean magda) te injecteren in je klasse. Zie MAGDA gebruik voor een volledig voorbeeld met dependency injection. De "Java-code"-snippets per functie tonen enkel de effectieve aanroep zelf.

giveKindVoordelen

Basisvoordelen toegekend aan gezinnen met kinderen.

Workflow expressie

${magda.giveKindVoordelen(String insz, String startDate, String endDate, String dossierId)}

Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.

${magda.giveKindVoordelen(String insz, String startDate, String endDate, String uri, String hoedanigheid, String dossierId)}

Java-code

GeefKindVoordelenResponse response = magda.giveKindVoordelen(insz, startDate, endDate, dossierId);

Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.

GeefKindVoordelenResponse response = magda.giveKindVoordelen(insz, startDate, endDate, uri, hoedanigheid, dossierId);

Input

Inputparameters

Data type

Voorbeeld

Uitleg

insz

String

‘85010212345’

Identificatienummer voor de sociale zekerheid (rijksregisternummer)

startDate

String (date format: YYYY-MM)

'2025-07'

Startdatum referteperiode

endDate

String (date format: YYYY-MM)

‘2025-07'

Einddatum referteperiode

uri

(withUri variant)

String

'https://authenticatie.vlaanderen.be/op/v1/afnemers/mijnOrganisatie'

Deze info verkrijg je tijdens het onboardingproces bij Magda

hoedanigheid

(withUri variant)

String

‘12345’

IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda)

dossierId

String (GUID)

'550e8400-e29b-41d4-a716-446655440000'

Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

MAGDA-documentatie

Technische documentatie voor GeefKindVoordelen-02.01

Output

Je krijgt een getypeerd GeefKindVoordelenResponse-object terug met alle informatie over toegekende voordelen (kindvoordelen) binnen de opgegeven referteperiode.

Gepseudonimiseerd voorbeeld:

HTML
<Antwoord>
    <Referte>550e8400-e29b-41d4-a716-446655440000</Referte>
    <Inhoud>
        <KindVoordelen>
            <KindVoordeel>
                <Bron>VLAANDEREN</Bron>
                <INSZ>850102XXX45</INSZ>
                <KindVoordeelFonds>
                    <Ondernemingsnummer>0411696011</Ondernemingsnummer>
                    <Omschrijving>Voorbeeld Kinderbijslagfonds</Omschrijving>
                </KindVoordeelFonds>
                <Kinderen>
                    <Kind>
                        <INSZ>160303XXX77</INSZ>
                        <Betalingsperiodes>
                            <Betalingsperiode>
                                <Periode>
                                    <BeginMaand>2025-07</BeginMaand>
                                    <EindeMaand>2025-07</EindeMaand>
                                </Periode>
                                <Categorie>
                                    <Code>BASISBEDRAG</Code>
                                    <Omschrijving>Basisbedrag kinderbijslag</Omschrijving>
                                </Categorie>
                            </Betalingsperiode>
                        </Betalingsperiodes>
                    </Kind>
                </Kinderen>
            </KindVoordeel>
        </KindVoordelen>
    </Inhoud>
</Antwoord>

Error-handling

Aan deze functie gerelateerde foutcodes:

Code

Type

Toelichting

30001

FOUT

Geen gegevens gevonden voor de vraag

30003

FOUT

Onbestaand INSZ

20002

FOUT

INSZ in de vraag heeft een ongeldige structuur

60009

FOUT

Er heeft zich een technisch probleem voorgedaan

Voor een compleet overzicht, kan je terecht op de MAGDA-foutcodepagina.

Bij sommige errors wil je het proces niet laten vastlopen. In dat geval vorm je de technische error (foutcode) om naar een BPMN-error en vang je deze op via een error boundary event.

// Voorbeeld: uitzondering opvangen en gooien als BpmnError
GeefKindVoordelenResponse response = magda.giveKindVoordelen(insz, startDate, endDate, dossierId);

List<UitzonderingType> uitzonderingen = response.getRepliek().getAntwoorden().getAntwoord()
    .getUitzonderingen().getUitzondering();

for (UitzonderingType uitzondering : uitzonderingen) {
    String code = uitzondering.getIdentificatie();
    if ("30001".equals(code) || "30003".equals(code)) {
        throw new BpmnError("MAGDA_KINDVOORDELEN_NIET_GEVONDEN", uitzondering.getDiagnose());
    }
    if ("20002".equals(code)) {
        throw new BpmnError("MAGDA_ONGELDIG_INSZ", uitzondering.getDiagnose());
    }
    if ("60009".equals(code)) {
        throw new BpmnError("MAGDA_TECHNISCHE_FOUT", uitzondering.getDiagnose());
    }
}

giveZorgtoeslag

Bijkomende voordelen toegekend aan gezinnen met kinderen die een extra zorgbehoefte met zich meebrengen.

Workflow expressie

${magda.giveZorgtoeslag(String insz, String date, String dossierId)}

Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.

${magda.giveZorgtoeslag(String insz, String date, String uri, String hoedanigheid, String dossierId)}

Java-code

GeefZorgtoeslagResponse response = magda.giveZorgtoeslag(insz, date, dossierId);

Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.

GeefZorgtoeslagResponse response = magda.giveZorgtoeslag(insz, date, uri, hoedanigheid, dossierId);

MAGDA-documentatie

Technische documentatie voor giveZorgtoeslag-02.00.

Input

Inputparameters

Data type

Voorbeeld

Uitleg

insz

String

‘85010212345’

Identificatienummer voor de sociale zekerheid (rijksregisternummer)

date

String (date format: YYYY-MM-DD)

'2025-07-31'

Refertedatum

uri

(withUri variant)

String

'https://authenticatie.vlaanderen.be/op/v1/afnemers/mijnOrganisatie'

Deze info verkrijg je tijdens het onboardingproces bij Magda

hoedanigheid

(withUri variant)

String

‘12345’

IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda)

dossierId

String (GUID)

'550e8400-e29b-41d4-a716-446655440000'

Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call)

Output

Je krijgt een getypeerd GeefZorgtoeslagResponse-object terug met de status van de erkenning van de zorgbehoefte (Groeipakket) voor het kind, inclusief de aanvraagstatus en de erkenningsperiodes met bijhorende pijlerscores. Het object geeft dus niet de betaalde bedragen weer, maar de erkenningsgegevens die aan de basis liggen van de zorgtoeslag.

Gepseudonimiseerd voorbeeld.

HTML
<Antwoord>
    <Referte>550e8400-e29b-41d4-a716-446655440000</Referte>
    <Inhoud>
        <Zorgtoeslag>
            <INSZ>160303XXX77</INSZ>
            <StatusAanvraag>
                <Wetgeving>
                    <Code>2</Code>
                    <Omschrijving Taal="nl">Groeipakket</Omschrijving>
                </Wetgeving>
                <DatumAanvraag>2024-01-15</DatumAanvraag>
                <ErkenningLopende>0</ErkenningLopende>
                <InBeroep>0</InBeroep>
            </StatusAanvraag>
            <Erkenningen>
                <Erkenning>
                    <StatusErkenning>
                        <DatumBeslissing>2024-02-01</DatumBeslissing>
                        <PeriodeErkenning>
                            <BeginDatum>2024-02-01</BeginDatum>
                        </PeriodeErkenning>
                    </StatusErkenning>
                    <ResultaatErkenningKind>
                        <Pijlers>
                            <Pijler1>1</Pijler1>
                            <Pijler2>1</Pijler2>
                            <Pijler3>2</Pijler3>
                            <Totaal>4</Totaal>
                        </Pijlers>
                    </ResultaatErkenningKind>
                    <StatusBeslissing>ERKENNING_VASTGELEGD</StatusBeslissing>
                </Erkenning>
            </Erkenningen>
        </Zorgtoeslag>
    </Inhoud>
</Antwoord>

Error-handling

Aan deze functie gerelateerde foutcodes:

Code

Type

Toelichting

30001

FOUT

Geen gegevens gevonden voor de vraag

20002

FOUT

INSZ in de vraag heeft een ongeldige structuur

60017

FOUT

Er is een probleem met de logging van het bericht

Voor een compleet overzicht, kan je terecht op de MAGDA-foutcodepagina.

Bij sommige errors wil je het proces niet laten vastlopen. In dat geval vorm je de technische error (foutcode) om naar een BPMN-error en vang je deze op via een error boundary event.

// Voorbeeld: uitzondering opvangen en gooien als BpmnError
GeefZorgtoeslagResponse response = magda.giveZorgtoeslag(insz, date, dossierId);

List<UitzonderingType> uitzonderingen = response.getRepliek().getAntwoorden().getAntwoord()
    .getUitzonderingen().getUitzondering();

for (UitzonderingType uitzondering : uitzonderingen) {
    String code = uitzondering.getIdentificatie();
    if ("30001".equals(code)) {
        throw new BpmnError("MAGDA_ZORGTOESLAG_NIET_GEVONDEN", uitzondering.getDiagnose());
    }
    if ("20002".equals(code)) {
        throw new BpmnError("MAGDA_ONGELDIG_INSZ", uitzondering.getDiagnose());
    }
    if ("60017".equals(code)) {
        throw new BpmnError("MAGDA_TECHNISCHE_FOUT", uitzondering.getDiagnose());
    }
}