Zum Hauptinhalt springen

IntegrationVatValidationResponseDTO

Aktueller Zustand und Ergebnis-Payload für eine USt-Validierungsoperation.

operationIduuiderforderlich

Eindeutige Kennung der Validierungsoperation.

statusIntegrationVatRunStatuserforderlich

Aktueller Lebenszykluszustand der Validierungsoperation.

Mögliche Werte [Running, Completed, Failed]

submittedAtdate-timeerforderlich

Zeitstempel, zu dem die Validierungsoperation akzeptiert wurde.

expiresAtdate-timeerforderlich

Zeitstempel, nach dem das Validierungsergebnis möglicherweise nicht mehr abrufbar ist.

completedAtdate-timenullable

Zeitstempel, zu dem die Operation einen terminalen Zustand erreicht hat.

snapshotIduuidnullable

Kennung des generierten Snapshots, sofern einer erstellt wurde.

pdfDocument objectnullable

Metadaten des generierten PDF-Berichts, wenn PDF-Ausgabe angefordert wurde.

fileNamestringerforderlich

Ursprünglicher Dateiname des generierten PDF-Berichts.

urlstringnullable

Download-URL für den generierten PDF-Bericht. Nur vorhanden, wenn returnAsUrl aktiviert wurde.

base64stringnullable

Base64-kodiertes PDF-Dokument. Nur vorhanden, wenn returnAsBase64 aktiviert wurde.

records object[]nullable

Validierungsergebnisse pro Datensatz, sofern verfügbar. Weggelassen, solange der Lauf noch läuft oder wenn der Lauf fehlgeschlagen ist, bevor Ergebnisse erzeugt wurden.

  • Array [
  • vatIdstringerforderlich

    USt-Identifikationsnummer aus dem übermittelten Datensatz.

    statusResolveStatuserforderlich

    Endgültiger Auflösungsstatus für die USt-Identifikationsnummer.

    Mögliche Werte [Valid, Invalid, Unavailable]

    flagsIntegrationVatValidationFlag[]nullable

    Zusätzliche Flags, die erklären, wie der Datensatz bewertet wurde.

    Mögliche Werte [VatSyntaxInvalid, FullyVerified, HasInvalidFields, DeQualifiedVerification, DeQualifiedVerificationNotEligible, MissingRequiredData, NonEligibleCountry]

    companyName objectnullable

    Vergleichsergebnis für den Unternehmensnamen.

    valuestringnullable

    Ursprünglicher Wert, der für das Feld übermittelt wurde.

    matchStatusMatchStatusnullable

    Vergleichsergebnis zwischen dem übermittelten Wert und dem autoritativen Wert.

    Mögliche Werte [Match, NoMatch, NotQueried, NotReturned]

    correctionValuestringnullable

    Korrigierter Wert, der vom Validator zurückgegeben wird, sofern verfügbar.

    city objectnullable

    Vergleichsergebnis für den Ort.

    valuestringnullable

    Ursprünglicher Wert, der für das Feld übermittelt wurde.

    matchStatusMatchStatusnullable

    Vergleichsergebnis zwischen dem übermittelten Wert und dem autoritativen Wert.

    Mögliche Werte [Match, NoMatch, NotQueried, NotReturned]

    correctionValuestringnullable

    Korrigierter Wert, der vom Validator zurückgegeben wird, sofern verfügbar.

    zip objectnullable

    Vergleichsergebnis für die Postleitzahl.

    valuestringnullable

    Ursprünglicher Wert, der für das Feld übermittelt wurde.

    matchStatusMatchStatusnullable

    Vergleichsergebnis zwischen dem übermittelten Wert und dem autoritativen Wert.

    Mögliche Werte [Match, NoMatch, NotQueried, NotReturned]

    correctionValuestringnullable

    Korrigierter Wert, der vom Validator zurückgegeben wird, sofern verfügbar.

    street objectnullable

    Vergleichsergebnis für die Straße.

    valuestringnullable

    Ursprünglicher Wert, der für das Feld übermittelt wurde.

    matchStatusMatchStatusnullable

    Vergleichsergebnis zwischen dem übermittelten Wert und dem autoritativen Wert.

    Mögliche Werte [Match, NoMatch, NotQueried, NotReturned]

    correctionValuestringnullable

    Korrigierter Wert, der vom Validator zurückgegeben wird, sofern verfügbar.

    customFields object[]nullable

    Benutzerdefinierte Eingabefelder, die aus der Anfrage beibehalten wurden.

  • Array [
  • columnNamestringnullable

    Name der benutzerdefinierten Spalte aus dem übermittelten Datensatz.

    valuestringnullable

    Ursprünglicher Wert, der für die benutzerdefinierte Spalte übermittelt wurde.

  • ]
  • included objectnullable

    Zusätzlich angeforderte Felder nach Include-Wert.

    property name*stringnullable
  • ]
  • errorstringnullable

    Fehlerdetails, wenn die Validierungsoperation mit dem Status Failed endet.

    IntegrationVatValidationResponseDTO
    {
    "operationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "Running",
    "submittedAt": "2024-07-29T15:51:28.071Z",
    "expiresAt": "2024-07-29T15:51:28.071Z",
    "completedAt": "2024-07-29T15:51:28.071Z",
    "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pdfDocument": {
    "fileName": "string",
    "url": "string",
    "base64": "string"
    },
    "records": [
    {
    "vatId": "string",
    "status": "Valid",
    "flags": [
    "VatSyntaxInvalid"
    ],
    "companyName": {
    "value": "string",
    "matchStatus": "Match",
    "correctionValue": "string"
    },
    "city": {
    "value": "string",
    "matchStatus": "Match",
    "correctionValue": "string"
    },
    "zip": {
    "value": "string",
    "matchStatus": "Match",
    "correctionValue": "string"
    },
    "street": {
    "value": "string",
    "matchStatus": "Match",
    "correctionValue": "string"
    },
    "customFields": [
    {
    "columnName": "string",
    "value": "string"
    }
    ],
    "included": {}
    }
    ],
    "error": "string"
    }