JSON import interface
With the import interface for JSON files, the module “VAT Validation” provides you with a way to Check your entire database from your master data.
We ensure that compatibility is maintained when extending the JSON VAT inspection interface. This allows you to use the latest version without additional effort when integrating into your ERP system.
In order to be able to assign a JSON record from your ERP system uniquely in the VAT Validation, you have the option to up to two unique keys in the import file. These are returned in the export file and can be used for reimport into your ERP system. However, you can leave these two fields (key1 and key2) blank.
The qualified validation of your VAT data within the JSON file is only available using the interface of BZSt, which is currently only available for german customs.
Please note that all bold fields must be specified in the import file. Depending on the fields specified, automatically performs a qualified query.
Structure — 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 — Export File
The JSON export file of the VAT Validation contains the returned values of each query, also, unless otherwise specified, in the same Data format. Please note that the JSON interface outputs all available fields and thus represents the most complete format.
| Key | Format | Example |
|---|---|---|
| ownvat | String | EN123456789 |
| errorcode | String | 200 |
| foreignvat | String | AT12345678 |
| result_zip | String | |
| town | String | |
| date | String | |
| zip | string | |
| result_town | String | |
| time | String | |
| result_name | String | |
| valid_from | String | |
| valid_to | String | |
| street | String | |
| company | String | |
| result_street | String | |
| errorcode_description | String | The requested VAT number is valid. |
| errorcode_hint | String | |
| key1 | String | 4711 |
| key2 | String | 2 |
Unlike XLSX or CSV, we agreed on the purely English notation of the keys of VAT Validation within JSON. This allows us to get from avoid run-time errors in case of incorrect conversion.
