VIES (data source)

From CDQ Wiki
DataSource:VIES
Jump to navigation Jump to search
Property Value
Identifiers VIES (The ALEI prefix element is the ISO 3166-2 code for country and subdivision if applicable followed by the stop character <code>.</code>. This is followed by an acronym representing the register maintained by the administrative agency for the governing body of a nation, state, or community that assigned the identifier element. The prefix is assigned by ECCMA ALEI prefix), VIES (A technical identifier, unique in a certain context. Technical key)
Language-specific short name. Monolingual short name VIES (en)
Language-specific name. Monolingual name VAT Information Exchange System (en)
An informal and short human-readable definition of a concept, in terms of a 'one-liner'. Short description VAT Information Exchange System is a data source that helps CDQ customers validate and enrich business partner master data for compliance and data quality.
The country a linked concept is active or generally relevant for. Country scope XI (United Kingdom (Northern Ireland), Northern Ireland)
Data access European Commission (Provider or authority of a data source. Provider), website (URL that provides more information for a given concept. URL), API (URL that provides direct access to the data of a data source. Deep URL), IDENTIFIER (Search type (data sources)<br/>Describes how data can be searched in a data source.<br/><code>FUZZY</code>: Data can be searched by address and name attributes.<br/><code>IDENTIFIER</code>: Data can be searched by business identifiers.<br/><code>INDEX</code>: Data can be searched by business identifiers. Search type)
nonetheless, we continue to offer the most recent available data., The release status in terms of development progress or maturity.<br/><code>EMPTY</code> (0): No feature considered yet, just a rough idea.<br/><code>IDEA</code> (1): Just an idea, not yet designed in detail.<br/><code>DESIGN</code> (2): Software design ready, development not yet started.<br/><code>DEVELOPMENT</code> (3): Software development in progress.<br/><code>ALPHA</code> (4): First functional release, in terms of a Minimal Viable Product (MVP).<br/><code>BETA</code> (5): Tested by selected users.<br/><code>RC</code> (6): Release candidate, fully tested, not yet used in production by many customers.<br/><code>LIVE</code> (7): Used in production by customers, fully monitored and supported.<br/><code>DEPRECATED</code> (-1): End of life planned, but still available.<br/><code>EOL</code> (-2): End of life, historic service, no longer available.<br/><code>BROKEN</code> (-3): Service was used in production but is currently not available. However, CDQ tries to repair or reactivate it.<br/><code>DISCONTINUED</code> (-4): The data source has ceased providing updates Release status LIVE, REMOTE_ACCESS (Documents how a data source is integrated into the CDL with respect to data gathering:<br/><code>REMOTE ACCESS</code>: Data is not stored on CDL side but queried ad-hoc from the data source (e.g. webservices)<br/><code>COPY</code>: Data is replicated on CDL side (usually already transformed into the target CDL data model)<br/><code>UNDEFINED</code>: not yet known Integration type)
Content BUSINESS_PARTNER (Specifies the category of a data source. The following categories are defined:<br/><code>BUSINESS_PARTNER</code>: The data source provides master data about companies.<br/><code>ADDRESS</code>: The data source provides address reference data.<br/><code>SANCTION_AND_WATCHLIST</code>: A data source that provides sanctioned or watched companies or persons.<br/><code>BANK_ACCOUNT</code>: The data source provides bank and bank account reference data.<br/><code>CERTIFICATE</code>: The data source provides information about business partner certifications.<br/><code>BENEFICIAL_OWNER</code>: The data source provides information about beneficial owners of companies.<br/><code>INSOLVENCY</code>: The data source provides information about insolvencies.<br/><code>HEALTHCARE_PROFESSIONAL</code>: The data source provides information about HCPs.<br/><code>HEALTHCARE_ORGANIZATION</code>: The data source provides information about HCOs. Data source category), 50,000,000 (Counts the number of company records available in the data source. Number of records) , 87 concepts, 30 terms
Legal classification 2020-01-01 (Date when a legal classification was approved (the last time). Legal approval), GOVERNMENTAL (Data ownership<br/>Categorizes legal right-holding by the type of the data owner, e.g. a private organization or a governmental authority.<br/><code>GOVERNMENTAL</code>: The data source is owned by a governmental body, e.g., a federal, state, or municipal authority.<br/><code>PRIVATE</code>: The data source is owned by a private body, e.g., a company or an association. Data ownership), FREE (Data provision<br/>Categorizes restriction of data access, i.e., whether a data source provides "open" data or requires registration.<br/><code>COMMERCIAL</code>: Data is not provided for free, but users of the data source have to pay for downloading, querying, or using the data according to a commercial contract.<br/><code>FREE</code>: Data is provided for free, but the data source requires registration, i.e., authentication when data is downloaded or queried.<br/><code>OPEN</code>: Data is provided for free and unlimited access without registration or subscription. Data provision), CLIENT_CONTRACTED (Terms type<br/>A client or CDQ accepts the terms of use of a particular data source and the compliant use of its data.<br/><code>CDQ_CONTRACTED</code>: CDQ accepts the terms of a particular data source and the compliant use of its data.<br/><code>CLIENT_CONTRACTED</code>: A client (i.e., the data end user) accepts the terms of a particular data source and the compliant use of its data.<br/><code>EU_PRIVATE</code>: The data source is provided by a private organization under EU law, i.e., from "within" a EU member country.<br/><code>EU_PUBLIC</code>: The data source is provided by a governmental organization under EU law, i.e., from "within" a EU member country.<br/><code>NO_TERMS</code>: No specific terms of use are provided for a data source.<br/><code>STANDARD_LICENCE</code>: A standard licence is used, further details are provided by license type information of the data source. Terms type), https://ec.europa.eu/taxation customs/vies/#/disclaimer (URL that provides more information on a license, e.g., of a data source. License URL)
Quota 750,000 (The default maximum quota for a data source. Maximum Quota (default)), MONTH (Quota reset<br/>The default reset period of a defined quota for a data source.<br/><code>DAY</code>: The quota of the data source is reset daily.<br/><code>MONTH</code>: The quota of the data source is reset monthly.<br/><code>WEEK</code>: The quota of the data source is reset weekly.<br/><code>YEAR</code>: The quota of the data source is reset yearly. Quota reset (default)), CDQ (Quota control<br/>The control of changing the maximum quota and reset period for a data source.<br/><code>CDQ</code>: The quota of the data source can be higher than set by CDQ.<br/><code>CLIENT</code>: The quota of the data source can be set higher than the default.<br/><code>CREDENTIAL_DEPENDENT</code>: If a customer uses CDQ credentials to assess the data source then the quota can't be higher than the default, but if customers use their own credentials, then the quota can be increased. Quota control), YES (Quota enablement<br/>whether the quota management is turned on for a specific data source.<br/><code>NO</code>: The data source does not have an enabled quota.<br/><code>YES</code>: A quota is enabled for the data source. Quota enabled)
Update monitoring YES (Update monitor enablement<br/>whether the update monitoring is turned on for a specific data source.<br/><code>NO</code>: For the data source, no update monitor is enabled.<br/><code>YES</code>: An update monitor is enabled for the data source. Update monitoring enabled), Every 6th day of the month at 01:00 (Date and time when a data source is checked to find updates. Update frequency)

Managed business identifiers

No managed business identifiers in VIES

Data model concepts

ConceptTechnical nameParentDescriptionCDQ mapping
RECORD (VIES)recordAn artificial record that wraps one record, i.e. a row in the data source file
administrativeAreas (VIES)referenceAddressDto_administrativeAreasreferenceAddressDto (VIES)
careOf (VIES)referenceAddressDto_careOfreferenceAddressDto (VIES)
characterSet (VIES)referenceAddressDto_version_characterSetversion (VIES)
contexts (VIES)referenceAddressDto_contextsreferenceAddressDto (VIES)
country (VIES)referenceAddressDto_countryreferenceAddressDto (VIES)country root field
countryCode (VIES)countryCodeRECORD (VIES)countryCode root field
direction (VIES)referenceAddressDto_thoroughfares_directionthoroughfares (VIES)
externalId (VIES)referenceAddressDto_externalIdreferenceAddressDto (VIES)
formattedAddress (VIES)referenceAddressDto_formattedAddressreferenceAddressDto (VIES)
geographicCoordinates (VIES)referenceAddressDto_geographicCoordinatesreferenceAddressDto (VIES)
identifyingName (VIES)referenceAddressDto_identifyingNamereferenceAddressDto (VIES)
language (VIES)referenceAddressDto_metadata_languagemetadata (VIES)
language (VIES)referenceAddressDto_thoroughfares_languagethoroughfares (VIES)
language (VIES)referenceAddressDto_localities_languagelocalities (VIES)
language (VIES)referenceAddressDto_version_languageversion (VIES)
localities (VIES)referenceAddressDto_localitiesreferenceAddressDto (VIES)
metadata (VIES)referenceAddressDto_metadatareferenceAddressDto (VIES)metadata root field
name (VIES)referenceAddressDto_version_language_nameversion (VIES)
name (VIES)referenceAddressDto_thoroughfares_type_nametype (VIES)
name (VIES)referenceAddressDto_localities_type_nametype (VIES)
name (VIES)response_nameVIES/record/response
name (VIES)referenceAddressDto_thoroughfares_namethoroughfares (VIES)
name (VIES)referenceAddressDto_version_characterSet_nameversion (VIES)
number (VIES)referenceAddressDto_thoroughfares_numberthoroughfares (VIES)Number (CDQ)
openingHours (VIES)referenceAddressDto_openingHoursreferenceAddressDto (VIES)
postCodes (VIES)referenceAddressDto_postCodesreferenceAddressDto (VIES)
postalDeliveryPoints (VIES)referenceAddressDto_postalDeliveryPointsreferenceAddressDto (VIES)
premises (VIES)referenceAddressDto_premisesreferenceAddressDto (VIES)
primaryProvenance (VIES)referenceAddressDto_metadata_primaryProvenancemetadata (VIES)
referenceAddressDto (VIES)referenceAddressDtoRECORD (VIES)
requestDate (VIES)requestDateRECORD (VIES)requestDate root field
requestIdentifier (VIES)requestIdentifierRECORD (VIES)requestIdentifier root field
shortName (VIES)referenceAddressDto_country_shortNamecountry (VIES)
shortName (VIES)referenceAddressDto_thoroughfares_shortNamethoroughfares (VIES)
shortName (VIES)referenceAddressDto_localities_shortNamelocalities (VIES)
technicalKey (VIES)referenceAddressDto_version_language_technicalKeyversion (VIES)
technicalKey (VIES)referenceAddressDto_thoroughfares_type_technicalKeytype (VIES)
technicalKey (VIES)referenceAddressDto_localities_type_technicalKeytype (VIES)
technicalKey (VIES)referenceAddressDto_version_characterSet_technicalKeyversion (VIES)
thoroughfares (VIES)referenceAddressDto_thoroughfaresreferenceAddressDto (VIES)
traderAddress (VIES)traderAddressRECORD (VIES)traderAddress root field
traderCity (VIES)traderCityRECORD (VIES)traderCity root field
traderCityMatch (VIES)traderCityMatchRECORD (VIES)traderCityMatch root field
traderCompanyType (VIES)traderCompanyTypeRECORD (VIES)traderCompanyType root field
traderCompanyTypeMatch (VIES)traderCompanyTypeMatchRECORD (VIES)traderCompanyTypeMatch root field
traderName (VIES)traderNameRECORD (VIES)traderName root field
traderNameMatch (VIES)traderNameMatchRECORD (VIES)traderNameMatch root field
traderPostcode (VIES)traderPostcodeRECORD (VIES)traderPostcode root field
traderPostcodeMatch (VIES)traderPostcodeMatchRECORD (VIES)traderPostcodeMatch root field
traderStreet (VIES)traderStreetRECORD (VIES)traderStreet root field
traderStreetMatch (VIES)traderStreetMatchRECORD (VIES)traderStreetMatch root field
type (VIES)referenceAddressDto_postCodes_typepostCodes (VIES)
type (VIES)referenceAddressDto_thoroughfares_typethoroughfares (VIES)
type (VIES)referenceAddressDto_localities_typelocalities (VIES)
types (VIES)referenceAddressDto_typesreferenceAddressDto (VIES)
url (VIES)referenceAddressDto_thoroughfares_type_urltype (VIES)
url (VIES)referenceAddressDto_localities_type_urltype (VIES)
valid (VIES)validRECORD (VIES)valid root field
value (VIES)traderPostcodeMatch_valueRECORD (VIES)Trader postcode match
value (VIES)requestIdentifier_valueRECORD (VIES)Identifier for proving that data was requested for a given VAT number
value (VIES)traderAddress_valueRECORD (VIES)VAT registered address of the business partner
value (VIES)traderPostcode_valueRECORD (VIES)Trader postcode
value (VIES)referenceAddressDto_postCodes_valuepostCodes (VIES)Value (CDQ)
value (VIES)response_countryCodeVIES/record/responseThe country code of the business partner's VAT registration
value (VIES)traderNameMatch_valueRECORD (VIES)Trader name match
value (VIES)valid_valueRECORD (VIES)Returns whether the given VAT number is valid
value (VIES)referenceAddressDto_identifyingName_valueidentifyingName (VIES)Value (CDQ)
value (VIES)referenceAddressDto_country_valuecountry (VIES)Value (CDQ)
value (VIES)traderName_valueRECORD (VIES)VAT registered name of the business partner
value (VIES)traderCompanyTypeMatch_valueRECORD (VIES)Trader company type match
value (VIES)response_validVIES/record/responseReturns whether the given VAT number is valid
value (VIES)requestDate_valueRECORD (VIES)Date when the data for a given VAT number was requested
value (VIES)referenceAddressDto_careOf_valuecareOf (VIES)Value (CDQ)
value (VIES)traderCompanyType_valueRECORD (VIES)Trader company type
value (VIES)vatValue_valueRECORD (VIES)The business partner's EU VAT number
value (VIES)traderCityMatch_valueRECORD (VIES)Trader city match
value (VIES)traderStreetMatch_valueRECORD (VIES)Trader street match
value (VIES)referenceAddressDto_premises_valuereferenceAddressDto (VIES)Value (CDQ)
value (VIES)referenceAddressDto_thoroughfares_valuethoroughfares (VIES)Value (CDQ)
value (VIES)response_vatNumberVIES/record/responseThe business partner's EU VAT number
value (VIES)referenceAddressDto_localities_valuelocalities (VIES)Value (CDQ)
value (VIES)countryCode_valueRECORD (VIES)The country code of the business partner's VAT registration
value (VIES)traderCity_valueRECORD (VIES)Trader city
value (VIES)traderStreet_valueRECORD (VIES)Trader street
vatValue (VIES)vatValueRECORD (VIES)vatValue root field
version (VIES)referenceAddressDto_versionreferenceAddressDto (VIES)

Controlled vocabulary terms

Term (external)Technical nameParentDescriptionCDQ mappingMapping target constant
AT (VIES)ATvalue (VIES)AustriaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID AT
BE (VIES)BEvalue (VIES)BelgiumCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID BE
BG (VIES)BGvalue (VIES)BulgariaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID BG
CY (VIES)CYvalue (VIES)CyprusCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID CY
CZ (VIES)CZvalue (VIES)Czech RepublicCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID CZ
DE (VIES)DEvalue (VIES)GermanyCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID DE
DK (VIES)DKvalue (VIES)DenmarkCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID DK
EE (VIES)EEvalue (VIES)EstoniaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID EE
EL (VIES)ELvalue (VIES)GreeceCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID EL
ES (VIES)ESvalue (VIES)SpainCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID ES
FI (VIES)FIvalue (VIES)FinlandCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID FI
FR (VIES)FRvalue (VIES)FranceCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID FR
HR (VIES)HRvalue (VIES)CroatiaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID HR
HU (VIES)HUvalue (VIES)HungaryCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID HU
IE (VIES)IEvalue (VIES)IrelandCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID IE
IT (VIES)ITvalue (VIES)ItalyCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID IT
LT (VIES)LTvalue (VIES)LithuaniaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID LT
LU (VIES)LUvalue (VIES)LuxembourgCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID LU
LV (VIES)LVvalue (VIES)LatviaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID LV
MT (VIES)MTvalue (VIES)MaltaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID MT
NL (VIES)NLvalue (VIES)NetherlandsCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID NL
PL (VIES)PLvalue (VIES)PolandCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID PL
PT (VIES)PTvalue (VIES)PortugalCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID PT
RO (VIES)ROvalue (VIES)RomaniaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID RO
SE (VIES)SEvalue (VIES)SwedenCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID SE
SI (VIES)SIvalue (VIES)SloveniaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID SI
SK (VIES)SKvalue (VIES)SlovakiaCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID SK
XI (VIES)XIvalue (VIES)Northern IrelandCDQ/Business Partner/Identifier/Identifier Type/EU VAT ID XI
false (VIES)falsevalue (VIES)invalid entryCDQ/Business Partner/Identifier/Identifier Status/INACTIVE
true (VIES)truevalue (VIES)valid entryACTIVE (CDQ)