erpware logo

VAT Validation: JSON import interface

With the import interface for JSON files, the module VAT Validation offers you a possibility to check your entire data stock from your master data.

We take care to maintain compatibility when extending the JSON USt-IdNr check interface. This means that you can always use the latest version without generating additional effort when integrating it into your ERP system.

In order to be able to uniquely assign a JSON data record from your ERP system in the VAT Validation, you have the option of specifying up to two unique keys in the import file. These will be returned in the export file and can be used for re-import into your ERP system. However, you can also leave these two fields (key1 and key2) empty.

Please note that all bold fields must be specified in the import file. Depending on the fields specified, a qualified check will be performed automatically. The qualified check is currently only available for the BZSt interface.

Structure — VAT JSON Import File

Key Format Example
key1 String 4711
key2 String 2
ownvat String EN123456789
foreignvat String AT12345678
company String
town String
zip String
street String

Structure — VAT JSON Export File

The JSON export file of the VAT Validation contains the returned values of the individual checks, also in the same data format unless otherwise specified. Please note that the JSON interface outputs all available fields and thus represents the most complete format.

Field Format Example
key1 String 4711
key2 String 2
ownvat String DE123456789
foreignvat String AT12345678
errorcode String 200
errorcode_description String The requested VAT number is valid.
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

In contrast to XLSX or CSV, we have agreed on the pure English notation of the VAT Validation keys within JSON. This allows us to avoid runtime errors in case of an incorrect conversion from the beginning.

Please note that the fields in the export file of the VAT Validation are not always output in the same order as specified in the table above.