{"openapi":"3.0.1","info":{"title":"eVATR API","description":"Es gibt die Möglichkeit der einfachen und qualifizierten Bestätigungsabfrage.","version":"v:1.2.3.19.886 - commit:0ae35ee"},"servers":[{"url":"https://api.evatr.vies.bzst.de/app","description":"Generated server url"}],"tags":[{"name":"Unterstützende Operationen","description":"Ressourcen der Unterstützende Operationen"},{"name":"USt-IdNr. Bestaetigungsabfrage","description":"Ressourcen der Bestaetigungsabfrage"}],"paths":{"/v1/abfrage":{"post":{"tags":["USt-IdNr. Bestaetigungsabfrage"],"summary":"Abfrage der Gültigkeit einer USt-IdNr. aus einem Mitgliedstaat der EU. ","description":"Es gibt die Möglichkeit der einfachen und qualifizierten Bestätigungsabfrage
\n\n - Die einfache Bestätigungsabfrage gibt nur Gewissheit über die Gültigkeit einer USt-IdNr. Sie wird ausgeführt, wenn die Felder anfragendeUstid und angefragteUstid des Request Body besetzt, aber firmenname oder ort unbesetzt sind. In der Bestätigungsantwort wird der anfrageZeitpunkt und die Gültigkeitsinformation im status zurückgeliefert. Im Fall von Ungültigkeit werden Detailinformationen ggfs. auch über die Felder gueltigAb und gueltigBis geliefert.
\n \n - Die qualifizierte Bestätigungsbfrage verifiziert die Korrektheit der Firmendaten. Sie wird ausgeführt, wenn zu den Feldern anfragendeUstid und angefragteUstid im Request Body auch mindestens firmenname und ort besetzt sind. Die zusätzlichen Felder strasse und plz sind optional. In der Bestätigungsantwort werden die selben Rückgabewerte wie bei der einfachen Bestätigungsabfrage geliefert und im Fall der Gültigkeit zusätzlich die Vergleichsergebnisse erg... zu den besetzten Feldern der Firmendaten aus dem Request Body. Die Vergleichsergebnisse werden durch Buchstaben wie folgt ausgedrückt:\n
\n - A = Die Angaben zu angefragteUstid stimmen mit den registrierten Daten überein.
\n - B = Die Angaben zu angefragteUstid stimmen mit den registrierten Daten nicht überein.
\n - C = Die Angaben zu angefragteUstid wurden nicht angefragt.
\n - D = Die Angaben zu angefragteUstid wurden vom EU-Mitgliedsstaat nicht mitgeteilt.
\n
\n \n
\n\n - 💡 Mit folgenden Werten können Testaufrufe mit Beispiel USt-IdNr erfolgen:\n
\n einfache Bestätigungsanfrage:
{
\"anfragendeUstid\":\"DE123456789\",
\"angefragteUstid\":\"ATU12345678\"
}\n
\n \n qualifizierte Bestätigungsanfrage:
{
\"anfragendeUstid\":\"DE123456789\",
\"angefragteUstid\":\"ATU12345678\",\"
\"firmenname\":\"Musterhaus GmbH & Co KG\",
\"strasse\":\"Musterstrasse 22\",
\"plz\":\"12345\",
\"ort\":\"musterort\"
}\n
\n \n
","operationId":"abfrageV1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bestaetigungsabfrage"}}},"required":true},"responses":{"200":{"description":"status =\n\n - evatr-0000: Die angefragte Ust-IdNr. ist zum Anfragezeitpunkt gültig.
\n - evatr-2002: Die angefragte USt-IdNr. ist zum Anfragezeitpunkt nicht gültig. Sie ist erst gültig ab dem Datum im Feld gueltigAb.
\n - evatr-2006: Die angefragte Ust-IdNr. ist zum Anfragezeitpunkt nicht gültig. Sie war gültig im Zeitraum, der durch die Werte in den Feldern gueltigAb und gueltigBis beschrieben ist.
\n - evatr-2008: Die angefragte Ust-IdNr. ist zum Anfragezeitpunkt gültig. Für die qualifizierte Bestätigungsanfrage liegt einer Besonderheit vor. Für Rückfragen wenden Sie sich an das BZSt.
\n
","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bestaetigungsantwort"}}}},"400":{"description":"status =\n\n - evatr-0002: Mindestens eins der Pflichtfelder ist nicht besetzt.
\n - evatr-0004: Die anfragende DE Ust-IdNr. ist syntaktisch falsch. Sie passt nicht in das deutsche Erzeugungsschema.
\n - evatr-0005: Die angegebene angefragte Ust-IdNr. ist syntaktisch falsch.
\n - evatr-0008: Die maximale Anzahl von qualifizierten Bestätigungsabfragen für diese Session wurde erreicht. Bitte starten Sie erneut mit einer einfachen Bestätigungsabfrage.
\n - evatr-0012: Die angefrage USt-IdNr. ist syntaktisch falsch. Sie passt nicht in das Erzeugungsschema.
\n - evatr-2003: Das angegebene Länderkennzeichen der angefragten USt-IdNr. ist nicht gültig.
\n
","content":{"application/json":{}}},"403":{"description":"status =\n\n - evatr-0006: Die anfragende DE USt-IdNr. ist nicht berechtigt eine DE Ust-IdNr. anzufragen.
\n - evatr-0007: Fehlerhafter Aufruf.
\n
","content":{"application/json":{}}},"404":{"description":"status =\n\n - evatr-2001: Die angefragte USt-IdNr. ist zum Anfragezeitpunkt nicht vergeben.
\n - evatr-2005: Die angegebene eigene DE Ust-IdNr. ist zum Anfragezeitpunkt nicht gültig.
\n
","content":{"application/json":{}}},"500":{"description":"status =\n\n - evatr-2004
\n evatr-2011
\n evatr-3011: Eine Bearbeitung Ihrer Anfrage ist zurzeit nicht möglich. Bitte versuchen Sie es später noch einmal.\n \n
","content":{"application/json":{}}},"503":{"description":"status =\n\n - evatr-0011
\n evatr-1001
\n evatr-1002
\n evatr-1003
\n evatr-1004: Eine Bearbeitung Ihrer Anfrage ist zurzeit nicht möglich. Bitte versuchen Sie es später noch einmal.\n \n
","content":{"application/json":{}}}}}},"/v1/info/statusmeldungen":{"get":{"tags":["Unterstützende Operationen"],"summary":"Abfrage der Meldungstexte zu den Status Codes (evatr-*) ","description":"Zu jedem evatr-* Code aus dem Feld status wird ein Beschreibungstext in Meldung zurückgeliefert, der vom Aufrufer z.B. in einer GUI angezeigt werden kann.","operationId":"statusmeldungenV1","responses":{"200":{"description":"Die Liste der Meldungstexte zu den Status Codes wird in der Response zurück geliefert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Statusmeldung"}}}}}}},"/v1/info/eu_mitgliedstaaten":{"get":{"tags":["Unterstützende Operationen"],"summary":"Abfrage einer Liste der EU Mitgliedstaaten und ihrer Verfügbarkeit","description":"Zu jedem Mitgliedstaat wird der Name, das Länderkennzeichen und die aktuelle Verfügbarkeit des VIES-Systems im Mitgliedstaat zurückgeliefert.","operationId":"euMitgliedstaatenStatusV1","responses":{"200":{"description":"Die Liste alle Mitgliedstaaten mit Namen, Länderkennzeichen und Verfügbarkeit wird in der Response zurück geliefert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EUMitgliedstaat"}}}}}}}},"components":{"schemas":{"Bestaetigungsabfrage":{"required":["anfragendeUstid","angefragteUstid"],"type":"object","properties":{"anfragendeUstid":{"type":"string"},"angefragteUstid":{"type":"string"},"firmenname":{"type":"string"},"strasse":{"type":"string"},"plz":{"type":"string"},"ort":{"type":"string"}}},"Bestaetigungsantwort":{"required":["anfrageZeitpunkt","status"],"type":"object","properties":{"id":{"type":"string","description":"Technische ID zur Bestaetigungsanfrage"},"anfrageZeitpunkt":{"type":"string"},"gueltigAb":{"type":"string"},"gueltigBis":{"type":"string"},"status":{"type":"string"},"ergFirmenname":{"type":"string"},"ergStrasse":{"type":"string"},"ergPlz":{"type":"string"},"ergOrt":{"type":"string"}}},"Statusmeldung":{"required":["httpcode","kategorie","meldung","status"],"type":"object","properties":{"status":{"type":"string"},"kategorie":{"type":"string"},"httpcode":{"type":"integer","format":"int32"},"feld":{"type":"string"},"meldung":{"type":"string"}}},"EUMitgliedstaat":{"required":["alpha2","name","verfuegbar"],"type":"object","properties":{"alpha2":{"type":"string"},"name":{"type":"string"},"verfuegbar":{"type":"boolean"}}}}}}