Referenz
Ressourcen und Operationen
Abschnitt betitelt „Ressourcen und Operationen“| Ressource | Operation | Schnittstelle |
|---|---|---|
| USt-IdNr. | Validate | POST /abfrage |
| Info | Statusmeldungen | GET /info/statusmeldungen |
| Info | EU-Mitgliedstaaten | GET /info/eu_mitgliedstaaten |
Basis-URL ist https://api.evatr.vies.bzst.de/app/v1, Zeitüberschreitung 30 Sekunden.
USt-IdNr. → Validate
Abschnitt betitelt „USt-IdNr. → Validate“Eingabe
Abschnitt betitelt „Eingabe“| Feld | Pflicht | Bedeutung |
|---|---|---|
| Anmeldedaten: Eigene USt-IdNr. | ja | anfragende USt-IdNr. (anfragendeUstid) |
| Zu prüfende USt-IdNr. | ja | angefragteUstid |
| Zusätzliche Felder → Firmenname | für qualifizierte Abfrage | firmenname |
| Zusätzliche Felder → Ort | für qualifizierte Abfrage | ort |
| Zusätzliche Felder → Straße | nein | strasse |
| Zusätzliche Felder → PLZ | nein | plz |
Beide USt-IdNr. werden vor dem Senden normalisiert: Leerzeichen entfernt, Großbuchstaben. Leere Werte in den zusätzlichen Feldern werden nicht übertragen. Firmenname und Ort müssen gemeinsam gesetzt sein, sonst bricht die Node ab.
Ausgabe
Abschnitt betitelt „Ausgabe“| Feld | Immer | Bedeutung |
|---|---|---|
status |
ja | evatr-*-Code, siehe Status und Ergebnisse |
anfrageZeitpunkt |
ja | Zeitpunkt, auf den sich die Aussage bezieht |
id |
nein | technische ID der Anfrage beim BZSt |
gueltigAb |
nein | Beginn der Gültigkeit, bei evatr-2002 / evatr-2006 |
gueltigBis |
nein | Ende der Gültigkeit, bei evatr-2006 |
ergFirmenname |
nur qualifiziert | Vergleichsergebnis A / B / C / D |
ergOrt |
nur qualifiziert | Vergleichsergebnis |
ergStrasse |
nur qualifiziert | Vergleichsergebnis |
ergPlz |
nur qualifiziert | Vergleichsergebnis |
httpCode |
nur bei fachlicher Ablehnung | HTTP-Status, unter dem das BZSt geantwortet hat (400, 403, 404) |
Die Vergleichsergebnisse liefert das BZSt nur, wenn die Nummer gültig ist.
Info → Statusmeldungen
Abschnitt betitelt „Info → Statusmeldungen“Keine Eingabe. Ein Item je Statuscode:
| Feld | Bedeutung |
|---|---|
status |
der Code, z. B. evatr-2001 |
meldung |
Meldungstext im Klartext |
kategorie |
Einordnung der Meldung |
httpcode |
HTTP-Status, unter dem der Code ausgeliefert wird |
feld |
betroffenes Feld, sofern die Meldung sich auf eines bezieht |
Info → EU-Mitgliedstaaten
Abschnitt betitelt „Info → EU-Mitgliedstaaten“Keine Eingabe. Ein Item je Mitgliedstaat:
| Feld | Bedeutung |
|---|---|
alpha2 |
Länderkennzeichen, z. B. AT |
name |
Name des Mitgliedstaats |
verfuegbar |
true, wenn das System des Staats gerade erreichbar ist |