Kommandozeile der VAT-Validation
Einbinden der VAT-Validation über Kommandzeile (cli)
Inhaltsverzeichnis
Die Hintergrundverarbeitung der USt-IdNr-Prüfung kann nicht über die Oberfläche gestartet werden. Um die Hintergrundverarbeitung zu starten, öffnen Sie eine Kommandozeile in dem Verzeichnis, in dem die Datei ew_service_vat.exe liegt und rufen diese mit dem Parameter –mode=auto auf.
Allgemeines zur Kommandozeile
Die Hintergrundverarbeitung verarbeitet alle Dateien, die sich im Importverzeichnis befinden. Im Backup-Verzeichnis wird stets eine Kopie der Importdatei abgespeichert und das fertige Prüfergebnis im Exportverzeichnis abgestellt. Im Protokollverzeichnis werden einzelne Verarbeitungsschritte festgehalten. Hierbei können Sie auch unterschiedliche Dateiformate bereitstellen, wie CSV, JSON und XLSX.
Bitte beachten Sie, dass der Import den exklusiven Zugriff auf die Datei benötigt und natürlich Berechtigungen auf die Verzeichnisse braucht, in die am Ende das Ergebnis geschrieben wird.
Führen Sie während der Ausführungszeit der Hintergrundverarbeitung bitte keine manuellen Änderungen an den Dateien durch.
Um die europäische Schnittstelle zu verwenden, fügen Sie die Option –vies hinzu. Der Aufruf für VAT-Validation über eine Kommandozeile mit der Option –mode=auto kann über eine wiederholende Aufgabe oder cronjob eingeplant werden.
Häufigste Anwendungsfälle
Die Hintergrundverarbeitung wurde hauptsächlich dafür konzipiert, um ein komplettes Verzeichnis auf einmal zu verarbeiten. Ein automatisches Starten der Hintergrundverarbeitung haben wir nicht vorgesehen. Viel mehr kann über die Kommandozeile diese über einen geplanten Task angestoßen werden, nachdem der Export aus Ihrem ERP/CRM System abgeschlossen wurde.
CLI-Befehle Assistent
Seit der Version 2022.12.06 haben wir einen kleinen Assistenten hinzugefügt. Dieser hilft Ihnen, die gängisten Parameter für die Hintergrundverarbeitung festzulegen. Der generierte Befehl kann in der Kommandozeile ausgeführt werden.
Parameter
Führen Sie ew_service_vat –help aus und Sie erhalten die Übersicht aller Parameter der VAT-Validation, die Sie an die cli bzw. den Service übergeben können.
Usage of: ew_service_vat [options]
The available commands for execution are listed below.
Main options:
--lang=ARG Language (de,en). Overwrites settings.
--mode=ARG Set the validation mode (single, batch, auto).
--inputfile=FILE Input ImportData file for batch validation.
--outputfile=FILE Output file for batch validation.
--testmail Send a testmail.
--validatefile=FILE Check given file, if structure is readable.
--returncodesbzst Writes the returncodes for BZSt to user dir.
--returncodesvies Writes the returncodes for VIES to user dir.
--vies Use VIES instead of BZSt.
--samplefile=FILE Creates a sample file, based on format (CSV, JSON, XLSX).
Background Processing (use for overwriting settings of directories):
--importdir=DIR Import directory for background processing.
--exportdir=DIR Export directory for background processing.
--backupdir=DIR Backup directory for background processing.
--logdir=DIR Log directory for background processing.
Information:
-h, --help Show help and exit.
-v, --version Return the version information.
Please "double quote" directories and filenames, if spaces in path or filename.
-h –help
Zeigen Sie sich alle notwendigen Parameter an, die die cli der VAT-Validation unterstützt.
-v –version
Gibt die aktuelle installierte Version der VAT-Validation aus.
–lang
Mit diesem Parameter können Sie die Sprache der VAT-Validation angeben bzw. überschreiben.
–mode
Der Modus, in dem die VAT-Validation ausgeführt werden soll.
-i –inputfile
Übergeben Sie mit diesem Parameter die Datei mit zu importierenden Daten für die VAT-Validation an.
-o –outputfile
Die Exportdatei für die VAT-Validation wird mit diesem Parameter angegeben. Wichtig ist, dass dieser nicht identisch mit der Importdatei ist.
–testmail
Testen Sie aus der VAT-Validation heraus einen Versand einer Test-E-Mail durch. Nach der Verarbeitung einer Datei kann Ihnen am Ende eine E-Mail zugesandt werden.
–vies
Dieser Parameter gibt an, dass die VIES Schnittstelle verwendet werden soll und überschreibt ggf. abweichende Einstellungen.
–validatefile
Überprüfen Sie die Importdatei der VAT-Validation zuvor auf Ihre formale Richtigkeit.
–returncodesbzst
Dieser Parameter erzeugt eine Konfigurationsdatei für die VAT-Validation, um die Rückgabewerte der BZSt-Schnittstelle zu bearbeiten.
–returncodesvies
Dieser Parameter erzeugt eine Konfigurationsdatei für die VAT-Validation, um die Rückgabewerte der VIES-Schnittstelle zu bearbeiten.
–samplefile=FILE
Abhängig der Dateiendung, kann hierüber eine Beispieldatei erzeugt werden.
–importdir=DIR
Überschreibt die Einstellungen der Hintergrundverarbeitung für das Importverzeichnis.
–exportdir=DIR
Überschreibt die Einstellungen der Hintergrundverarbeitung für das Exportverzeichnis.
–backupdir=DIR
Überschreibt die Einstellungen der Hintergrundverarbeitung für das Sicherungsverzeichnis.
–logdir=DIR
Überschreibt die Einstellungen der Hintergrundverarbeitung für das Protokollverzeichnis.
Ausgaben auf der Kommandozeile
Alle Ausgaben sind im JSON Format und variieren nach Ihren Rückgabewerten. Diese Ausgaben können in der Kommandozeile an weitere Programme übergeben werden.