Functionele servicebeschrijving Inschrijving

Functionele
Dataservice
Beschrijving
opdrachtgever
auteur
V&M
Stefan Staal
project
datum
Handelsregister
Gegevenslevering
Dataservices
26-9-2014
onderwerp
versie
Dataservice Inschrijving
2.3
Versiebeheer
Versie
Datum
Auteur
Opmerking
1.0
1-3-2012
Stefan Staal
1.2
22-8-2012
Stefan Staal
2.2
5-10-2012
Stefan Staal
Initiële versie op basis van Gegevenscatalogus 2.1 (en hoger
totdat anders benoemd).
De volgende bevindingen zijn verwerkt:
- Klantreferentie is optioneel
Wijzigingen door uitbrengen Gegevenscatalogus v2.2. Zie de
release notes van de catalogus voor een uitgebreide beschrijving
van alle aanpassingen.
De volgende aanpassingen zijn voor dit product gemaakt:
 In het Request bericht is het attribuut klantnummer
vervallen;
 In het Response bericht is het attribuut peilmoment
toegevoegd;
 Het attribuut /volledigAdres is verplaatst van gegevensgroep
Adres naar gegevensgroep Locatie;
 Het attribuut geheim is vervangen door het attribuut
afgeschermd
 De gegevensgroep BAGIdentificatie is toegevoegd. Zowel
bij hoofd- als nevenvestiging;
 Het nieuwe attribuut incidenteelUitlenenArbeidskrachten in
het object MaatschappelijkeActiviteit is toegevoegd;
 Bij het object Functievervulling is de gegevensgroep
Schorsing met al zijn attributen toegevoegd;
 Bij het object Persoon is het attribuut /persoonStatus
vervallen
Voor de /persoonStatus is in de plaats gekomen:
 Bij het object Persoon is de gegevensgroep
BijzondereRechtstoestand is toegevoegd;
 Bij het object Persoon is de gegevensgroep
BeperkingInRechtshandeling toegevoegd;
 Bij het object NietNatuurlijkPersoon is de gegevensgroep
Ontbinding toegevoegd;
Verder is nog aangepast:
 Bij het object Onderneming is attribuut datumEinde
toegevoegd
 Bij objecten Vestiging (hoofdvestiging) is datumEinde
toegevoegd.
2.2a
23-4-2013
Pagina 1 van 26
Stefan Staal
Meldingen m.b.t. geblokkeerde inschrijvingen (IPD1000 en
IPD1001) toegevoegd.
Kamer van Koophandel Nederland
Versie
Datum
Auteur
Opmerking
2.2b
9-7-2013
Stefan Staal


2.3
26-9-2014
Gerard Plandsoen





Pagina 2 van 26
Melding IPD1001 is vervallen
Melding IPD1002 is toegevoegd
Onder 1. Informatie over Autorisatieniveaus en het
autorisatiefilter toegevoegd
Class Eigenaar, extra toelichting bij /persoonRechtsvorm
Class Functievervulling: extra toelichting opgenomen over
de getoonde functievervullingen
Class Functievervulling: objecttype FunctieVervulling,
gegevensgroep Schorsing: hierbij opgenomen dat de
datums aanvang en einde van de RechterlijkeUitspraak
worden geleverd
Class Functionaris heeft/is eigenaar van <<objecttype>>
MaatschappelijkeActiviteit wordt conditioneel getoond: NIET
bij Functionarissen NatuurlijkPersonen en bij alle overige
Personen (NNP) wordt deze MaatschappelijkeActiviteit wel
getoond.
Kamer van Koophandel Nederland
Inhoudsopgave
1 Product Dataservice Inschrijving............................................................................................................................. 4
1.1
Kenmerken.......................................................................................................................................................... 5
1.2
Referenties.......................................................................................................................................................... 5
1.3
Openstaande punten........................................................................................................................................... 5
2 Dataservice Inschrijving .......................................................................................................................................... 6
2.1
Inschrijving Request ............................................................................................................................................ 6
2.1.1
HeaderRequest................................................................................................................................................ 7
2.2
Inschrijving Response ......................................................................................................................................... 7
2.2.1
HeaderResponse............................................................................................................................................. 7
3 Inhoud Inschrijving Response................................................................................................................................. 8
3.1
Maatschappelijke Activiteit ................................................................................................................................ 10
3.2
Eigenaar............................................................................................................................................................ 11
3.3
Onderneming .................................................................................................................................................... 14
3.4
Hoofdvestiging .................................................................................................................................................. 15
3.5
Nevenvestiging.................................................................................................................................................. 17
3.6
Functievervulling ............................................................................................................................................... 18
3.7
Functionaris....................................................................................................................................................... 20
3.8
Overdracht ........................................................................................................................................................ 22
3.9
Voortzetting ....................................................................................................................................................... 23
3.10
Onderneming bij overdracht en voorzetting ................................................................................................... 24
4 Meldingen ............................................................................................................................................................. 25
Pagina 3 van 26
Kamer van Koophandel Nederland
1
Product Dataservice Inschrijving
Dit document geeft een functionele beschrijving van de service voor het opvragen van een product via het kanaal
Handelsregister gegevenslevering, ook wel Dataservice genoemd. Het beschrijft met welke gegevens de dataservice
wordt aangeroepen en welke gegevens er worden geretourneerd.
Dit document is bedoeld voor de informatie analist, (software) architect, -ontwikkelaar en tester.
De Dataservice bevat alle gegevens die mogelijkerwijs uitgeleverd moeten worden aan Overheid, Notarissen en
Marktpartijen. De gegevens-set van de Dataservice gaat door een AuthorisatieFilter om de juiste gegevens te
retourneren aan Overheidspartners, Notariaat en Marktpartijen:
MARKET
Persoonsnummer* - UIT
BSN - UIT
Locatie obv afgeschermd indicator - UIT (1)
Woonadres natuurlijk persoon obv artikel 51 - UIT (2)
NOTARY
Persoonsnummer* - UIT
BSN - UIT
Locatie obv afgeschermd indicator - IN
Woonadres natuurlijk persoon obv artikel 51 - IN
GOVERNING BODY
Persoonsnummer* - UIT
BSN - IN
Locatie obv afgeschermd indicator - IN
Woonadres natuurlijk persoon obv artikel 51 - IN
EXTRA AUTHORISED GOVERNING BODY
Persoonsnummer* - UIT
BSN - IN
Locatie obv afgeschermd indicator - IN
Woonadres natuurlijk persoon obv artikel 51 - IN
* Persoonsnummer is een KvK intern gegeven (niet gelijk aan BSN)
UIT = wordt NIET geleverd
IN = wordt WEL geleverd
(1) Als de indicator aangeeft dat de Locatie ((Privé-)Adres gegevens) afgeschermd is, dan worden de locatie adres
gegevens NIET geleverd aan de ‘Market’geauthoriseerden en WEL geleverd aan de overige authorisatie profielen.
(2) De Woonadressen van NatuurlijkPersonen met een bepaalde rol of functie worden op basis van de
Handelsregisterwet art. 51 NIET geleverd aan de ‘Market’geauthoriseerden en WEL geleverd aan de overige
authorisatie profielen.
Het opvragen van een product bestaat uit een bevraging (request) en een antwoord (response). De afnemer geeft in
het request het type product aan dat gewenst wordt. Op basis van een productsleutel geeft de afnemer aan van welk
'onderwerp' hij het product geleverd wil hebben.
Dit document beschrijft het opvragen van:
Type product:
Dataservice Inschrijving
Productsleutel:
KvK nummer
In hoofdstuk 2 wordt schematisch weergegeven waaruit het request en reponse bericht bestaat. In hoofdstuk 3 wordt
schematisch weergegeven welke gegevens uit het handelsregister met dit product worden geleverd. Tot slot worden
in hoofdstuk 4 de mogelijke meldingen weergegeven.
Pagina 4 van 26
Kamer van Koophandel Nederland
1.1 Kenmerken
Kenmerk
Opdrachtgever
Project
Opmerking
V&M
Handelsregister Gegevenslevering Dataservices
1.2 Referenties
Referentie
Beschrijving
Gegevenscatalogus v2.3
Beschrijving van de handelsregister gegevens die met KvK
producten/diensten worden geleverd.
Beschrijving van de opbouw van de gegevenscatalogus
XSD's.
De technische vertaling van de gegevenscatalogus in XML.
Beschrijving van de wijzigingen tussen versie 2.0 en 2.2 van
de Gegevenscatalogus.
Handleiding Gegevenscatalogus XSD v1.0
Gegevenscatalogus v2.3 XSD
Gegevenscatalogus v2.3 Releasenotes
1.3 Openstaande punten
Pagina 5 van 26
Kamer van Koophandel Nederland
2
Dataservice Inschrijving
Dit hoofdstuk geeft schematisch weer waaruit het request en response bericht bestaat.
Een bevraging (request) voor een product heeft als resultaat een antwoord (response). Dit antwoord
bestaat uit meldingen en de inhoud (gegevens uit het handelsregister). De meldingen kunnen
waarschuwingen, informatie en/of foutmeldingen bevatten.
Indien de bevraging (request) juist is en het product kan geproduceerd worden, dan bevat het response
bericht het bestelde product, de inhoud.
Van elk object met een formele historie wordt het registratietijdstip meegeleverd. In de
Gegevenscatalogus staat aangeven bij welke objecten en gegevensgroepen een formele historie wordt
geregistreerd.
De inhoud is gemodelleerd volgens de Gegevenscatalogus. Voor een beschrijving van deze objecten,
gegevensgroepen, enzovoort, wordt daarom verwezen naar de Gegevenscatalogus (zie hoofdstuk
Referenties).
class Dataserv ice Inschrijv ing
Name:
Package:
Version:
Author:
Dataservice Inschrijving
Dataservice Inschrijving
1.1
Stefan Staal
HeaderResponse
HeaderRequest
«interface»
Inschrijv ing Request
+ productnaam :TypeProduct = Inschrijving
+ productversie :string [0..1]
::HeaderRequest
- klantreferentie :Tekst50 [0..1]
+
«interface»
Inschrijv ing Response
peilmoment :Tijdstip
+fout
0..*
+waarschuwing
«resulteert in»
0..*
MeldingType
-
code :string
omschrijving :string
referentie :string [0..1]
+informatie
0..*
«productSleutel»
+ kvkNummer :Numeriek8
A
A
+inhoud
0..1
Inhoud Inschrijv ing Response
2.1
Inschrijving Request
Dit hoofdstuk beschrijft de parameters van het request.
Naam
Type
kvkNummer
Numeriek8
productnaam
TypeProduct
productversie
string
Pagina 6 van 26
Waarde
Inschrijving
Toelichting
Het Kamer van Koophandel nummer
(KvKNummer).
De naam van het product. De afnemer geeft
hiermee aan welk product zij wil bevragen.
De versie van het product.
Van producten kunnen meerdere versies bestaan.
De afnemer geeft aan welke versie van het
product gewenst wordt.
Wanneer de versie niet wordt opgegeven, dan
wordt de laatste versie van het product geleverd.
Kamer van Koophandel Nederland
2.1.1
HeaderRequest
Dit hoofdstuk geeft een overzicht van de attributen van de header van het request bericht.
2.2
Naam
Type
klantreferentie
Char
Waarde
Beschrijving
Een door de afnemer vrij in te vullen referentie.
Deze referentie verschijnt (eventueel) op de
factuur.
De KvK gebruikt dit gegeven verder niet.
Inschrijving Response
Dit hoofdstuk beschrijft de parameters van het response.
2.2.1
Naam
Type
peilmoment
Tijdstip
Waarde
Toelichting
Het peilmoment geeft de datum aan waarop voor
het laatst registraties in het Handelsregister zijn
vewerkt. De in het product opgenomen gegevens
stonden op dit peilmoment als zodanig in het
Handelsregister.
HeaderResponse
Dit hoofdstuk geeft een overzicht van de attributen van de header van het response bericht.
Naam
Type
fout
MeldingType
waarschuwing
MeldingType
informatie
MeldingType
Pagina 7 van 26
Waarde
Beschrijving
De fout die is opgetreden gedurende het
verwerken van de vraag.
Een waarschuwing die betrekking heeft op het
geleverde product
Een informatieve melding die betrekking heeft op
het geleverde product
Kamer van Koophandel Nederland
3
Inhoud Inschrijving Response
Dit hoofdstuk geeft schematisch weer waaruit het request en response bericht bestaat.
Een bevraging (request) voor een product heeft als resultaat een antwoord (response). Dit antwoord bestaat uit
meldingen en de inhoud (gegevens uit het handelsregister). De meldingen kunnen waarschuwingen, informatie en/of
foutmeldingen bevatten.
Indien de bevraging (request) juist is en het product kan geproduceerd worden, dan bevat het response bericht het
bestelde product, de inhoud. De inhoud geeft schematisch weer waaruit het product is opgebouwd.
De inhoud is gemodelleerd volgens het informatiemodel Handelsregister (Gegevenscatalogus). Voor een beschrijving
van deze objecten, gegevensgroepen, enzovoort, wordt daarom verwezen naar de Gegevenscatalogus.
Het vet gedrukte element in het schema is het start punt (root element) van het product.
Met de deze versie worden de volgende gegevens (nog) niet geleverd:
 Er worden geen gegevens over deponeringen geleverd;
 Samenvoeging van vestigingen;
 Buitenlandse rechtstoestand.
Pagina 8 van 26
Kamer van Koophandel Nederland
class Inhoud Inschrij v ing Response
Name:
Package:
Version:
Author:
Inhoud Inschrijving Response
Inhoud Inschrijving Response
2.3
Stefan Staal
Gedeponeerd
heeft
+Deponering
0..1
+NietNatuurlijkPersoon
1
Eigenaar
Functiev erv ulling
Functionaris
heeft
+Persoon
1
door
+Functievervulling
1
+Functievervulling
0..*
+Persoon
1
+Persoon
1
heeft als eigenaar
+MaatschappeljikeActiviteit
0..1
Onderneming
Maatschappelij ke Activ iteit
manifesteert zich als
+MaatschappelijkeActiviteit
1
+MaatschappelijkeActiviteit
1
+Onderneming
0..1
+MaatschappelijkeActiviteit
1
w ordt uitgeoefend in
+Onderneming
1
+Onderneming
1
+Onderneming
1
+Onderneming
1
+Onderneming
1
wordt geleid v anuit
wordt uitgeoefend in
+Vestiging
0..1
Hoofdv estiging
+NietCommercieleVestiging
0..*
Nev env estiging
+CommercieleVestiging
0..*
is
heeft
is
heeft
+Overdracht
0..1
+Overdracht
0..*
Ov ergedragen
+Overdracht
Ov ergenomen
1
aan
Pagina 9 van 26
+Overdracht
1
v an
+Voortzetting
0..*
+Voortzetting
0..1
Voortgezet (ov ergedragen)
+Voortzetting
1
Voortgezette (ov ergenomen)
+Voortzetting
aan
1
v an
+Onderneming
1
+Onderneming
1
+Onderneming
1
+Onderneming
1
Ov ernemende onderneming
Afgesloten onderneming
Voortzettende onderneming
Afgesloten onderneming
Kamer van Koophandel Nederland
3.1
Maatschappelijke Activiteit
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de Maatschappelijke activiteit.
class Maatschappelij ke Activ iteit
Name:
Package:
Version:
Author:
Maatschappelijke Activiteit
Maatschappelijke Activiteit
2.3
Stefan Staal
«objecttype»
Maatschappelij keActiv iteit
0..*
«gegevensgroep»
Activ iteiten-Maatschappelij keActiv iteit
«authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
«niet authentiek»
- incidenteelUitlenenArbeidskrachten :Indicatie
- nonMailing :Indicatie
«gegevensgroep»
SBI-Activ iteit
-
«Identificatie, authentiek, trigger»
- kvkNummer :Numeriek8
«afleiding»
- /naam :Tekst500
hoofdactiviteit :Indicatie
omschrijving :Tekst60
SBI-code :Numeriek6
1..*
0..1
«gegevensgroep»
Activ iteiten
-
Pagina 10 van 26
activiteitOmschrijving :Tekst2000
Kamer van Koophandel Nederland
3.2
Eigenaar
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de Eigenaar van de maatschappelijke
Activiteit.
In het objecttype Persoon wordt het afgeleide veld /persoonRechtsvorm in alle gevallen getoond.
class Eigenaar
Name:
Package:
Version:
Author:
Eigenaar
Eigenaar
2.3
Stefan Staal
«objecttype»
Persoon
1
«afleiding»
- /persoonRechtsvorm :String
- /uitgebreideRechtsvorm :String
- /volledigeNaam :Tekst500
RechterlijkeUitspraak
«gegevensgroep»
BuitenlandseRechtstoestand
-
beschrijving :Tekst2000
0..*
«objecttype»
Natuurlij kPersoon
Er worden geen
gegevens geleverd
over de
RechterlijkeUitspraak.
«objecttype»
NietNatuurlij kPersoon
«GBA»
- aanduidingNaamgebruik :AanduidingNaamgebruik [0..1]
- adellijkeTitel :Tekst10 [0..1]
- geslachtsnaamPartner :Tekst200 [0..1]
- voorvoegselGeslachtsnaamPartner :Tekst10 [0..1]
«authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
- naam :Tekst500 [0..1]
0..1
«niet authentiek»
- datumUitschrijving :DatumIncompleet [0..1]
«authentiek»
- geboortedatum :DatumIncompleet
- geboorteland :Tekst40
- geboorteplaats :Tekst200 [0..1]
- geslachtsaanduiding :Geslachtsaanduiding
- geslachtsnaam :Tekst200
- overlijdensdatum :DatumIncompleet [0..1]
- voornamen :Tekst200 [0..1]
- voorvoegselGeslachtsnaam :Tekst10 [0..1]
«naamgeving»
- ookGenoemd :Tekst500 [0..1]
- verkorteNaam :Tekst45 [0..1]
«Identificatie, authentiek, trigger»
- rsin :Numeriek9
«niet authentiek»
- handelingsbekwaam :Indicatie
«Identificatie, authentiek, trigger»
- natuurlijkPersoonId :NatuurlijkPersoonId
«objecttype»
BuitenlandseVennootschap
-
heeft woonadres
buitenlandsRegister :Tekst50
geplaatstKapitaal :Kapitaal [0..1]
inschrijfnummerBuitenland :Tekst50 [0..1]
land :Tekst40
landVanOprichting :Tekst40 [0..1]
plaatsBuitenlandsRegister :Tekst40 [0..1]
«afleiding»
- /buitenlandseRegistratie :Tekst500
1
«gegevensgroep»
Locatie-Natuurlij kPersoon
+Bezoekadres
0..1
+Postadres
0..1
«gegevensgroep»
Locatie-BuitenlandseNNP
0..1
«gegevensgroep»
BuitenlandseVennootschapGegev ens
-
hoofdvestigingBuitenNederland :Indicatie
omschrijvingRechtsvorm :Tekst100
zetel :Tekst40
«oprichting»
- datumAkteOprichting :DatumIncompleet [0..1]
«formeelBuitenlandseVennootschap»
- datumEersteInschrijvingBuitenland :DatumIncompleet [0..1]
- datumFormeelBuitenlandsSinds :DatumIncompleet [0..1]
«authentiek»
- rechtsvormcategorie :RechtsvormBuitenlandseVennootschap
+Bezoekadres
0..1
«gegevensgroep»
Locatie-Rechtspersoon
0..1
+Postadres
Pagina 11 van 26
Kamer van Koophandel Nederland
class Eigenaar
RechterlijkeUitspraak
«gegevensgroep»
BeperkingInRechtshandeling
0..1
Er worden geen gegevens
geleverd over de
RechterlijkeUitspraak.
«niet authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
- soort :SoortBeperkingRechtshandeling
«gegevensgroep»
Faillissement
RechterlijkeUitspraak
«gegevensgroep»
Bij zondereRechtstoestand
«gegevensgroep»
Schuldsanering
0..1
«niet authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
- redenEinde :RedenEindeInsolventie [0..1]
«gegevensgroep»
Ontbinding
«niet authentiek»
- aanleiding :AanleidingOntbinding [0..1]
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
0..1
«gegevensgroep»
SurseanceVanBetaling
«gegevensgroep»
Liquidatie
1
0..1
«niet authentiek»
- duur :Tekst200 [0..1] = 18
- status :StatusInsolventie [0..1]
«niet authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
«objecttype»
BinnenlandseNietNatuurlij kPersoon
«objecttype»
EenmanszaakMetMeerdereEigenaren
«objecttype»
RechtspersoonInOprichting
«authentiek»
- rechtsvorm :RechtsvormRechtspersoon
«gegevensgroep»
Duur
«objecttype»
Samenw erkingsv erband
1
1
-
eindeDuur :DatumIncompleet [0..1]
indicatieOnbepaald :Indicatie
«commanditaireVennootschap»
- aantalCommanditaireVennoten :Numeriek4 [0..1]
«authentiek»
- rechtsvorm :RechtsvormSamenwerkingsverband
«gegevensgroep»
CommanditairKapitaal
1
0..1
-
bedrag :Geld
soort :SoortCommanditairKapitaal
«objecttype»
Rechtspersoon
0..1
«gegevensgroep»
Activ iteiten-Rechtspersoon
«gegevensgroep»
Activ iteiten
-
activiteitOmschrijving :Tekst2000
0..1
1..*
«gegevensgroep»
SBI-Activ iteit
-
hoofdactiviteit :Indicatie
omschrijving :Tekst60
SBI-code :Numeriek6
«afleiding»
- /activiteitenGestaaktPer :DatumIncompleet
«oprichting»
- bedragKostenOprichting :Geld [0..1]
- datumAkteOprichting :DatumIncompleet [0..1]
- datumEersteInschrijvingHandelsregister :DatumIncompleet
- datumOprichting :DatumIncompleet
«statuten»
- datumAkteStatutenWijziging :DatumIncompleet [0..1]
- datumLaatsteStatutenWijziging :DatumIncompleet [0..1]
«kapitaal»
- geplaatstKapitaal :Kapitaal [0..1]
- gestortKapitaal :Kapitaal [0..1]
- maatschappelijkKapitaal :Kapitaal [0..1]
0..1
«gegevensgroep»
Communicatiegegev en-Rechtspersoon
«vereniging»
- ingangStatuten :DatumIncompleet [0..1]
«authentiek»
- statutaireZetel :Tekst40 [0..1]
«SE/SCE»
- stelselInrichting :Bestuursmodel [0..1]
«gegevensgroep»
Communicatiegegev en
0..*
0..*
«gegevensgroep»
Nummer
-
Pagina 12 van 26
communicatieNummer :Alfanumeriek15
soortCommunicatieNummer :SoortCommunicatieNummer
toegangscode :Numeriek4
0..*
«gegevensgroep»
EmailAdres
-
adres :Tekst200
«gegevensgroep»
Domeinnaam
-
naam :Tekst300
Kamer van Koophandel Nederland
class Eigenaar
«gegevensgroep»
Locatie
«niet authentiek»
- afgeschermd :Indicatie
- toevoegingAdres :Tekst100 [0..1]
«afleiding»
- /volledigAdres :Tekst500
0..*
Van
0..*
Tot en met
0..1
0..1
«gegevensgroep»
Adres
«gegevensgroep»
BinnenlandsAdres
-
huisletter :Letter [0..1]
huisnummer :Numeriek5 [0..1]
huisnummerToevoeging :Alfanumeriek4 [0..1]
plaats :Tekst24
postbusnummer :Numeriek5 [0..1]
postcode :Postcode
straatnaam :Tekst40 [0..1]
«gegevensgroep»
BuitenlandsAdres
-
land :Tekst40
postcodeWoonplaats :Tekst200
regio :Tekst150 [0..1]
straatHuisnummer :Tekst200
0..1
«gegevensgroep»
BAGIdentificatie
«authentiek»
- identificatieAdresseerbaarObject :Tekst16 [0..1]
- identificatieNummeraanduiding :Tekst16 [0..1]
Pagina 13 van 26
Kamer van Koophandel Nederland
3.3
Onderneming
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de onderneming.
class Onderneming
Name:
Package:
Version:
Author:
Onderneming
Onderneming
2.3
Stefan Staal
«objecttype»
Onderneming
«gegevensgroep»
SBI-Activ iteit
-
«authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
hoofdactiviteit :Indicatie
omschrijving :Tekst60
SBI-code :Numeriek6
«afleiding»
- /fulltimeWerkzamePersonen :numeriek6
- /parttimeWerkzamePersonen :numeriek6
- /totaalWerkzamePersonen :numeriek6
«Identificatie, trigger»
- /kvkNummer :Numeriek8
0..*
«gegevensgroep»
Activ iteiten-Onderneming
1
heeft
1..*
«gegevensgroep»
Handelsnaam
«authentiek»
- handelsnaam :Tekst625
Pagina 14 van 26
Kamer van Koophandel Nederland
3.4
Hoofdvestiging
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de hoofdvestiging van de
maatschappelijke activiteit.
class Hoofdv estiging
Name:
Package:
Version:
Author:
Hoofdvestiging
Hoofdvestiging
2.3
Stefan Staal
«objecttype»
Vestiging
+Bezoekadres (authentiek)
1
«gegevensgroep»
Locatie-Vestiging
«authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
+Postadres (authentiek)
1
0..1
«niet authentiek»
- datumVoortzetting :DatumIncompleet [0..1]
«Identificatie, authentiek, trigger»
- vestigingsnummer :Numeriek12
«gegevensgroep»
Locatie
«objecttype»
NietCommercieleVestiging
«niet authentiek»
- afgeschermd :Indicatie
- toevoegingAdres :Tekst100 [0..1]
«authentiek»
- naam :Tekst500
Van
«afleiding»
- /totaalWerkzamePersonen :numeriek6
1..*
«naamgeving»
- ookGenoemd :Tekst500 [0..1]
- verkorteNaam :Tekst45 [0..1]
«afleiding»
- /volledigAdres :Tekst500
0..*
«objecttype»
CommercieleVestiging
0..*
Tot en met
0..1
0..1
1
«gegevensgroep»
Adres
1
«gegevensgroep»
Activ iteiten-NietCommercieleVestiging
«gegevensgroep»
Activ iteiten-CommercieleVestiging
«niet authentiek»
- export :Indicatie
- import :Indicatie
«gegevensgroep»
BinnenlandsAdres
-
huisletter :Letter [0..1]
huisnummer :Numeriek5 [0..1]
huisnummerToevoeging :Alfanumeriek4 [0..1]
plaats :Tekst24
postbusnummer :Numeriek5 [0..1]
postcode :Postcode
straatnaam :Tekst40 [0..1]
«gegevensgroep»
BuitenlandsAdres
-
land :Tekst40
postcodeWoonplaats :Tekst200
regio :Tekst150 [0..1]
straatHuisnummer :Tekst200
«gegevensgroep»
Activ iteiten
-
activiteitOmschrijving :Tekst2000
0..1
1..*
«gegevensgroep»
SBI-Activ iteit
0..1
-
hoofdactiviteit :Indicatie
omschrijving :Tekst60
SBI-code :Numeriek6
«gegevensgroep»
BAGIdentificatie
«authentiek»
- identificatieAdresseerbaarObject :Tekst16 [0..1]
- identificatieNummeraanduiding :Tekst16 [0..1]
Pagina 15 van 26
Kamer van Koophandel Nederland
class Hoofdv estiging
«gegevensgroep»
Nummer
0..*
0..1
«gegevensgroep»
Communicatiegegev en-Vestiging
-
«gegevensgroep»
Communicatiegegev en
communicatieNummer :Alfanumeriek15
soortCommunicatieNummer :SoortCommunicatieNummer
toegangscode :Numeriek4
«gegevensgroep»
EmailAdres
0..*
-
adres :Tekst200
«gegevensgroep»
Domeinnaam
«gegevensgroep»
Handelsnaam
heeft
1..*
Pagina 16 van 26
1..*
0..*
-
naam :Tekst300
«authentiek»
- handelsnaam :Tekst625
Kamer van Koophandel Nederland
3.5
Nevenvestiging
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de nevenvestiging van de
maatschappelijke activiteit.
class Nev env estiging
Name:
Package:
Version:
Author:
Nevenvestiging
Nevenvestiging
2.3
Stefan Staal
«objecttype»
Vestiging
«Identificatie, authentiek, trigger»
- vestigingsnummer :Numeriek12
«objecttype»
NietCommercieleVestiging
«gegevensgroep»
Locatie-Vestiging
1
+Bezoekadres
(authentiek)
«objecttype»
CommercieleVestiging
1..*
«authentiek»
- naam :Tekst500
«naamgeving»
- ookGenoemd :Tekst500 [0..1]
- verkorteNaam :Tekst45 [0..1]
«gegevensgroep»
Locatie
«niet authentiek»
- afgeschermd :Indicatie
- toevoegingAdres :Tekst100 [0..1]
heeft
«afleiding»
- /volledigAdres :Tekst500
0..*
1..*
Van
«gegevensgroep»
Handelsnaam
0..1
«authentiek»
- handelsnaam :Tekst625
0..1
«gegevensgroep»
Adres
«gegevensgroep»
BinnenlandsAdres
-
0..*
Tot en met
huisletter :Letter [0..1]
huisnummer :Numeriek5 [0..1]
huisnummerToevoeging :Alfanumeriek4 [0..1]
plaats :Tekst24
postbusnummer :Numeriek5 [0..1]
postcode :Postcode
straatnaam :Tekst40 [0..1]
«gegevensgroep»
BuitenlandsAdres
-
land :Tekst40
postcodeWoonplaats :Tekst200
regio :Tekst150 [0..1]
straatHuisnummer :Tekst200
0..1
«gegevensgroep»
BAGIdentificatie
«authentiek»
- identificatieAdresseerbaarObject :Tekst16 [0..1]
- identificatieNummeraanduiding :Tekst16 [0..1]
Pagina 17 van 26
Kamer van Koophandel Nederland
3.6
Functievervulling
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de functievervulling(en) bij de
inschrijving.
Dataservice Inschrijving toont alle functies (functievervullingen) voor de Hoofdvestiging én voor de
Nevenvestiging(en).
class Functiev erv ulling
Name:
Package:
Version:
Author:
Functievervulling
Functievervulling
2.3
Stefan Staal
«objecttype»
FunctieVervulling
-
datumAanvang :DatumIncompleet
«afleiding»
- /langstzittende :Indicatie [0..1]
«objecttype»
Aansprakelij ke
-
functie :TypeAansprakelijke
handelingsbekwaam :Indicatie
«objecttype»
Ov erigeFunctionaris
van
0..1
«gegevensgroep»
FunctieTitel
-
-
functieTitel :Tekst100 [0..1]
indicatieStatutair :Indicatie [0..1]
afwijkendAansprakelijksheidsbeding :Indicatie [0..1]
functie :TypeOverigeFunctionaris
geplaatstKapitaal :Kapitaal [0..1]
gestortKapitaal :Kapitaal [0..1]
«objecttype»
Publiekrechtelij keFunctionaris
-
functie :TypePubliekrechtelijkeFunctionaris
0..1
RechterlijkeUitspraak
«gegevensgroep»
Schorsing
«objecttype»
Bestuursfunctie
-
functie :TypeBestuurder
«niet authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
1
de datums aanvang en
einde van de
RechterlijkeUitspraak
worden geleverd.
«objecttype»
Gemachtigde
-
functie :TypeGemachtigde
«objecttype»
FunctionarisBij zondereRechtstoestand
«objecttype»
Bewindv oerder
«objecttype»
Curator
«objecttype»
RechterCommissaris
Pagina 18 van 26
Kamer van Koophandel Nederland
class Functiev erv ulling
«gegevensgroep»
Bev oegdheidAansprakelij ke
0..1 -
beperkingInEuros :Geld [0..1]
overigeBeperking :Indicatie [0..1]
soortBevoegdheid :SoortBevoegdheidAansprakelijke
«gegevensgroep»
Bev oegdheidFunctionarisVolgensBuitenlandsRecht
0..1 «niet authentiek»
- soortBevoegdheid :SoortBevoegdheidFunctionarisVolgensBuitenlandsRecht
«GBA»
- aanduidingNaamgebruik :AanduidingNaamgebruik [0..1]
- adellijkeTitel :Tekst10 [0..1]
- geslachtsnaamPartner :Tekst200 [0..1]
- voorvoegselGeslachtsnaamPartner :Tekst10 [0..1]
«gegevensgroep»
Bev oegdheidPubliekrechtelij keFunctionaris
0..1 -
soortBevoegdheid :SoortBevoegdheidPubliekrechtelijkefunctionaris
«gegevensgroep»
Bev oegdheidBestuurder
0..1 -
0..1
bevoegdMetAnderePersonen :Indicatie [0..1]
soortBevoegdheid :SoortBevoegdheidBestuurder
1 -
«authentiek»
- geboortedatum :DatumIncompleet
- geboorteland :Tekst40
- geboorteplaats :Tekst200 [0..1]
- geslachtsaanduiding :Geslachtsaanduiding
- geslachtsnaam :Tekst200
- overlijdensdatum :DatumIncompleet [0..1]
- voornamen :Tekst200 [0..1]
- voorvoegselGeslachtsnaam :Tekst10 [0..1]
«niet authentiek»
- handelingsbekwaam :Indicatie
«Identificatie, authentiek, trigger»
- natuurlijkPersoonId :NatuurlijkPersoonId
«objecttype»
Vertegenw oordigerBestuurderRechtspersoon
«gegevensgroep»
Volmacht
Persoon
«objecttype»
Natuurlij kPersoon
heeft betrekking op
statutair :Indicatie
«objecttype»
Vestiging
0..* «Identificatie, authentiek, trigger»
- vestigingsnummer :Numeriek12
«gegevensgroep»
VolledigeVolmacht
«gegevensgroep»
BeperkteVolmacht
-
beperkingInGeld :Geld [0..1]
doenVanOpgaveAanHetHandelsregister :Indicatie [0..1]
omschrijvingOverigeBeperkingen :Tekst2000 [0..1]
overigeVolmacht :Indicatie [0..1]
1
geldt voor
0..*
«gegevensgroep»
BeperkingInHandeling
-
Pagina 19 van 26
beperkingInGeld :Geld [0..1]
soortHandeling :SoortHandeling
Kamer van Koophandel Nederland
3.7
Functionaris
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de functionaris die de functievervulling
uitoefent.
Persoon / Functionaris heeft/is eigenaar van <<objecttype>> MaatschappelijkeActiviteit wordt conditioneel getoond:
 NIET bij Functionarissen NatuurlijkPersonen
 Wel bij alle overige Personen (NNP)
class Functionaris
Name:
Package:
Version:
Author:
«objecttype»
Persoon
Functionaris
Functionaris
2.3
Stefan Staal
1
«afleiding»
- /volledigeNaam :T ekst500
«objecttype»
Maatschappelij keActiv iteit
heeft
«Identificatie, authentiek, trigger»
- kvkNummer :Numeriek8
0..1
«objecttype»
Natuurlij kPersoon
«objecttype»
NaamPersoon
-
«GBA»
- aanduidingNaamgebruik :AanduidingNaamgebruik [0..1]
- adellijkeT itel :Tekst10 [0..1]
- geslachtsnaamPartner :T ekst200 [0..1]
- voorvoegselGeslachtsnaamPartner :Tekst10 [0..1]
«objecttype»
NietNatuurlij kPersoon
naam :T ekst200 [0..1]
«Identificatie, authentiek, trigger»
- rsin :Numeriek9
+Contains
«authentiek»
- geboortedatum :DatumIncompleet
- geboorteland :T ekst40
- geboorteplaats :Tekst200 [0..1]
- geslachtsaanduiding :Geslachtsaanduiding
- geslachtsnaam :Tekst200
- overlijdensdatum :DatumIncompleet [0..1]
- voornamen :T ekst200 [0..1]
- voorvoegselGeslachtsnaam :T ekst10 [0..1]
0..1
«gegevensgroep»
TelefoonNaamPersoon
-
telefoonNummer :Alfanumeriek15
toegangscode :Numeriek4
«niet authentiek»
- handelingsbekwaam :Indicatie
«Identificatie, authentiek, trigger»
- natuurlijkPersoonId :NatuurlijkPersoonId
«gegevensgroep»
Locatie
+/bezoekadres
1
«niet authentiek»
- afgeschermd :Indicatie
- toevoegingAdres :T ekst100 [0..1]
«afgeleid»
Locatie-Persoon
«afleiding»
- /volledigAdres :T ekst500
0..*
Van
0..*
T ot en met
0..1
0..1
«gegevensgroep»
Adres
«gegevensgroep»
BinnenlandsAdres
-
huisletter :Letter [0..1]
huisnummer :Numeriek5 [0..1]
huisnummerToevoeging :Alfanumeriek4 [0..1]
plaats :T ekst24
postbusnummer :Numeriek5 [0..1]
postcode :Postcode
straatnaam :T ekst40 [0..1]
«gegevensgroep»
BuitenlandsAdres
-
land :T ekst40
postcodeWoonplaats :T ekst200
regio :T ekst150 [0..1]
straatHuisnummer :T ekst200
0..1
«gegevensgroep»
BAGIdentificatie
«authentiek»
- identificatieAdresseerbaarObject :T ekst16 [0..1]
- identificatieNummeraanduiding :T ekst16 [0..1]
Pagina 20 van 26
Kamer van Koophandel Nederland
class Functionaris
RechterlijkeUitspraak
«gegevensgroep»
BeperkingInRechtshandeling
0..1
«niet authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
- soort :SoortBeperkingRechtshandeling
«gegevensgroep»
Faillissement
RechterlijkeUitspraak
«gegevensgroep»
Bij zondereRechtstoestand
0..1
«niet authentiek»
- datumAanvang :DatumIncompleet
- datumEinde :DatumIncompleet [0..1]
- redenEinde :RedenEindeInsolventie [0..1]
«gegevensgroep»
Schuldsanering
«gegevensgroep»
SurseanceVanBetaling
«niet authentiek»
- duur :Tekst200 [0..1] = 18
- status :StatusInsolventie [0..1]
«objecttype»
BuitenlandseVennootschap
-
«objecttype»
BinnenlandseNietNatuurlij kPersoon
buitenlandsRegister :Tekst50
inschrijfnummerBuitenland :Tekst50 [0..1]
land :Tekst40
plaatsBuitenlandsRegister :Tekst40 [0..1]
«objecttype»
RechtspersoonInOprichting
Pagina 21 van 26
«objecttype»
EenmanszaakMetMeerdereEigenaren
«objecttype»
Samenw erkingsv erband
«objecttype»
Rechtspersoon
Kamer van Koophandel Nederland
3.8
Overdracht
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de overdracht van een onderneming.
Dit hoofdstuk beschrijft de gegevensblokken 'Overgedragen' en 'Overgenomen' die in de figuur in hoofdstuk 3 worden
genoemd.
class Ov erdracht
Name:
Package:
Version:
Author:
Overdracht
Overdracht
2.3
Stefan Staal
«gegevensgroep»
Ov erdracht
«authentiek»
- datumOverdracht :DatumIncompleet [0..1]
Pagina 22 van 26
Kamer van Koophandel Nederland
3.9
Voortzetting
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de voortzetting van een onderneming.
Dit hoofdstuk beschrijft de gegevensblokken 'Voortgezet (overgedragen)' en 'Voortgezet (overgenomen)' die in de
figuur in hoofdstuk 3 worden genoemd.
class Voortzetting
Name:
Package:
Version:
Author:
Voortzetting
Voortzetting
2.3
Stefan Staal
«gegevensgroep»
Voortzetting
«authentiek»
- datumVoortzetting :DatumIncompleet [0..1]
Pagina 23 van 26
Kamer van Koophandel Nederland
3.10
Onderneming bij overdracht en voorzetting
Onderstaand diagram toont de gegevens en de samenhang van gegevens van de onderneming die betrokken is bij
een overdracht of voortzetting.
class Ondeneming bij ov erdracht ...
Name:
Package:
Version:
Author:
Ondeneming bij overdracht en voortzetting
Onderneming bij overdracht en voorzetting
2.3
Stefan Staal
«objecttype»
Onderneming
«Identificatie, trigger»
- /kvkNummer :Numeriek8
Pagina 24 van 26
Kamer van Koophandel Nederland
4
Meldingen
In dit hoofdstuk staan de mogelijke meldingen schematisch weergegeven en beschreven die met het opvragen van dit
product/dienst kunnen optreden.
Een melding kan als fout, waarschuwing of als aanvullende informatie voorkomen. Afhankelijk van de context wordt
dit bepaald. Het is aan afnemer om de consequentie van de melding in zijn informatievoorziening te verwerken.
class Meldingen
Name:
Package:
Version:
Author:
Meldingen
Meldingen
2.3
Stefan Staal
IPD0000 Het product is succesvol geproduceerd
IPD0001 Het gevraagde artikel <productNaam> bestaat niet.
IPD0002 De gevraagde versie <versie> van het product <productNaam>
bestaat niet.
IPD0003 Het klantnummer <klantnummer> is onbekend.
IPD0004 Het KvK nummer <kvkNummer> is niet valide
IPD0005 Op basis van het KvK-nummer <kvkNummer> kan het product
niet worden geleverd.
IPD1000 Eén of meerdere inschrijvingen (KvKnummers) zijn niet
beschikbaar. Het product kan niet worden samengesteld.
IPD1002 De gegevens zijn tijdelijk niet leverbaar omdat deze in
behandeling zijn. Probeer het later nog eens.
IPD9998 Algemene invoer parameter fout
IPD9999 Algemene technische fout
Pagina 25 van 26
Kamer van Koophandel Nederland
Code & Omschrijving
Type melding
Beschrijving
IPD0000 Het product is succesvol
geproduceerd
Informatie
IPD0001 Het gevraagde artikel
<productNaam> bestaat niet.
IPD0002 De gevraagde versie
<versie> van het product
<productNaam> bestaat niet.
IPD0003 Het klantnummer
<klantnummer> is onbekend.
Foutmelding
Gedurende het produceren (gegevens verzamelen,
opmaken en verpakken) van de bestelling zijn er
geen verstoringen opgetreden.
Er wordt een artikel besteld (artikelcode) dat niet
bekend is bij de KvK (artikelcode bestaat niet).
Er wordt een versie van het artikel besteld dat niet
(meer) door de KvK wordt geleverd.
IPD0004 Het KvK nummer
<kvkNummer> is niet valide
Foutmelding
IPD0005 Op basis van het
KvK-nummer <kvkNummer> kan het
product niet worden geleverd.
Foutmelding
IPD1000 Eén of meerdere
inschrijvingen (KvKnummers) zijn niet
beschikbaar. Het product kan niet
worden samengesteld.
IPD1002 De gegevens zijn tijdelijk niet
leverbaar omdat deze in behandeling
zijn. Probeer het later nog eens.
IPD9998 Algemene invoer parameter
fout
IPD9999 Algemene technische fout
Foutmelding
Pagina 26 van 26
Foutmelding
Foutmelding
Er is een bestelling geplaatst door een onbekende
afnemer.
- Onbekend WWW profiel (controleer LDAP/CF
beheer)
- Er is een fout opgetreden bij de operatie
OphalenDebiteur (Generiek boekingsservice)
Het opgegeven KvKnummer voldoet niet aan zijn
formaat.
- 8 posities lang
- Voldoet niet aan 11-proef
Er is geen Onderneming of Maatschappelijke
activiteit gevonden van het betreffende KvKnummer.
- KvKnummer bevindt zich niet in de IPD
componenten cache
Er is een aantekening (noodprocedure) op een
KvKnummer dat in het product wordt gebruikt.
Waarschuwing
Er is een blokkade (algemeen) op een KvKnummer
dat in het product wordt gebruikt.
Foutmelding
Het artikel dat wordt besteld wordt met ongeldige of
onvolledige parameters opgevraagd.
Het produceren van het artikel is gefaald door een
technische fout.
Foutmelding
Kamer van Koophandel Nederland