MAGDA Ondernemingen
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.
Setup
Idem als bij alle Magda connectoren.
Applicatie eigenschappen
Algemeen
Opdat de connector toegang zou krijgen tot de MAGDA service, moet deze beschikken over de volgende informatie. De placeholder {service} moet je telkens vervangen door de specifieke service die je wil implementeren.
dosis(legacy connector)ebox(magda documentendienst)gc(ondernemingen - giveCompany)ghpgp(geefPersoon)mobility(mobiliteit)poc(kadaster)ri(repertorium)sme(ondernemingen - geefJaarrekeningen)zoekeigendomstoestanden(kadaster)
URL-endpoint
Eigenschap | Beschrijving |
|---|---|
| Geef het URL-endpoint. Voorbeeld: |
Keys en certificaten
Eigenschap | Beschrijving |
|---|---|
|
|
| Lokale opslag van het certificaat. Voorbeeld: |
| Lokale opslag van de key. Voorbeeld: |
| Bevat het pad naar het certificaat in AWS Secrets Manager. |
| Bevat het pad naar de key in AWS Secrets Manager. |
| Bevat het pad naar het wachtwoord voor de key in AWS Secrets Manager. |
Hoedanigheid
Onderstaand is de default voor alle magda services. In de meeste gevallen wordt dit vervangen door een service specifieke eigenschap.
Eigenschap | Beschrijving |
|---|---|
| Bevat de aansluitingscode of IPDC-code. |
Uri
Onderstaand is de default voor alle magda services. In de meeste gevallen wordt dit vervangen door een service specifieke eigenschap.
Eigenschap | Beschrijving |
|---|---|
| Bevat het pad naar de aan te spreken service. |
Ondernemingen specifiek
Eigenschappen geefJaarrekeningen
Specifieke applicatie eigenschappen, los van de algemene eigenschappen die de toegang regelen.
Eigenschap
Beschrijving
Geen specifieke eigenschappen.
Geen specifieke eigenschappen.
Eigenschappen giveCompany
Eigenschap | Beschrijving |
|---|---|
Geen specifieke eigenschappen. | Geen specifieke eigenschappen. |
Specifieke applicatie eigenschappen, los van de algemene eigenschappen die de toegang regelen.
Eigenschap | Beschrijving |
|---|---|
Geen specifieke eigenschappen. | Geen specifieke eigenschappen. |
Services en functies
geefJaarrekeningen
Vraag gegevens op met betrekking tot de jaarrekeningen voor een onderneming.
Workflow expressie 1
${magda.geefJaarrekeningen(String identifier, String year, String hoedanigheid, String uri, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘BE0123456789’ | KBO-nummer |
year | String | '2025' | Refertejaar |
hoedanigheid | String | - | IDPC-code (deze info verkrijg je tijdens het onboardingproces bij Magda) |
uri | String | - | 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 GeefJaarrekeningenResponse terug met jaarrekeninggegevens.
Magda-documentatie
Technische documentatie GeefJaarrekeningen-02.00.
giveCompanyFunctions
Vraag voor een specifieke persoon welke bestuurlijke functies hij of zij uitoefent bij welke ondernemingen of organisaties.
Workflow expressie 1
${magda.giveCompanyFunctions(String insz, String uri, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
insz | String | ‘85010212345’ | Identificatienummer voor de sociale zekerheid (rijksregisternummer) |
uri | String | - | 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 GeefFunctiesResponse terug met gegevens over bestuurlijke functies uitgeoefend door de opgegeven persoon.
Magda-documentatie
Technische documentatie GeefFuncties-02.00.
giveCompany
Zoek ondernemingsgegevens op.
Workflow expressie 1
${magda.giveCompany(String identifier, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘BE0123456789’ | KBO-nummer |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefOndernemingResponse terug met ondernemingsgegevens.
Magda-documentatie
Technische documentatie GeefOnderneming-02.00.
giveCompanyWithUri
Zoek ondernemingsgegevens op. Variant waarbij de magda aansluitingsgegevens expliciet worden meegegeven.
Workflow expressie 1
${magda.giveCompanyWithUri(String identifier, String uri, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘BE0123456789’ | KBO-nummer |
uri | String | - | 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.giveCompanyWithUri(String identifier, String uri, String beginDate, String endDate, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘BE0123456789’ | KBO-nummer |
uri | String | - | Deze info verkrijg je tijdens het onboardingproces bij Magda |
beginDate | String (date format: YYYY-MM-DD) | '2020-01-30' | Startdatum referteperiode voor historische vestigingsdata |
endDate | String (date format: YYYY-MM-DD) | ‘2025-07-30’ | Einddatum referteperiode voor historische vestigingsdata |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefOndernemingResponse terug met ondernemingsgegevens.
Magda-documentatie
Technische documentatie GeefOnderneming-02.00.
giveCompanyWithFuncties
Zoek ondernemingsgegevens op met inbegrip van bestuurlijke functies.
Workflow expressie 1
${magda.giveCompanyWithFuncties(String identifier, String dossierId)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
identifier | String | ‘BE0123456789’ | KBO-nummer |
dossierId | String (GUID) | - | Unieke id van het dossier binnen de Skryv applicatie (met oog op logging van de call) |
Output
Je krijgt een object GeefOndernemingResponse terug met ondernemingsgegevens waarin ook informatie over bestuurlijke functies opgenomen zit.
Magda-documentatie
Technische documentatie GeefOnderneming-02.00.