Check Command
optimus check validiert USt-IdNrn. aus einer CSV-Datei oder aus einem Ordner.
Syntax
optimus check <path> [options]
<path> ist erforderlich. Es kann zeigen auf:
- Eine CSV-Datei für Single-File Mode.
- Einen Ordner für Folder Mode.
Beispiele
Eine CSV-Datei mit Mapping-Datei validieren:
optimus check customers.csv --map mapping.yml --standard
Eine qualifizierte Prüfung ausführen und einen PDF-Bericht anfordern:
optimus check customers.csv --map mapping.yml --qualified --pdf
Ohne Mapping-Datei ausführen, indem die USt-IdNr.-Spalte direkt benannt wird:
optimus check customers.csv --col-vat-id VatId --standard --token "<token>"
Einen Ordner verarbeiten:
optimus check C:\inbox\ --map mapping.yml
Parsing und Mapping validieren, ohne die API aufzurufen:
optimus check customers.csv --map mapping.yml --standard --dry-run
Dry-run-Ausgabe enthält eine Vorschau der ersten 5 prüfbaren Zeilen, die an die API gesendet würden. Es werden keine Support-Logs erstellt.
Argumente
| Argument | Beschreibung |
|---|---|
<path> | Pfad zu einer CSV-Datei oder einem Ordner. |
Optionen
| Option | Wert | Default | Beschreibung |
|---|---|---|---|
--map | Pfad | nicht gesetzt | Pfad zur YAML-Mapping-Datei. |
--out | Pfad | <input-name>_result.csv im Single-File Mode | Pfad zur Ergebnis-CSV. Nur Single-File Mode. |
--token | String | OPTIMUS_TOKEN | Bearer Token für API-Aufrufe. |
--env | test oder prod | prod | API-Umgebung, sofern keine Base URL gesetzt ist. |
--base-url | Absolute URL | hängt von Umgebung ab | Vollständiger API Base URL Override. |
--col-vat-id | Spaltenname oder Index | nicht gesetzt | Spalte mit USt-IdNrn. Erforderlich, sofern nicht in YAML gemappt. |
--col-name | Spaltenname oder Index | nicht gesetzt | Unternehmensname-Spalte. |
--col-street | Spaltenname oder Index | nicht gesetzt | Straßenspalte. |
--col-zip | Spaltenname oder Index | nicht gesetzt | Postleitzahlspalte. |
--col-city | Spaltenname oder Index | nicht gesetzt | Stadtspalte. |
--in-delimiter | String | automatisch erkannt oder YAML | Eingabe-CSV-Trennzeichen. |
--in-encoding | utf-8, windows-1252, iso-8859-1 | utf-8 | Eingabe-CSV-Encoding. |
--no-header | Flag | false | Mappings als 1-basierte Spaltenindizes statt Headernamen behandeln. |
--skip-rows | Zahl | 0 | Zeilen, die vor Header oder Datensätzen übersprungen werden. |
--out-delimiter | String | Eingabetrennzeichen oder ; | Ergebnis-CSV-Trennzeichen. |
--out-encoding | utf-8, windows-1252, iso-8859-1 | utf-8 | Ergebnis-CSV-Encoding. |
--no-bom | Flag | false | Ausgabe ohne BOM schreiben. |
--out-columns | Kommagetrennte Liste | Standard-Ergebnisspalten | Ergebnis-CSV-Spalten auswählen. |
--pdf | Flag | false | PDF-Bericht anfordern. |
--no-pdf | Flag | false | PDF-Ausgabe deaktivieren, auch wenn YAML sie aktiviert. |
--sign | Flag | false | PDF digital signieren. Erfordert PDF-Ausgabe. |
--no-sign | Flag | false | Signierung deaktivieren, auch wenn YAML sie aktiviert. |
--pdf-dir | Pfad | Ausgabe- oder Eingabeverzeichnis | Ordner für gespeicherte PDFs. |
--pdf-timestamp | Flag | false | Zeitstempel zu PDF-Dateinamen hinzufügen. |
--transliteration | Flag | false | Transliteration für den Validierungsrequest aktivieren. |
--notify | Flag | false | Die API bitten, eine Benachrichtigungs-E-Mail zu senden. |
--email-pdf | Flag | false | Die API bitten, das PDF per E-Mail zu senden. Erfordert PDF-Ausgabe. |
--company-vat-id | VAT ID | nicht gesetzt | Eigene USt-IdNr. für die Validierung. |
--standard | Flag | nicht gesetzt | Standardverifikation anfordern. |
--qualified | Flag | nicht gesetzt | Qualifizierte Verifikation anfordern. |
--retry-duration | Dauer | None | Retry-Dauer: None, OneHour, TwoHours, FourHours, EightHours, TwentyFourHours. |
--force-new | Flag | false | Neue Validierungsoperation starten und gespeicherten Resume-State ersetzen. |
--dry-run | Flag | false | Datei und Mapping validieren, die ersten 5 prüfbaren API-Zeilen ausgeben, keine Support-Logs erstellen und die API nicht aufrufen. |
--pattern | Glob | *.csv | Dateimuster für Folder Mode. |
--min-age | Sekunden | 0 | Mindestalter einer Datei, bevor Folder Mode sie verarbeitet. |
--on-duplicate | skip, overwrite, rename | skip | Behandlung doppelter Dateien bei Folder-Mode-Verschiebungen. |
--retry | Flag | false | Dateien erneut versuchen, die zuvor in das Folder-Mode-Verzeichnis error verschoben wurden. |
-v, --verbose | Flag | false | Detaillierte Ausgabe anzeigen. |
-q, --quiet | Flag | false | Nur Fehler ausgeben. |
--log-dir | Pfad | modusspezifischer logs-Ordner | Ordner für Support-Logs. |
--no-log | Flag | false | Support-Log für diesen Lauf deaktivieren. |
Validierungsregeln
<path>ist erforderlich.--envmusstestoderprodsein.--verboseund--quietkönnen nicht zusammen verwendet werden.--signerfordert PDF-Ausgabe und kann nicht mit--no-pdfverwendet werden.--standardund--qualifiedkönnen nicht zusammen verwendet werden.- Ein Prüftyp ist über
--standard,--qualifiedoderdefaults.checkTypein der Mapping-Datei erforderlich. vatIdmuss über--col-vat-idodercolumns.vatIdgemappt sein.--outwird im Folder Mode nicht akzeptiert.