Gebruikershandleiding GeefOndernemingVKBO 2.0

31
Coördinatiecel Vlaams e-government MAGDA documentatie Gebruikershandleiding GeefOndernemingVKBO 02.00 Versie: 1.0 Verspreiding: vertrouwelijk Coördinatiecel Vlaams e-government (CORVE) e-government en ICT-Beheer (e-IB) | Bestuurszaken E-mail: [email protected] | Web: www.vlaanderen.be/egov

Transcript of Gebruikershandleiding GeefOndernemingVKBO 2.0

Page 1: Gebruikershandleiding GeefOndernemingVKBO 2.0

CoördinatiecelVlaams e-

governmentMAGDA documentatie

Gebruikershandleiding

GeefOndernemingVKBO 02.00

Versie: 1.0 Verspreiding: vertrouwelijk

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] | Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 2: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

Inhoudstabel1 INLEIDING...........................................................................................................................................................4

1.1 VERKLARENDE WOORDENLIJST.......................................................................................................................41.2 DOEL...............................................................................................................................................................41.3 OPBOUW DOCUMENT.......................................................................................................................................4

2 ALGEMEEN.........................................................................................................................................................5

2.1 OMGEVINGSINFORMATIE.................................................................................................................................52.2 FUNCTIONALITEITEN.......................................................................................................................................52.3 LEVERANCIER VAN DE GEGEVENS...................................................................................................................52.4 GEBRUIKSVOORWAARDEN..............................................................................................................................52.5 VERWANTE DIENSTEN.....................................................................................................................................6

2.5.1 Registreer/VerwijderDossierOnderneming.............................................................................62.5.2 PubliceerOndernemingVKBO 2.0...........................................................................................6

2.6 BATCH.............................................................................................................................................................6

3 INTERFACE.........................................................................................................................................................7

3.1 VRAAG............................................................................................................................................................73.1.1 Algemeen............................................................................................................................... 73.1.2 XSD visueel............................................................................................................................ 73.1.3 Detail...................................................................................................................................... 73.1.4 Functionele validaties/beperkingen........................................................................................73.1.5 Voorbeelden........................................................................................................................... 7

3.2 ANTWOORD.....................................................................................................................................................83.2.1 Algemeen............................................................................................................................... 83.2.2 XSD visueel............................................................................................................................ 93.2.3 XSD in detail.......................................................................................................................... 93.2.4 Voorbeeld............................................................................................................................. 13

4 CODETABELLEN EN FOUTCODES.............................................................................................................16

4.1 CODETABELLEN.............................................................................................................................................164.1.1 AuthentiekeBron................................................................................................................... 164.1.2 OndernemingOfVestiging.....................................................................................................164.1.3 StatusKBO........................................................................................................................... 164.1.4 SoortOnderneming...............................................................................................................16

4.2 FOUTCODES...................................................................................................................................................174.2.1 Voorbeeld uitzonderingen....................................................................................................174.2.2 Annotaties............................................................................................................................ 17

5 WERKING..........................................................................................................................................................19

5.1 OPVRAGING...................................................................................................................................................195.2 LOGGING.......................................................................................................................................................195.3 BESCHIKBAARHEID........................................................................................................................................19

6 TESTGEGEVENS EN VOORBEELDEN.......................................................................................................20

6.1 TESTGEGEVENS.............................................................................................................................................206.2 VOORBEELDEN..............................................................................................................................................20

Pagina 2 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 3: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

7 WIJZIGINGEN TEGENOVER 01.X...............................................................................................................21

7.1 ALGEMEEN....................................................................................................................................................217.2 OVERZICHT WIJZIGINGEN..............................................................................................................................21

8 CONTACTGEGEVENS....................................................................................................................................23

9 Document eigenschappen...................................................................................................................................24

Pagina 3 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 4: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

1 Inleiding

1.1 Verklarende woordenlijst

Term Omschrijving

MAGDA Maximale gegevensdeling tussen administraties

GW MAGDA Gateway

BD MAGDA Businessdienst

KBO Kruispuntbank Ondernemingen

VKBO Verrijkte Kruispuntbank ondernemingen

1.2 Doel

De dienst ‘GeefOndernemingVKBO 2.0’ geeft de basis-identificatiegegevens van een onderneming of vestiging terug aan de hand van het ondernemingsnummer of het vestigingsnummer. De onderliggende data bevindt zich in de VKBO-databank die gevoed en beheerd wordt door de KBO-provisionering.

Deze dienst is een upgrade van de GeefOnderneming 01.01. Deze 1.x dienst zal op termijn afgesloten worden.

Met de OndernemingVKBO 2.0 streeft MAGDA VKBO naar éénzelfde formaat voor zowel de GeefOndernemingVKBO 02.00, PubliceerOndernemingVKBO 2.0 en de toekomstige ZoekOndernemingVKBO 2.0.

Ten opzicht van de vorige versies bevat de OndernemingVKBO 2.0 bijkomende informatie met betrekking tot de adresdoorhaling en ambtshalve doorhaling.

1.3 Opbouw document

Het algemeen overzicht van de functionaliteiten en het gebruik van deze webservice is opgenomen in hoofdstuk 2.

Hoofdstuk 3 behandelt de interface van de webservice, dit zowel de Vraag als Antwoord inclusief voorbeelden en bevindingen.

Hoofstuk 4 bevat de codetabellen.

Hoofdstuk 5 geeft meer informatie over de werking.

Hoofdstuk 6 bevat informatie voor het uitvoeren van testen alsook de nodige voorbeelden.

De verschillen met de 1.x dienst zijn opgenomen in hoofdstuk 7.

De contactgegevens zijn opgenomen in hoofdstuk 8.

Pagina 4 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 5: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

2 Algemeen

2.1 Omgevingsinformatie

Naam: GeefOndernemingVKBO

Versie: 02.00.0000

Domein: Onderneming

Classificatie: Niet privacy gevoelig

2.2 Functionaliteiten

De gebruiker voert een request uit op basis van het ondernemingsnummer of vestigingsnummer. Als antwoord verkrijgt men de actuele gegevens van de gevraagde onderneming of vestiging.

Het antwoord bevat gegevens als

- De status van onderneming / vestiging

- Van de vestiging de maatschappelijke zetel (ondernemingsnummer)

- Rechtsvorm en rechtstoestand

- Adres (en adres doorhaling)

- Maatschappelijke naam, afgekorte naam, commerciële naam

- Ambtshalve doorhaling

Deze dienst vraagt de gegevens op in de MAGDA VKBO databank en niet rechtstreeks bij KBO.

2.3 Leverancier van de gegevens

De authentieke bron van de gegevens is de KBO. Het MAGDA platform is dan ook afhankelijk van deze bronnen voor de kwaliteit en de aanlevering van de gegevens.

2.4 Gebruiksvoorwaarden

Afnemers moeten aan volgende voorwaarden voldoen om deze webservice te mogen gebruiken:

Toelating tot het MAGDA platform

Meer informatie over deze voorwaarden is terug te vinden in het document “Machtigingen en toelatingen” [MT].

Pagina 5 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 6: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

2.5 Verwante diensten

2.5.1 Registreer/VerwijderDossierOnderneming

Voor het registreren (en verwijderen) van ondernemingen en vestigingen indien een publicatie op basis van de klantenlijst gewenst is.

2.5.2 PubliceerOndernemingVKBO 2.0

Publicatie (FTP) van de ondernemingsgegevens in OndernemingVKBO 2.0 formaat. De publicatie is beschikbaar in xml als csv.

2.6 Batch

Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML).

Hiervoor moet men de Service-xsd gebruiken en niet de Webservice. Door de Service-xsd te gebruiken zijn er meerdere vragen mogelijk in één bestand. De vraag-bestanden worden op de MAGDA FTP geplaatst in een afnemer specifieke folder. Deze folder wordt tijdens het aansluitingsproces toegekend.

Als prefix voor de batchbestanden wordt GOND gebruikt.

Meer informatie hierover kan u vinden via “Aansluiting op het MAGDA-platform” in het document “MS – Gebruikershandleiding_WebserviceInBatch”, of neem contact op met Corve.

Pagina 6 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 7: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

3 Interface

3.1 Vraag

3.1.1 Algemeen

De opzoeking gebeurt op basis van het ondernemingsnummer of vestigingsnummer. Het ondernemingsnummer is steeds met voorloopnul.

3.1.2 XSD visueel

3.1.3 Detail

MAGDA XML Inhoud/ Kardinaliteit Opmerking

Ondernemingsnummer [1..1] Onderneming- of vestigingsnummer. Steeds 10 lang. Ondernemingsnummer moet bijgevolg met een voorloopnul doorgegeven worden.

3.1.4 Functionele validaties/beperkingen

Er wordt een validatie uitgevoerd op het Ondernemings-nummer element. Het ondernemingsnummer of vestigingsnummer moet voldoen aan het 97 controlecijfer.

3.1.5 Voorbeelden

Op ondernemingsnummer<Vragen>

<Vraag><Referte>6148</Referte><Inhoud>

<Ondernemingsnummer>0440249049</Ondernemingsnummer></Inhoud>

</Vraag></Vragen>

Pagina 7 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 8: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

Op vestigingsnummer<Vragen>

<Vraag><Referte>6139</Referte><Inhoud>

<Ondernemingsnummer>2127133388</Ondernemingsnummer></Inhoud>

</Vraag></Vragen>

Een volledig voorbeeld is terug te vinden in hoofdstuk 6.

3.2 Antwoord

3.2.1 Algemeen

Binnen de OndernemingVKBO 2.0 zijn, tegenover de 1.x versie, enkele gegevens toegevoegd (ambtshalve doorhaling en adresdoorhaling) maar ook enkele kleinere aanpassingen. De aanpassingen tegenover de versie 1.x zijn uitgelegd in hoofdstuk 7.

In grote lijnen bevat de OndernemingVKBO 2.0 volgende gegevens:

- Status KBO

- Aanduiding onderneming of vestiging

- Soort onderneming (indien onderneming)

- Maatschappelijke zetel (indien vestiging)

- Namen

o Maatschappelijke naam

o Afgekorte naam

o Commerciële naam

- Adres en adres doorhaling

- Contactgegevens

- Startdatum, datum inschrijving, datum afsluiting

- Rechtstoestand

- Rechtsvorm

- Ambtshalve doorhaling

- Datum en reden stopzetting

Pagina 8 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 9: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

3.2.2 XSD visueel

3.2.3 XSD in detail

DatumModificatieGegeven Uitleg

@DatumModificatie Meest recente datum laatste wijziging uit KBO over de basisidentificatiegegevens van de onderneming / vestiging heen. M.a.w. de meest recente datum van de KBO datums laatste wijziging in KBO van de gegevens van onderneming/vestiging, benaming, adres, rechtsvorm, rechtstoestand, link onderneming-vestiging, adresdoorhaling en ambtshalve doorhaling.

Formaat: jjjj-mm-dd.

<Onderneming DatumModificatie="2004-04-30">

Ondernemingsnummer, AuthentiekeBronGegeven Uitleg

Ondernemingsnummer Ondernemingsnummer of vestigingsnummer zoals opgegeven in de vraag. Ondernemingsnummer is steeds met een voorloopnul.

AuthentiekeBron Bron van de gegevens. Steeds 03 - KBO

Pagina 9 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 10: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

<Ondernemingsnummer>2127133388</Ondernemingsnummer><AuthentiekeBron>

<Code Beschrijving="KBO">03</Code></AuthentiekeBron>

OndernemingOfVestigingGegeven Uitleg

OndernemingOfVestiging Aanduiding of het een onderneming of vestiging betreft. Enkel Code, @Beschrijving en @DatumMoficiatie komen terug.

@DatumModificatie Dit is de datum laatste wijziging van KBO van één van volgende potentieel ingevulde gegevens: datum inschrijving, startdatum, stopzettingsdatum, reden stopzetting, datum afsluiting, status, duurtijd, kapitaal, muntcode.

Formaat: jjjj-mm-dd.

<OndernemingOfVestiging DatumModificatie="2015-04-17"><Code Beschrijving="Vestiging">2</Code>

</OndernemingOfVestiging>

StatusKBOGegeven Uitleg

StatusKBO Status zoals in KBO gekend is. Enkel Code en Omschrijving komen terug.

<StatusKBO><Code>AC</Code><Omschrijving>Actief</Omschrijving>

</StatusKBO>

SoortOndernemingGegeven Uitleg

SoortOnderneming Aanduiding welk soort onderneming het betreft. Komt enkel terug indien Onderneming, nooit bij een vestiging. Enkel Code en Beschrijving komen terug.

<SoortOnderneming><Code Beschrijving="Rechtspersoon">2</Code>

</SoortOnderneming>

MaatschappelijkeZetelGegeven Uitleg

MaatschappelijkeZetel Komt enkel terug bij een vestiging. Dit element bevat het ondernemingsnummer van de maatschappelijke zetel van de vestiging. DatumModificatie is onder de vorm jjjj-mm-dd.

<MaatschappelijkeZetel DatumModificatie="1968-01-01">0212235604</MaatschappelijkeZetel>

NamenGegeven Uitleg

Pagina 10 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 11: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

@DatumModificatie Dit is de begindatum in KBO vanaf wanneer de link tussen de onderneming (maatschappelijke zetel) en de vestiging geldig is.

Formaat: jjjj-mm-dd.

Namen Drie mogelijke namen kunnen terugkomen. De drie hebben dezelfde structuur:

- MaatschappelijkeNaam

- AfgekorteNaam

- CommercieleNaam

@TaalCode en @DatumModificatie komen terug. Opgelet: in zeer uitzonderlijke omstandigheden is er geen TaalCode bekend, dan komt deze niet terug in het antwoord

Mogelijke taalcodes: fr, nl, de, en

@DatumModificatie Dit is de begindatum in KBO vanaf wanneer de benaming geldig is.

Formaat: jjjj-mm-dd.

<Namen><MaatschappelijkeNaam DatumModificatie="1969-09-09" TaalCode="fr">Ville de Virton</MaatschappelijkeNaam><AfgekorteNaam DatumModificatie="1976-07-28" TaalCode="nl">KLEINE BAREEL</AfgekorteNaam><CommercieleNaam DatumModificatie="2006-07-05" TaalCode="nl">Buro Center Informatics</CommercieleNaam>

</Namen>

Adres en adresdoorhalingGegeven Uitleg

Adres en adresdoorhaling De adresgegevens alsook eventueel de gegevens betreffende de doorhaling van het adres.

- @DatumModificatie: dit is de begindatum in KBO vanaf wanneer het adres geldig is. Onder de vorm jjjj-mm-dd

- Straat: rijksregisterstraatcode en straatnaam

- Huisnummer

- Busnummer

- Gemeente: Niscode, postcode en gemeentenaam

- Land: Niscode, ISOCode. Landnaam komt momenteel niet terug.

- Aanvullingen:

o Staat

o Tekst: vrij tekstveld. Vb: Bloc 7, Haven 1062

o TaalCode: fr, nl, de, en. Indien taalcode “onbekend” komt er geen TaalCode terug

- Doorhaling: aanduiding dat het adres doorgehaald werd. Gegevens die terugkomen:

o Code

o Omschrijving

o Datum: dit is de begindatum in KBO vanaf wanneer de doorhaling geldig is. Onder de vorm jjjj-mm-dd

<Adres DatumModificatie="2014-02-26"><Straat>

<Code>1008</Code>

Pagina 11 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 12: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

<Naam>Antoine Gautierstraat</Naam></Straat><Huisnummer>110</Huisnummer><Gemeente>

<NISCode>21005</NISCode><PostCode>1040</PostCode><Naam>Etterbeek</Naam>

</Gemeente><Land>

<NISCode>150</NISCode><ISOCode>BEL</ISOCode><Naam>België</Naam>

</Land><Aanvullingen>

<TaalCode>nl</TaalCode></Aanvullingen><Doorhaling>

<Reden><Code>002</Code><Omschrijving>Doorhaling door proces verbaal</Omschrijving>

</Reden><Datum>2014-07-09</Datum>

</Doorhaling></Adres>

ContactGegeven Uitleg

Contact Enkel Telefoonnummer, Faxnummer en Email kunnen terugkomen.

<Contact><Telefoonnummer>+ 32 2 502.06.56</Telefoonnummer><Faxnummer>+ 32 2 502.80.09</Faxnummer><Email>[email protected]</Email>

</Contact>

DatumsStart, DatumInschrijving, DatumAfsluitingGegeven Uitleg

DatumStart Oprichtingsdatum van de onderneming / vestiging. Formaat: jjjj-mm-dd

DatumInschrijving Datum van inschrijving in KBO. Formaat: jjjj-mm-dd

DatumAfsluiting Datum van afsluiting onderneming of vestiging. Indien 9999-12-31: onderneming of vestiging is niet afgesloten.

<DatumStart>1998-12-29</DatumStart><DatumInschrijving>2003-06-24</DatumInschrijving><DatumAfsluiting>9999-12-31</DatumAfsluiting>

RechtstoestandGegeven Uitleg

Rechtstoestand Enkel gekend bij een onderneming. Enkel Code en Omschrijving komen terug.

Pagina 12 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 13: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

@DatumModificatie Dit is de begindatum in KBO vanaf wanneer de rechtstoestand geldig is.

Formaat: jjjj-mm-dd.

<Rechtstoestand DatumModificatie="1998-08-28"><Code>011</Code><Omschrijving>Activiteitstopzetting in België (buitenlandse onderneming)</Omschrijving>

</Rechtstoestand>

RechtsvormGegeven Uitleg

Rechtsvorm Enkel gekend bij een onderneming. Enkel Code en Omschrijving komen terug.

@DatumModificatie Dit is de begindatum in KBO vanaf wanneer de rechtsvorm geldig is.

Formaat: jjjj-mm-dd.

<Rechtsvorm DatumModificatie="1998-08-28"><Code>030</Code><Omschrijving>Buitenlandse onderneming</Omschrijving>

</Rechtsvorm>

Ambtshalve doorhalingGegeven Uitleg

Ambtshalve doorhaling Periode en reden van ambtshalve doorhaling. Enkel bij een onderneming.

Komen terug:

DatumModificatie: dit is de begindatum in KBO vanaf wanneer de ambtshalve doorhaling geldig is. Formaat: jjjj-mm-dd.

Code

Omschrijving

Periode/Begin en indien gekend ook Periode/Einde. Beide onder de vorm jjjj-mm-dd.

<AmbtshalveDoorhaling DatumModificatie="2013-08-03"><Reden>

<Code>001</Code><Omschrijving>Doorhaling wegens niet-neerlegging jaarrekening</Omschrijving>

</Reden><Periode>

<Begin>2013-08-03</Begin><Einde>2013-08-19</Einde>

</Periode></AmbtshalveDoorhaling>

StopzettingGegeven Uitleg

Pagina 13 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 14: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

Stopzetting Datum en reden van stopzetting

Komen terug:

Datum (jjjj-mm-dd)

Code

Omschrijving

<Stopzetting><Datum>2015-04-23</Datum><Reden>

<Code>006</Code><Omschrijving>Stopzetting wegens vervanging dubbele onderneming</Omschrijving>

</Reden></Stopzetting>

3.2.4 Voorbeeld

Voorbeeld 1: onderneming<Inhoud>

<Onderneming DatumModificatie="2003-01-25"><Ondernemingsnummer>0440249049</Ondernemingsnummer><AuthentiekeBron>

<Code Beschrijving="KBO">03</Code></AuthentiekeBron><OndernemingOfVestiging DatumModificatie="2003-01-25">

<Code Beschrijving="Onderneming">1</Code></OndernemingOfVestiging><StatusKBO>

<Code>AC</Code><Omschrijving>Actief</Omschrijving>

</StatusKBO><SoortOnderneming>

<Code Beschrijving="Rechtspersoon">2</Code></SoortOnderneming><Namen>

<MaatschappelijkeNaam DatumModificatie="1990-02-15" TaalCode="nl">EURO EXPORT CONSULT</MaatschappelijkeNaam>

</Namen><Adres DatumModificatie="1990-02-15">

<Straat><Naam>Store Kirkestraede</Naam>

</Straat><Huisnummer>1</Huisnummer><Gemeente>

<Naam>Copenhagen</Naam></Gemeente><Land>

<NISCode>108</NISCode><ISOCode>DNK</ISOCode>

</Land></Adres><DatumStart>1990-02-15</DatumStart><DatumInschrijving>2003-01-18</DatumInschrijving><DatumAfsluiting>9999-12-31</DatumAfsluiting><Rechtstoestand DatumModificatie="1998-08-28">

<Code>011</Code><Omschrijving>Activiteitstopzetting in België (buitenlandse onderneming)</Omschrijving>

</Rechtstoestand>

Pagina 14 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 15: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

<Rechtsvorm DatumModificatie="1998-08-28"><Code>030</Code><Omschrijving>Buitenlandse onderneming</Omschrijving>

</Rechtsvorm></Onderneming>

</Inhoud>

Voorbeeld 2: Vestiging<Inhoud>

<Onderneming DatumModificatie="2010-02-16"><Ondernemingsnummer>2130842748</Ondernemingsnummer><AuthentiekeBron>

<Code Beschrijving="KBO">03</Code></AuthentiekeBron><OndernemingOfVestiging DatumModificatie="2003-06-24">

<Code Beschrijving="Vestiging">2</Code></OndernemingOfVestiging><StatusKBO>

<Code>AC</Code><Omschrijving>Actief</Omschrijving>

</StatusKBO><Namen>

<CommercieleNaam DatumModificatie="1992-02-17" TaalCode="fr">MB TRONICS</CommercieleNaam>

</Namen><Adres DatumModificatie="2009-09-01">

<Straat><Code>0020</Code><Naam>Kerkhof van Brussellaan</Naam>

</Straat><Huisnummer>35</Huisnummer><Gemeente>

<NISCode>21006</NISCode><PostCode>1140</PostCode><Naam>Evere</Naam>

</Gemeente><Land>

<NISCode>150</NISCode><ISOCode>BEL</ISOCode><Naam>België</Naam>

</Land><Aanvullingen>

<TaalCode>nl</TaalCode></Aanvullingen>

</Adres><DatumStart>1992-02-17</DatumStart><DatumInschrijving>2003-06-24</DatumInschrijving><DatumAfsluiting>9999-12-31</DatumAfsluiting>

</Onderneming></Inhoud>

Pagina 15 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 16: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

4 Codetabellen en foutcodes

4.1 Codetabellen

Dit zijn de voor VKBO op dit moment gekende codes (september 2015). Hou er rekening mee dat codes en omschrijvingen (of Beschrijvingen) kunnen wijzigen.

De codes van Adresdoorhaling, Rechtsvorm, Rechtstoestand, Ambtshalve doorhaling en Stopzetting zijn niet opgenomen in dit document. Indien nodig kunnen deze aangeleverd worden via een generiek publicatiebestand.

4.1.1 AuthentiekeBron

Code @Beschrijving

03 KBO

4.1.2 OndernemingOfVestiging

Code @Beschrijving

1 Onderneming

2 Vestiging

4.1.3 StatusKBO

Code Omschrijving

AC Actief

ST Stopgezet

AF Afgesloten

JU Juridisch

AN Geannuleerd

BK Bekendgemaakt

4.1.4 SoortOnderneming

Code @Beschrijving

1 Natuurlijk persoon

2 Rechtspersoon

Pagina 16 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 17: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

4.2 Foutcodes

Wat betreft de Uitzonderingen wordt dezelfde werking gevolgd als de overige MAGDA webservices.

Enkel de dienst specifieke foutcodes zijn opgenomen in het overzicht. Voor een volledig overzicht van de MAGDA foutcodes wordt verwezen naar de generieke handleiding.

Het is steeds mogelijk dat er in de toekomst foutcodes toegevoegd worden.

Identificatie Niveau Type Diagnose Oorsprong

30001 3 FOUT Geen gegevens gevonden voor de vraag MAGDA

20007 3 FOUTOndernemingsnummer in de vraag heeft een ongeldige structuur MAGDA

4.2.1 Voorbeeld uitzonderingen

Geen gegevens gevonden<Antwoorden>

<Antwoord><Referte>5940</Referte><Uitzonderingen>

<Uitzondering><Identificatie>30001</Identificatie><Oorsprong>MAGDA</Oorsprong><Type>FOUT</Type><Tijdstip>

<Datum>2015-08-26</Datum><Tijd>07:54:55.926</Tijd>

</Tijdstip><Diagnose>Geen gegevens gevonden voor de vraag</Diagnose>

</Uitzondering></Uitzonderingen>

</Antwoord></Antwoorden>

Controlecijfer 97<Antwoorden>

<Antwoord><Referte>6177</Referte><Uitzonderingen>

<Uitzondering><Identificatie>20007</Identificatie><Oorsprong>MAGDA</Oorsprong><Type>FOUT</Type><Tijdstip>

<Datum>2015-08-27</Datum><Tijd>13:20:09.174</Tijd>

</Tijdstip> Ondernemingsnummer in de vraag heeft een ongeldige structuur <Diagnose/>

</Uitzondering></Uitzonderingen>

</Antwoord></Antwoorden>

Pagina 17 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 18: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

4.2.2 Annotaties

In bepaalde omstandigheden komen er ook annotaties terug bij een Uitzondering. Voor een overzicht van de gebruikte annotaties binnen de MAGDA 2.0 webservices wordt verwezen naar de generieke handleiding. <Uitzondering>

<Identificatie>99981</Identificatie><Oorsprong>MAGDA</Oorsprong><Type>WAARSCHUWING</Type><Tijdstip>

<Datum>2015-09-01</Datum><Tijd>09:03:39.391</Tijd>

</Tijdstip><Diagnose>Land gegevens van de bron niet gekend binnen Magda, contacteer VIP</Diagnose><Annotaties>

<Annotatie><Naam>LandNISCode</Naam><Waarde>159</Waarde>

</Annotatie></Annotaties>

</Uitzondering>

Pagina 18 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 19: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

5 Werking

5.1 Opvraging

Van zodra de vraag gesteld is wordt er een XSD-validatie uitgevoerd. Is de ontvangen vraag XML niet geldig tegenover het schema, dan stopt de verwerking en wordt een foutmelding aangemaakt, anders gaat de verwerking verder. Na de XSD-validatie vinden de nodige authenticatie- en autorisatiecontroles plaats.

Bovendien gebeurt er een controle op het Ondernemingsnummer-element, namelijk dat dit voldoet aan het 97-controlecijder. Daarna worden de van het opgegeven nummer de gegevens in de VKBO-databank opgezocht.

Indien er geen gegevens gevonden werden voor de vraag verkrijgt men als fout 30001. Bekomt men gegevens, dan worden deze omgezet naar een Onderneming binnen het Antwoord/Inhoud-element.

Het antwoord wordt gevalideerd tegenover de xsd waarna het aan de afnemer ter beschikking gesteld wordt.

5.2 Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven in het document “MAGDA logging” [ML].

5.3 Beschikbaarheid

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. Bij geplande onbeschikbaarheden worden de afnemers op de hoogte gebracht via mail.

Pagina 19 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 20: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

6 Testgegevens en voorbeelden

6.1 Testgegevens

Wat betreft de T&I omgeving is het mogelijk om productieve data op te vragen. Testgegevens zijn bijgevolg in principe voldoende voor handen.

6.2 Voorbeelden

Voorbeelden zijn terug te vinden in de hiervoor opgezette mappen. Van de voorbeelden zijn steeds vraag als antwoord beschikbaar.

Voorbeeld BestandsnaamOpvragen onderneming Voorbeeld_01Opvragen vestiging Voorbeeld_02Ongeldig nummer (controlecijfer 97) Voorbeeld_03

Pagina 20 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 21: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

7 Wijzigingen tegenover 01.x

7.1 Algemeen

Dit hoofdstuk bespreekt de doorgevoerde wijzigingen tegenover de GeefOnderneming 1.x

De wijzigingen hebben vooral betrekking tot- het volgen van de MAGDA 2.0 standaarden (gebruik Code / Omschrijving, naamgeving

elementen)- de toevoeging van adres doorhaling- de toevoeging van ambtshalve doorhaling

7.2 Overzicht wijzigingen

Gegeven WijzigingOndernemingVKBO Er wordt niet meer gesproken over (Geef)Onderneming maar over (Geef)OndernemingVKBO. Op

deze manier wordt er op dienstniveau een duidelijk onderscheid gemaakt welke bron aangesproken wordt: KBO of VKBO.

Voor de wijzigingen van types, lenges, cardinaliteiten wordt verwezen naar de xsd.

RSZNummer Verwijdering van het RSZNummer uit de xsd

AuthentiekeBronCode Element hernoemd naar AuthentiekeBron met een Code/Omschrijving structuur.OndernemingOfVestigingCode Element hernoemd naar OndernemingOfVestiging met een Code/Omschrijving structuur.

Toevoeging van het attribuut DatumModificatie.

Het attribuut DatumModificatie komt over van StatusKBO waar het onterecht stond.

StatusKBOCode Element hernoemd naar StatusKBO met een Code/Omschrijving structuur. Verwijdering van het attribuut DatumModificatie.

SoortOndernemingCode Element hernoemd naar SoortOnderneming met een Code/Omschrijving structuur.

MZOndNummer Element MZOndNummer hernoemd naar MaatschappelijkeZetel.

Namen Bundeling van maatschappelijke naam, commerciële naam en afgekorte naam in het element Namen.

Adres (doorhaling) Verwijdering van het element AuthentiekeBronCode, dit doordat er gewoonweg geen broncode van het adres, zoals bewaard in KBO, beschikbaar is.

Straat: hernoeming NISCode naar CodeHuisNummer en BusNummer hernoemd naar Huisnummer en Busnummer

Land: Omwisseling van volgorde NISCode en ISOCode

Doorhaling: toevoeging doorhalinggegevens

Contact Uitbreiding contact-element met GSM en Website

RechtstToestandCode Element hernoemd naar Rechtstoestand met een Code/Omschrijving structuur.

RechtsVormCode Element hernoemd naar Rechtsvorm met een Code/Omschrijving structuur.

AmbsthalveDoorhaling Toevoeging AmbtshalveDoorhaling

Pagina 21 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 22: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

Stopzetting Reden omgevormd naar Code/Omschrijving structuurDatum Verplicht indien stopgezet.

Pagina 22 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 23: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

8 Contactgegevens

CORVE is elke werkdag bereikbaar van 9.00 tot 17.00 uur.

Postadres:Coördinatiecel Vlaams e-governmentBoudewijngebouw 4e verdieping toren B Boudewijnlaan 30 bus 46 1000 Brussel

Tel: 02/553 00 35Fax: 02/553 55 42

E-mail: [email protected]

Pagina 23 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België

Page 24: Gebruikershandleiding GeefOndernemingVKBO 2.0

Gebruikershandleiding GeefOndernemingVKBO 2.0 Versie: 1.0Coordinatiecel

Vlaams e-government Verspreiding: vertrouwelijk

9 Document eigenschappen

OPGESTELD DOOR:

VERSIE DATUM WIE COMMENTAAR

0.1 1 september 2015 Loedts Michaël Eerste versie

0.2 18 september 2015 Loedts Michaël (HPE) Afwerking document

0.3 15 oktober 2015 Bonneure Kelly Toevoeging detailbeschrijving voor elke datum modificatie

GERELATEERDE DOCUMENTEN:

VERSIE DATUM NAAM DOCUMENT OMSCHRIJVING

Machtigingen en toelatingen [MT]

Gebruik MAGDA Webservices [GMW]

MAGDA logging [ML]

GOEDGEKEURD DOOR:

VERSIE DATUM WIE

VERSPREID ONDER RESTRICTIE:

OPENBAAR = mag door iedereen gelezen en gebruikt worden, mag onbeperkt door-gegeven worden aan derden

VERTROUWELIJK = mag enkel gelezen en gebruikt worden door personen voorafgaandelijk goedgekeurd door CORVE, mag enkel na voorafgaande goedkeuring door CORVE doorgegeven worden aan derden

GEHEIM = mag enkel gelezen en gebruikt worden door CORVE medewerkers, mag in geen geval doorgegeven worden aan derden

BESCHIKBAAR ONDER LICENTIE:

Creative Commons: Naamsvermelding-Niet-commercieel-Gelijk delen 2.0 Belgiëhttp://creativecommons.org/licenses/by-nc-sa/2.0/be/deed.nl

Pagina 24 van 24

Coördinatiecel Vlaams e-government (CORVE)e-government en ICT-Beheer (e-IB) | BestuurszakenE-mail: [email protected] - Web: www.vlaanderen.be/egovBoudewijngebouw 4B, Boudewijnlaan 30 bus 46, B-1000 Brussel, België