VPD-Schema | eConnect

Die VPD gibt Parteidaten als party-Objekt zurück. Dieser Artikel beschreibt die Struktur dieses Objekts, die verfügbaren Suchparameter und Beispielabfragen, die Sie direkt verwenden können.

Das Party-Objekt

Jedes Ergebnis aus der VPD hat dieselbe Struktur. Nachfolgend finden Sie alle Felder des Party-Objekts:

Feld

Typ

Beschreibung

id

String

Eindeutiger Identifier der Partei in der VPD

type

String

Organisationstyp (z. B. Rechtsform)

partyIds

Array

Liste von Identifiern (Handelsregister, OIN, USt, GLN usw.)

legalName

String

Offizieller juristischer Name

tradeNames

Array

Handelsnamen, unter denen die Organisation tätig ist

sectorCodes

Array

SBI-Codes oder vergleichbare Branchenklassifikationen

locations

Array

Geschäftsadressen mit Adressdaten und Koordinaten (Breitengrad/Längengrad)

website

String

Website der Organisation (falls bekannt)

partyIds

Das Feld partyIds enthält eine Liste von Identifier-Objekten. Jeder Identifier hat einen type (das Schema, z. B. KVK, OIN, VAT) und einen value (die Nummer selbst). Eine Organisation kann mehrere Identifier haben.

locations

Standorte enthalten Adressdaten (Straße, Postleitzahl, Stadt, Land) und optional geografische Koordinaten (latitude und longitude). Eine Organisation kann mehrere Standorte haben.

Suchparameter

Sie durchsuchen die VPD mit den folgenden Abfrageparametern:

Parameter

Typ

Beschreibung

id

String

Suche nach spezifischem Identifier (z. B. Handelsregisternummer)

name

String

Suche nach Firmenname (juristisch oder Handelsname)

postcode

String

Filter nach Postleitzahl

city

String

Filter nach Ortsname

country

String

Filter nach Ländercode (ISO 3166-1 alpha-2)

search

String

Freitextsuche über alle Felder

maxResults

Int

Maximale Anzahl der Ergebnisse (Standard: 10)

Sie können Parameter kombinieren, um Ihre Suche zu verfeinern, zum Beispiel Name und Stadt gleichzeitig.

Beispielabfragen

Organisation nach Name suchen

{
  parties(name: "eConnect", country: "NL", maxResults: 5) {
    id
    legalName
    tradeNames
    partyIds {
      type
      value
    }
  }
}

Nach Identifier suchen (Handelsregisternummer)

{
  parties(id: "12345678", maxResults: 1) {
    id
    legalName
    locations {
      street
      postcode
      city
      country
      latitude
      longitude
    }
    website
  }
}

Freitextsuche mit allen Details

{
  parties(search: "Rechnungsstellung Woerden", maxResults: 10) {
    id
    type
    legalName
    tradeNames
    partyIds {
      type
      value
    }
    sectorCodes
    locations {
      street
      postcode
      city
      country
    }
    website
  }
}

Tipps für effektives Suchen

Bei der Suche über die VPD ist es nützlich zu wissen, dass der search-Parameter alle Felder durchsucht, während name und id gezielter sind. Verwenden Sie name, wenn Sie den Firmennamen (oder einen Teil davon) kennen, und id, wenn Sie einen exakten Identifier haben. Kombinieren Sie postcode oder city mit name, wenn Sie mehrere Ergebnisse erwarten und nach Standort filtern möchten.

Beachten Sie, dass maxResults standardmäßig auf 10 steht. Wenn Sie mehr Ergebnisse wünschen, geben Sie einen höheren Wert an. Möchten Sie schnell validieren, ob eine bestimmte Organisation existiert, genügt maxResults: 1 mit einem exakten Identifier.

Möchten Sie Abfragen interaktiv testen? Verwenden Sie den VPD Playground. Oder lesen Sie, wie Sie die VPD in Ihre Integration einbinden.

VPD Playground ausprobieren

Verwandt