Difference between revisions of "DBA UC1 data model"

From DE4A
Jump to navigation Jump to search
(Created page with "center|thumb|613x613px {| class="wikitable" |DE4A name |Property type |Cardinality |Data type |Related vocabulary |Controlled vocabulary |Remarks |...")
 
m
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
''Back to [[Use_Case_"Starting_a_Business_in_Another_Member_State"_(DBA_UC1)|main DBA UC1 page]]''
 +
 +
Company Reigstration evidence type
 +
 +
== Data model diagram ==
 
[[File:DBA data model.png|center|thumb|613x613px]]
 
[[File:DBA data model.png|center|thumb|613x613px]]
 +
 +
== Attribute specification ==
 
{| class="wikitable"
 
{| class="wikitable"
 
|DE4A name
 
|DE4A name
Line 349: Line 356:
 
|Label indicating the language of the specific address.  
 
|Label indicating the language of the specific address.  
 
|}
 
|}
 +
 +
== XSD ==
 +
<?xml version="1.0" encoding="utf-8"?>
 +
 +
<xs:schema xmlns:xs="<nowiki>http://www.w3.org/2001/XMLSchema</nowiki>"
 +
 +
         xmlns="<nowiki>urn:eu-de4a:xsd:CanonicalEvidenceType::CompanyRegistration:v0.6</nowiki>"
 +
 +
         targetNamespace="<nowiki>urn:eu-de4a:xsd:CanonicalEvidenceType::CompanyRegistration:v0.6</nowiki>"
 +
 +
         elementFormDefault="qualified"
 +
 +
         attributeFormDefault="unqualified"
 +
 +
         xmlns:cvb="<nowiki>http://www.w3.org/ns/corevocabulary/BasicComponents</nowiki>">
 +
 +
<!-- Import xml: namespace -->
 +
 +
<xs:import namespace="<nowiki>http://www.w3.org/XML/1998/namespace</nowiki>" schemaLocation="xml.xsd"/>
 +
 +
<!-- Import W3C Core Vocabularies basic elements -->
 +
 +
<xs:import namespace="<nowiki>http://www.w3.org/ns/corevocabulary/BasicComponents</nowiki>" schemaLocation="CoreVocabularies-BasicComponents-1.1.xsd" />
 +
 +
 
 +
 +
<!-- xml schema for CompanyInfo canonical evidence -->
 +
 +
 
 +
 +
<xs:element name="LegalEntity" type="LegalEntityType"/>
 +
 +
<xs:complexType name="LegalEntityType">
 +
 +
  <xs:annotation>
 +
 +
    <xs:documentation>
 +
 +
      Company's legal information
 +
 +
      - CompanyName: This is the primary name of the company. Can be provided for multiple languages.
 +
 +
      - CompanyType: Type of the company based on ISO 20275 (e.g: SA, PLC, LLC, GmbH etc)
 +
 +
      - CompanyStatus: Company status as defined in BRIS (closed, struck off the register, wound up, dissolved, economically active or inactive)
 +
 +
      - CompanyActivity: The activity of a company
 +
 +
      - RegistrationDate: Date of registration of the company
 +
 +
      - CompanyEndDate: The company end date
 +
 +
      - CompanyEUID: Identification of the company following the BRIS-structure: country code + register identifier + registration number + verification digit (optional)
 +
 +
      - VatNumber: The VAT registration number of the company
 +
 +
      - CompanyContactData: the contact information of the company (email and Telephone)
 +
 +
      - RegisteredAddress: Links a Legal Entity to its registered address.
 +
 +
      - PostalAddress: Company physical address
 +
 +
      - HasBranch: The branch information
 +
 +
    </xs:documentation>
 +
 +
  </xs:annotation>
 +
 +
  
 +
 +
  <xs:sequence>
 +
 +
    <xs:element name="CompanyName" type="NamesType" minOccurs="1" maxOccurs="unbounded"/>
 +
 +
    <xs:element name="CompanyType" type="xs:string" minOccurs="1" maxOccurs="1"/>
 +
 +
    <xs:element name="CompanyStatus" type="xs:string" minOccurs="1" maxOccurs="1"/>
 +
 +
    <xs:element name="CompanyActivity" type="ActivityType" minOccurs="1" maxOccurs="1"/>
 +
 +
    <xs:element name="RegistrationDate" type="xs:date" minOccurs="1" maxOccurs="1"/>
 +
 +
    <xs:element name="CompanyEndDate" type="xs:date" minOccurs="0" maxOccurs="1"/>
 +
 +
    <xs:element name="CompanyEUID" type="xs:string" minOccurs="1" maxOccurs="1"/>
 +
 +
    <xs:element name="VatNumber" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
 +
 +
    <xs:element name="CompanyContactData" type="ContactPointType" minOccurs="0" maxOccurs="1"/>
 +
 +
    <xs:element name="RegisteredAddress" type="AddressType" minOccurs="1" maxOccurs="unbounded"/>
 +
 +
    <xs:element name="PostalAddress" type="AddressType" minOccurs="0" maxOccurs="unbounded"/>
 +
 +
    <xs:element name="HasBranch" type="BranchType" minOccurs="0" maxOccurs="1"/>
 +
 +
  </xs:sequence>
 +
 +
</xs:complexType>
 +
 +
 +
<xs:complexType name="ContactPointType">
 +
 +
  <xs:annotation>
 +
 +
    <xs:documentation>
 +
 +
      - Email: A valid email address of the company
 +
 +
      - Telephone: Telephone number of the company
 +
 +
    </xs:documentation>
 +
 +
  </xs:annotation>
 +
 +
  
 +
 +
  <xs:sequence>
 +
 +
    <xs:element name="Email" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
 +
 +
    <xs:element name="Telephone" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
 +
 +
  </xs:sequence>
 +
 +
</xs:complexType>
 +
 +
 +
<xs:complexType name="ActivityType">
 +
 +
  <xs:annotation>
 +
 +
    <xs:documentation>
 +
 +
      - NaceCode: NACE-code of the company’s activities
 +
 +
      - ActivityDescription: Description of the activity
 +
 +
    </xs:documentation>
 +
 +
  </xs:annotation>
 +
 +
  
 +
 +
  <xs:choice>
 +
 +
    <xs:element name="NaceCode" type="xs:string" minOccurs="1" maxOccurs="unbounded"/>
 +
 +
    <xs:element name="ActivityDescription" type="xs:string" minOccurs="1" maxOccurs="unbounded"/>
 +
 +
  </xs:choice>
 +
 +
</xs:complexType>
 +
 +
 +
<xs:complexType name="BranchType">
 +
 +
  <xs:annotation>
 +
 +
    <xs:documentation>
 +
 +
      - BranchName: Primary name of the branch. Can be provided for multiple languages
 +
 +
      - BranchEUID: Identification of the branch of the company following the BRIS-structure: country code + register identifier + registration number + verification digit (optional)
 +
 +
      - BranchActivity: The activity of the branch presented by the NACE code and description
 +
 +
      - BranchRegistredAddress: The legal registered address of the branch 
 +
 +
      - BranchPostalAddress: The Physical address of the branch
 +
 +
    </xs:documentation>
 +
 +
  </xs:annotation>
 +
 +
  
 +
 +
  <xs:sequence>
 +
 +
    <xs:element name="BranchName" type="NamesType" minOccurs="1" maxOccurs="1"/>
 +
 +
    <xs:element name="BranchEUID" type="xs:string" minOccurs="1" maxOccurs="1"/>
 +
 +
    <xs:element name="BranchActivity" type="ActivityType" minOccurs="0" maxOccurs="1"/>
 +
 +
    <xs:element name="BranchRegistredAddress" type="AddressType" minOccurs="1" maxOccurs="1"/>
 +
 +
    <xs:element name="BranchPostalAddress" type="AddressType" minOccurs="0" maxOccurs="1"/>
 +
 +
  </xs:sequence>
 +
 +
</xs:complexType>
 +
 +
 +
<xs:complexType name="AddressType">
 +
 +
  <xs:annotation>
 +
 +
    <xs:documentation>
 +
 +
      - PoBox: The Post Office Box number
 +
 +
      - Thoroughfare: The Street name
 +
 +
      - LocationDesignator: House number  
 +
 +
      - PostCode:  Postal code / zip code
 +
 +
      - PostName: City
 +
 +
      - AdminUnitL2: Administration unit Level2 - County / region / state
 +
 +
      - AdminUnitL1: Country
 +
 +
    </xs:documentation>
 +
 +
  </xs:annotation>
 +
 +
  
 +
 +
  <xs:sequence>
 +
 +
    <xs:element name="PoBox" type="xs:string" minOccurs="0" maxOccurs="1"/>
 +
 +
    <xs:element name="Thoroughfare" type="xs:string" minOccurs="0" maxOccurs="1"/>
 +
 +
    <xs:element name="LocationDesignator" type="xs:string" minOccurs="0" maxOccurs="1"/>
 +
 +
    <xs:element name="PostCode" type="xs:string" minOccurs="0" maxOccurs="1"/>
 +
 +
    <xs:element name="PostName" type="xs:string" minOccurs="0" maxOccurs="1"/>
 +
 +
    <xs:element name="AdminUnitL1" type="xs:string" minOccurs="0" maxOccurs="1"/>
 +
 +
    <xs:element name="AdminUnitL2" type="xs:string" minOccurs="0" maxOccurs="1"/>
 +
 +
  </xs:sequence>
 +
 +
  <xs:attribute ref="xml:lang" use="optional"/>
 +
 +
</xs:complexType>
 +
 +
 +
<xs:complexType name="NamesType">
 +
 +
  <xs:annotation>
 +
 +
    <xs:documentation>
 +
 +
       - LegalEntityName: Legal name of the company
 +
 +
    </xs:documentation>
 +
 +
  </xs:annotation>
 +
 +
  <xs:sequence>
 +
 +
    <xs:element ref="cvb:LegalEntityLegalName" minOccurs="1" maxOccurs="1"/>
 +
 +
  </xs:sequence>
 +
 +
</xs:complexType>
 +
 +
</xs:schema>

Latest revision as of 16:32, 12 April 2021

Back to main DBA UC1 page

Company Reigstration evidence type

Data model diagram

DBA data model.png

Attribute specification

DE4A name Property type Cardinality Data type Related vocabulary Controlled vocabulary Remarks
LegalEntity Class 1
Company name Object 1..n Names This is the primary name of the company. Can be provided for multiple languages.
Company type Datatype 1 String CBV: legalEntity - companyType ISO 20275
Company status Datatype 1 String CBV: legalEntity - companyStatus BRIS
Company activity Object 1 Activity
Company registration date Datatype 1 Date
Company end date Datatype 0..1 Date
Company EUID Datatype 1 String BRIS: companyEUID This is the identifier as registered in the DP Country formatted as EUID conform BRIS specification: country code + register identifier + registration number + verification digit (optional)
Vat number Datatype 0..n String
Company contact data Object 0..1 ContactPoint
Company registration address Object 1..n Address Multiple occurrences allowed for different languages
Company postal address Object 0..n Address
Branch Object 0..1 Branch The branch of the parent-company doing business in another MS; will not be used in first pilot iteration
Names Class
Legal entity legal name Datatype 1 cvb:LegalEntityLegalName CBV: legalEntity - legalname Only different names if different xml language tags (ISO 639-1) are provided. Example:

<LegalEntityLegalName xml:lang="nl">Voorbeeldnaam</LegalEntityLegalName>

Contactpoint Class
Email Datatype 0..n String schema.org: contactPoint - email
Telephone Datatype 0..n String schema.org: contactPoint - telephone
Activity Class
NACE code Datatype 0..n String CBV: legalEntity - companyActivity NACE
Activity description Datatype 0..n String Description is only provided if NACE code can’t be provided.

Only different descriptions if different xml language tags (ISO 639-1) are provided

Branch This is a branch of the parent-company that is registered in the same MS as the parent-company. If provided in the evidence, this branch is the entity doing business abroad.
Branch name Object 1 Names This is the primary name of the branch. Can be provided for multiple languages.
Branch EUID Object 1 String
Branch activity Activity 0..1 Activity
Branch registered address Object 1 Address
Branch postal address Object 0..1 Address
Address Class CBV: Address
PO Box Datatype 0..1 String Post office box number
Thoroughfare Datatype 0..1 String Street
Locator designator Datatype 0..1 String House number
Post code Datatype 0..1 String Postal code / zip code
Post name (city) Datatype 0..1 String City
Admin unit level 2 Datatype 0..1 String County / region / state
Admin unit level 1 Datatype 0..1 String ISO 3166-1 alpha 2 Country
Language code Datatype 0..1 xml:lang ISO 639-1 Label indicating the language of the specific address.

XSD

<?xml version="1.0" encoding="utf-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"

         xmlns="urn:eu-de4a:xsd:CanonicalEvidenceType::CompanyRegistration:v0.6"

         targetNamespace="urn:eu-de4a:xsd:CanonicalEvidenceType::CompanyRegistration:v0.6"

         elementFormDefault="qualified"

         attributeFormDefault="unqualified"

         xmlns:cvb="http://www.w3.org/ns/corevocabulary/BasicComponents">


<xs:import namespace="http://www.w3.org/XML/1998/namespace" schemaLocation="xml.xsd"/>


<xs:import namespace="http://www.w3.org/ns/corevocabulary/BasicComponents" schemaLocation="CoreVocabularies-BasicComponents-1.1.xsd" />

 


 

<xs:element name="LegalEntity" type="LegalEntityType"/>

<xs:complexType name="LegalEntityType">

  <xs:annotation>

    <xs:documentation>

      Company's legal information

      - CompanyName: This is the primary name of the company. Can be provided for multiple languages.

      - CompanyType: Type of the company based on ISO 20275 (e.g: SA, PLC, LLC, GmbH etc)

      - CompanyStatus: Company status as defined in BRIS (closed, struck off the register, wound up, dissolved, economically active or inactive)

      - CompanyActivity: The activity of a company

      - RegistrationDate: Date of registration of the company

      - CompanyEndDate: The company end date

      - CompanyEUID: Identification of the company following the BRIS-structure: country code + register identifier + registration number + verification digit (optional)

      - VatNumber: The VAT registration number of the company

      - CompanyContactData: the contact information of the company (email and Telephone)

      - RegisteredAddress: Links a Legal Entity to its registered address.

      - PostalAddress: Company physical address

      - HasBranch: The branch information

    </xs:documentation>

  </xs:annotation>

  

  <xs:sequence>

    <xs:element name="CompanyName" type="NamesType" minOccurs="1" maxOccurs="unbounded"/>

    <xs:element name="CompanyType" type="xs:string" minOccurs="1" maxOccurs="1"/>

    <xs:element name="CompanyStatus" type="xs:string" minOccurs="1" maxOccurs="1"/>

    <xs:element name="CompanyActivity" type="ActivityType" minOccurs="1" maxOccurs="1"/>

    <xs:element name="RegistrationDate" type="xs:date" minOccurs="1" maxOccurs="1"/>

    <xs:element name="CompanyEndDate" type="xs:date" minOccurs="0" maxOccurs="1"/>

    <xs:element name="CompanyEUID" type="xs:string" minOccurs="1" maxOccurs="1"/>

    <xs:element name="VatNumber" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>

    <xs:element name="CompanyContactData" type="ContactPointType" minOccurs="0" maxOccurs="1"/>

    <xs:element name="RegisteredAddress" type="AddressType" minOccurs="1" maxOccurs="unbounded"/>

    <xs:element name="PostalAddress" type="AddressType" minOccurs="0" maxOccurs="unbounded"/>

    <xs:element name="HasBranch" type="BranchType" minOccurs="0" maxOccurs="1"/>

  </xs:sequence>

</xs:complexType>


<xs:complexType name="ContactPointType">

  <xs:annotation>

    <xs:documentation>

      - Email: A valid email address of the company

      - Telephone: Telephone number of the company

    </xs:documentation>

  </xs:annotation>

  

  <xs:sequence>

    <xs:element name="Email" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>

    <xs:element name="Telephone" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>

  </xs:sequence>

</xs:complexType>


<xs:complexType name="ActivityType">

  <xs:annotation>

    <xs:documentation>

      - NaceCode: NACE-code of the company’s activities

      - ActivityDescription: Description of the activity

    </xs:documentation>

  </xs:annotation>

  

  <xs:choice>

    <xs:element name="NaceCode" type="xs:string" minOccurs="1" maxOccurs="unbounded"/>

    <xs:element name="ActivityDescription" type="xs:string" minOccurs="1" maxOccurs="unbounded"/>

  </xs:choice>

</xs:complexType>


<xs:complexType name="BranchType">

  <xs:annotation>

    <xs:documentation>

      - BranchName: Primary name of the branch. Can be provided for multiple languages

      - BranchEUID: Identification of the branch of the company following the BRIS-structure: country code + register identifier + registration number + verification digit (optional)

      - BranchActivity: The activity of the branch presented by the NACE code and description

      - BranchRegistredAddress: The legal registered address of the branch 

      - BranchPostalAddress: The Physical address of the branch

    </xs:documentation>

  </xs:annotation>

  

  <xs:sequence>

    <xs:element name="BranchName" type="NamesType" minOccurs="1" maxOccurs="1"/>

    <xs:element name="BranchEUID" type="xs:string" minOccurs="1" maxOccurs="1"/>

    <xs:element name="BranchActivity" type="ActivityType" minOccurs="0" maxOccurs="1"/>

    <xs:element name="BranchRegistredAddress" type="AddressType" minOccurs="1" maxOccurs="1"/>

    <xs:element name="BranchPostalAddress" type="AddressType" minOccurs="0" maxOccurs="1"/>

  </xs:sequence>

</xs:complexType>


<xs:complexType name="AddressType">

  <xs:annotation>

    <xs:documentation>

      - PoBox: The Post Office Box number

      - Thoroughfare: The Street name

      - LocationDesignator: House number  

      - PostCode:  Postal code / zip code

      - PostName: City

      - AdminUnitL2: Administration unit Level2 - County / region / state

      - AdminUnitL1: Country

    </xs:documentation>

  </xs:annotation>

  

  <xs:sequence>

    <xs:element name="PoBox" type="xs:string" minOccurs="0" maxOccurs="1"/>

    <xs:element name="Thoroughfare" type="xs:string" minOccurs="0" maxOccurs="1"/>

    <xs:element name="LocationDesignator" type="xs:string" minOccurs="0" maxOccurs="1"/>

    <xs:element name="PostCode" type="xs:string" minOccurs="0" maxOccurs="1"/>

    <xs:element name="PostName" type="xs:string" minOccurs="0" maxOccurs="1"/>

    <xs:element name="AdminUnitL1" type="xs:string" minOccurs="0" maxOccurs="1"/>

    <xs:element name="AdminUnitL2" type="xs:string" minOccurs="0" maxOccurs="1"/>

  </xs:sequence>

  <xs:attribute ref="xml:lang" use="optional"/>

</xs:complexType>


<xs:complexType name="NamesType">

  <xs:annotation>

    <xs:documentation>

       - LegalEntityName: Legal name of the company

    </xs:documentation>

  </xs:annotation>

  <xs:sequence>

    <xs:element ref="cvb:LegalEntityLegalName" minOccurs="1" maxOccurs="1"/>

  </xs:sequence>

</xs:complexType>

</xs:schema>

Retrieved from ‘https://wiki.de4a.eu/index.php?title=DBA_UC1_data_model&oldid=1215’