VPD vrací údaje o stranách jako objekt party. Tento článek popisuje strukturu tohoto objektu, dostupné vyhledávací parametry a příklady dotazů, které můžete přímo použít.

Každý výsledek z VPD má stejnou strukturu. Níže naleznete všechna pole objektu party:

Pole partyIds obsahuje seznam objektů identifikátorů. Každý identifikátor má type (schéma, např. KVK, OIN, VAT) a value (samotné číslo). Organizace může mít více identifikátorů.

Lokace obsahují údaje o adrese (ulice, PSČ, město, země) a volitelně geografické souřadnice (latitude a longitude). Organizace může mít více provozoven.

VPD prohledáváte pomocí následujících parametrů dotazu:

Parametry můžete kombinovat pro zpřesnění vyhledávání, například název a město současně.

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

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

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

Při vyhledávání přes VPD je dobré vědět, že parametr search prohledává všechna pole, zatímco name a id jsou cílenější. Použijte name, pokud znáte název společnosti (nebo jeho část), a id, pokud máte přesný identifikátor. Zkombinujte postcode nebo city s name, pokud očekáváte více výsledků a chcete filtrovat podle lokace.

Mějte na paměti, že maxResults je výchozí nastaveno na 10. Pokud chcete více výsledků, zadejte vyšší hodnotu. Pokud chcete rychle ověřit, zda konkrétní organizace existuje, stačí maxResults: 1 s přesným identifikátorem.

Chcete testovat dotazy interaktivně? Použijte VPD Playground. Nebo si přečtěte, jak VPD zabudujete do Vaší integrace.

• Přehled VPD
• VPD Playground: interaktivní testování
• Používání VPD ve vaší integraci
• Registrace na Peppol
• Elektronická fakturace s eConnect