Zum Hauptinhalt springen

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

ArgumentBeschreibung
<path>Pfad zu einer CSV-Datei oder einem Ordner.

Optionen

OptionWertDefaultBeschreibung
--mapPfadnicht gesetztPfad zur YAML-Mapping-Datei.
--outPfad<input-name>_result.csv im Single-File ModePfad zur Ergebnis-CSV. Nur Single-File Mode.
--tokenStringOPTIMUS_TOKENBearer Token für API-Aufrufe.
--envtest oder prodprodAPI-Umgebung, sofern keine Base URL gesetzt ist.
--base-urlAbsolute URLhängt von Umgebung abVollständiger API Base URL Override.
--col-vat-idSpaltenname oder Indexnicht gesetztSpalte mit USt-IdNrn. Erforderlich, sofern nicht in YAML gemappt.
--col-nameSpaltenname oder Indexnicht gesetztUnternehmensname-Spalte.
--col-streetSpaltenname oder Indexnicht gesetztStraßenspalte.
--col-zipSpaltenname oder Indexnicht gesetztPostleitzahlspalte.
--col-citySpaltenname oder Indexnicht gesetztStadtspalte.
--in-delimiterStringautomatisch erkannt oder YAMLEingabe-CSV-Trennzeichen.
--in-encodingutf-8, windows-1252, iso-8859-1utf-8Eingabe-CSV-Encoding.
--no-headerFlagfalseMappings als 1-basierte Spaltenindizes statt Headernamen behandeln.
--skip-rowsZahl0Zeilen, die vor Header oder Datensätzen übersprungen werden.
--out-delimiterStringEingabetrennzeichen oder ;Ergebnis-CSV-Trennzeichen.
--out-encodingutf-8, windows-1252, iso-8859-1utf-8Ergebnis-CSV-Encoding.
--no-bomFlagfalseAusgabe ohne BOM schreiben.
--out-columnsKommagetrennte ListeStandard-ErgebnisspaltenErgebnis-CSV-Spalten auswählen.
--pdfFlagfalsePDF-Bericht anfordern.
--no-pdfFlagfalsePDF-Ausgabe deaktivieren, auch wenn YAML sie aktiviert.
--signFlagfalsePDF digital signieren. Erfordert PDF-Ausgabe.
--no-signFlagfalseSignierung deaktivieren, auch wenn YAML sie aktiviert.
--pdf-dirPfadAusgabe- oder EingabeverzeichnisOrdner für gespeicherte PDFs.
--pdf-timestampFlagfalseZeitstempel zu PDF-Dateinamen hinzufügen.
--transliterationFlagfalseTransliteration für den Validierungsrequest aktivieren.
--notifyFlagfalseDie API bitten, eine Benachrichtigungs-E-Mail zu senden.
--email-pdfFlagfalseDie API bitten, das PDF per E-Mail zu senden. Erfordert PDF-Ausgabe.
--company-vat-idVAT IDnicht gesetztEigene USt-IdNr. für die Validierung.
--standardFlagnicht gesetztStandardverifikation anfordern.
--qualifiedFlagnicht gesetztQualifizierte Verifikation anfordern.
--retry-durationDauerNoneRetry-Dauer: None, OneHour, TwoHours, FourHours, EightHours, TwentyFourHours.
--force-newFlagfalseNeue Validierungsoperation starten und gespeicherten Resume-State ersetzen.
--dry-runFlagfalseDatei und Mapping validieren, die ersten 5 prüfbaren API-Zeilen ausgeben, keine Support-Logs erstellen und die API nicht aufrufen.
--patternGlob*.csvDateimuster für Folder Mode.
--min-ageSekunden0Mindestalter einer Datei, bevor Folder Mode sie verarbeitet.
--on-duplicateskip, overwrite, renameskipBehandlung doppelter Dateien bei Folder-Mode-Verschiebungen.
--retryFlagfalseDateien erneut versuchen, die zuvor in das Folder-Mode-Verzeichnis error verschoben wurden.
-v, --verboseFlagfalseDetaillierte Ausgabe anzeigen.
-q, --quietFlagfalseNur Fehler ausgeben.
--log-dirPfadmodusspezifischer logs-OrdnerOrdner für Support-Logs.
--no-logFlagfalseSupport-Log für diesen Lauf deaktivieren.

Validierungsregeln

  • <path> ist erforderlich.
  • --env muss test oder prod sein.
  • --verbose und --quiet können nicht zusammen verwendet werden.
  • --sign erfordert PDF-Ausgabe und kann nicht mit --no-pdf verwendet werden.
  • --standard und --qualified können nicht zusammen verwendet werden.
  • Ein Prüftyp ist über --standard, --qualified oder defaults.checkType in der Mapping-Datei erforderlich.
  • vatId muss über --col-vat-id oder columns.vatId gemappt sein.
  • --out wird im Folder Mode nicht akzeptiert.