IntegrationVatValidationRequestDTO

Request-Payload zum Starten eines USt-Validierungslaufs.

records object[]erforderlich

Zu validierende Datensätze. Muss mindestens einen Datensatz enthalten.

Mögliche Werte >= 1

Array [

vatIdstringnullable

USt-Identifikationsnummer.

companyNamestringnullable

Unternehmensname, der für den USt-Abgleich verwendet wird.

citystringnullable

Ort, der für den USt-Abgleich verwendet wird.

zipstringnullable

Postleitzahl, die für den USt-Abgleich verwendet wird.

streetstringnullable

Straße, die für den USt-Abgleich verwendet wird.

]

options objecterforderlich

Ausführungsoptionen, die das Verifizierungsverhalten und Ausgabeartefakte steuern.

checkTypeValidationCheckTypeerforderlich

Legt fest, ob die Validierung Standard- oder qualifizierte Verifizierung verwendet.

Mögliche Werte [Qualified, Standard]

sendNotificationEmailbooleanerforderlich

Wenn true, kann der Validierungsworkflow seine konfigurierte Benachrichtigungs-E-Mail senden.

createSnapshotbooleanerforderlich

Wenn true, speichert die Validierung einen Snapshot des abgeschlossenen Ergebnisses.

pdf objecterforderlich

Steuert PDF-Erzeugung und PDF-Auslieferungsoptionen für den Validierungslauf.

createbooleanerforderlich

Wenn true, erzeugt die Validierung einen PDF-Bericht.

signbooleanerforderlich

Wenn true, wird das generierte PDF vor der Auslieferung signiert.

sendByEmailbooleanerforderlich

Wenn true, wird das PDF über den Validierungsworkflow per E-Mail versendet.

returnAsBase64booleanerforderlich

Wenn true, wird das PDF zusätzlich als Base64-Zeichenkette in die API-Antwort eingebettet.

returnAsUrlbooleanerforderlich

Wenn true, wird die PDF-Download-URL in die API-Antwort aufgenommen.

retryDurationRetryDurationerforderlich

Retry-Zeitfenster für transiente Validierungsprobleme.

Mögliche Werte [None, OneHour, TwoHours, FourHours, EightHours, TwentyFourHours]

ownVatIdstringnullable

Optionale USt-IdNr., die als eigene USt-Identifikationsnummer des Aufrufers während der Validierung verwendet wird. Wenn sie weggelassen wird, wird die Standard-USt-IdNr. des Benutzers verwendet.

transliteratebooleannullable

Optionale Überschreibung für Transliteration während der Validierung. Wenn sie weggelassen wird, wird die konfigurierte Standardeinstellung des Benutzers verwendet.

includestring[]nullable

Zusätzliche USt-Auflösungsfelder, die in jeden abgeschlossenen Validierungsdatensatz aufgenommen werden sollen. Unterstützte Werte sind: addressStreetName, addressHouseNumber.

IntegrationVatValidationRequestDTO

{
  "records": [
    {
      "vatId": "string",
      "companyName": "string",
      "city": "string",
      "zip": "string",
      "street": "string"
    }
  ],
  "options": {
    "checkType": "Qualified",
    "sendNotificationEmail": true,
    "createSnapshot": true,
    "pdf": {
      "create": true,
      "sign": true,
      "sendByEmail": true,
      "returnAsBase64": true,
      "returnAsUrl": true
    },
    "retryDuration": "None",
    "ownVatId": "string",
    "transliterate": true,
    "include": [
      "string"
    ]
  }
}