Il modello dati di una party: identificativi, nomi, sedi e query di esempio.
La VPD restituisce i dati delle parti come oggetto party. Questo articolo descrive la struttura di quell'oggetto, i parametri di ricerca disponibili e query di esempio che può utilizzare direttamente.
Ogni risultato dalla VPD ha la stessa struttura. Di seguito tutti i campi dell'oggetto party:
idtypepartyIdslegalNametradeNamessectorCodeslocationswebsiteIl campo partyIds contiene una lista di oggetti identificativo. Ogni identificativo ha un type (lo schema, ad es. KVK, OIN, VAT) e un value (il numero stesso). Un'organizzazione può avere più identificativi.
Le sedi contengono dati di indirizzo (via, CAP, città, paese) e opzionalmente coordinate geografiche (latitude e longitude). Un'organizzazione può avere più sedi.
La VPD viene interrogata con i seguenti parametri di query:
idnamepostcodecitycountrysearchmaxResultsI parametri possono essere combinati per affinare la ricerca, ad esempio nome e città contemporaneamente.
{
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
}
}
Nella ricerca tramite la VPD è utile sapere che il parametro search cerca in tutti i campi, mentre name e id sono più mirati. Utilizzi name quando conosce il nome dell'azienda (o parte di esso), e id quando dispone di un identificativo esatto. Combini postcode o city con name se prevede più risultati e desidera filtrare per ubicazione.
Tenga presente che maxResults è impostato per impostazione predefinita a 10. Se desidera più risultati, fornisca un valore più alto. Per verificare rapidamente se un'organizzazione specifica esiste, maxResults: 1 con un identificativo esatto è sufficiente.
Desidera testare le query in modo interattivo? Utilizzi la VPD Playground. Oppure legga come utilizzare la VPD nella propria integrazione.
Provi la VPD Playground