JSON-Schnittstelle der VAT-Validation
Verwendung der JSON-Schnittstelle der VAT-Validation
Inhaltsverzeichnis
Mit der Schnittstelle für den Import für JSON Dateien, bietet Ihnen die VAT-Validation eine Möglichkeit, Ihren gesamten Datenbestand aus Ihren Stammdaten heraus zu überprüfen.
Wir achten darauf, dass bei der Erweiterung der JSON-Schnittstelle der USt-IdNr-Prüfung die Kompatibilität stets gewahrt bleibt. Damit können Sie jeweils die aktuellste Version einsetzen, ohne zusätzlichen Aufwand bei einer Integration in Ihr ERP System zu generieren.
Informationen zur JSON-Schnittstelle
Um einen JSON Datensatz aus Ihrem ERP System eindeutig in der VAT-Validation zuordnen zu können, haben Sie die Möglichkeit, bis zu zwei eindeutige Schlüssel in der Importdatei anzugeben. Diese werden in der Exportdatei wieder zurückgegeben und können für den Reimport in Ihr ERP System genutzt werden. Sie können diese beiden Felder (key1 und key2) jedoch auch leer lassen.
Bitte beachten Sie, dass alle fettgedruckten Felder in der Importdatei angegeben werden müssen. Je nach Angabe der Felder wird automatisch eine qualifizierte Prüfung durchgeführt. Die qualifizierte Prüfung ist momentan nur für die Schnittstelle des BZSt verfügbar.
Aufbau – JSON Importdatei
Key | Format | Beispiel |
---|---|---|
key1 | String | 4711 |
key2 | String | 2 |
ownvat | String | DE123456789 |
foreignvat | String | AT12345678 |
company | String | |
town | String | |
zip | String | |
street | String |
Aufbau – JSON Exportdatei
Die JSON-Exportdatei der VAT-Validation beinhaltet die zurückgegebenen Werte der einzelnen Prüfungen, ebenfalls, sofern nicht anders angegeben, im gleichen Datenformat. Bitte beachten Sie, dass die JSON Schnittstelle alle verfügbaren Felder ausgibt und somit das vollständigste Format darstellt.
Key | Format | Beispiel |
---|---|---|
key1 | String | 4711 |
key2 | String | 2 |
ownvat | String | DE123456789 |
foreignvat | String | AT12345678 |
errorcode | String | 200 |
errorcode_description | String | Die angefragte USt-IdNr. ist gültig. |
valid_from | String | |
valid_to | String | |
errorcode_hint | String | |
timestamp | String | 2021-01-05 16:12:37 |
company | String | |
town | String | |
zip | String | |
street | String |
Im Gegensatz zu XLSX oder CSV haben wir uns auf die rein englische Notation der Schlüssel der VAT-Validation für dieses Format geeinigt. Damit können wir von vorneherein Laufzeitfehler bei einer fehlerhaften Konvertierung vermeiden.
Bitte beachten Sie, dass die Felder in der Exportdatei der VAT-Validation nicht immer in der gleichen Reihenfolge ausgegeben werden, wie in der obigen Tabelle angegeben.
Beispieldatei JSON
Wir haben in unsere VAT-Validation die Möglichkeit eingefügt, eine Beispieldatei direkt aus dem Menü heraus zu erzeugen. Daher haben wir den Download auf dieser Seite entfernt, um stets aktuell zu bleiben. Diese Funktion erzeugt Ihnen eine JSON-Datei, die Sie als Vorlage verwenden können. Bitte beachten Sie, dass wir hierbei nur eine der möglichen Notationen unterstützen können.