VPD vracia údaje o stranách ako objekt party. Tento článok popisuje štruktúru tohto objektu, dostupné vyhľadávacie parametre a príklady dopytov, ktoré môžete priamo použiť.

Každý výsledok z VPD má rovnakú štruktúru. Nižšie nájdete všetky polia objektu party:

Pole partyIds obsahuje zoznam objektov identifikátorov. Každý identifikátor má type (schéma, napr. KVK, OIN, VAT) a value (samotné číslo). Organizácia môže mať viacero identifikátorov.

Lokácie obsahujú údaje o adrese (ulica, PSČ, mesto, krajina) a voliteľne geografické súradnice (latitude a longitude). Organizácia môže mať viacero prevádzok.

VPD prehľadávate pomocou nasledujúcich parametrov dopytu:

Parametre môžete kombinovať na spresnenie vyhľadávania, napríklad názov a mesto súčasne.

{
  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
  }
}

Pri vyhľadávaní cez VPD je dobré vedieť, že parameter search prehľadáva všetky polia, zatiaľ čo name a id sú cielenejšie. Použite name, ak poznáte názov spoločnosti (alebo jeho časť), a id, ak máte presný identifikátor. Skombinujte postcode alebo city s name, ak očakávate viacero výsledkov a chcete filtrovať podľa lokácie.

Majte na pamäti, že maxResults je predvolene nastavené na 10. Ak chcete viac výsledkov, zadajte vyššiu hodnotu. Ak chcete rýchlo overiť, či konkrétna organizácia existuje, stačí maxResults: 1 s presným identifikátorom.

Chcete testovať dopyty interaktívne? Použite VPD Playground. Alebo si prečítajte, ako VPD zabudujete do Vašej integrácie.

• Prehľad VPD
• VPD Playground: interaktívne testovanie
• Používanie VPD vo vašej integrácii
• Registrácia na Peppol
• Elektronická fakturácia s eConnect