DocumentAIFeedbackStructuredRequestDto

fieldCorrections object[]

Feedback text provided by the user regarding the OCR result.

Array [

fieldstringrequired

correctValueJsonNoderequired

]

correctedDocument objectnullable

The full corrected document. This is optional and can be used to provide a complete document structure after corrections. If provided, it should match the structure of the original OCR result.

documentDatestring<date>nullablerequired

dueDatestring<date>nullablerequired

currencyCodestringnullablerequired

amountExVatnumber<double>nullablerequired

vatAmountnumber<double>nullablerequired

vatRatenumber<double>nullablerequired

amountInclVatnumber<double>nullablerequired

vendorInvoiceNumberstringnullablerequired

orderNumberstringnullablerequired

projectNumberstringnullablerequired

purchaseOrderNumberstringnullablerequired

contractNumberstringnullablerequired

customerNumberstringnullablerequired

buyer objectnullablerequired

namestringnullablerequired

taxIdentificationNumberstringnullablerequired

emailAddressstringnullablerequired

phoneNumberstringnullablerequired

address objectnullablerequired

streetstringnullablerequired

citystringnullablerequired

postalCodestringnullablerequired

statestringnullablerequired

countryCodestringnullablerequired

vendor objectnullablerequired

namestringnullablerequired

taxIdentificationNumberstringnullablerequired

emailAddressstringnullablerequired

phoneNumberstringnullablerequired

address objectnullablerequired

streetstringnullablerequired

citystringnullablerequired

postalCodestringnullablerequired

statestringnullablerequired

countryCodestringnullablerequired

deliveryAddress objectnullablerequired

streetstringnullablerequired

citystringnullablerequired

postalCodestringnullablerequired

statestringnullablerequired

countryCodestringnullablerequired

paymentInformation objectnullablerequired

paymentMethodstringnullablerequired

bankSwiftCodestringnullablerequired

bankIbanNumberstringnullablerequired

customFields object[]nullablerequired

Array [

idstringnullable

fieldNamestringnullablerequired

fieldValuerequired

]

documentLines object[]nullablerequired

Array [

lineNumberstringnullablerequired

itemDescriptionstringnullablerequired

itemCodestringnullablerequired

quantitynumber<double>nullablerequired

unitOfMeasurestringnullablerequired

unitPricenumber<double>nullablerequired

lineAmountExVatnumber<double>nullablerequired

lineVatAmountnumber<double>nullablerequired

lineVatRatenumber<double>nullablerequired

lineAmountInclVatnumber<double>nullablerequired

customFieldsundefined[]nullablerequired

]

allowanceCharges object[]nullablerequired

Array [

isChargebooleannullablerequired

reasonstringnullablerequired

amountExVatnumber<double>nullablerequired

vatRatenumber<double>nullablerequired

vatAmountnumber<double>nullablerequired

amountInclVatnumber<double>nullablerequired

]

userIdstringnullable

Optional user identifier for the feedback. This can be used to associate the feedback with a specific user or role.

Example: "12345-67890-abcdef" (a unique identifier for the user)

DocumentAIFeedbackStructuredRequestDto

{
  "fieldCorrections": "I want the invoice id to be prefixed with \"INV-\"",
  "correctedDocument": {
    "documentDate": "2024-07-29",
    "dueDate": "2024-07-29",
    "currencyCode": "string",
    "amountExVat": 0,
    "vatAmount": 0,
    "vatRate": 0,
    "amountInclVat": 0,
    "vendorInvoiceNumber": "string",
    "orderNumber": "string",
    "projectNumber": "string",
    "purchaseOrderNumber": "string",
    "contractNumber": "string",
    "customerNumber": "string",
    "buyer": {
      "name": "string",
      "taxIdentificationNumber": "string",
      "emailAddress": "string",
      "phoneNumber": "string",
      "address": {
        "street": "string",
        "city": "string",
        "postalCode": "string",
        "state": "string",
        "countryCode": "string"
      }
    },
    "vendor": {
      "name": "string",
      "taxIdentificationNumber": "string",
      "emailAddress": "string",
      "phoneNumber": "string",
      "address": {
        "street": "string",
        "city": "string",
        "postalCode": "string",
        "state": "string",
        "countryCode": "string"
      }
    },
    "deliveryAddress": {
      "street": "string",
      "city": "string",
      "postalCode": "string",
      "state": "string",
      "countryCode": "string"
    },
    "paymentInformation": {
      "paymentMethod": "string",
      "bankSwiftCode": "string",
      "bankIbanNumber": "string"
    },
    "customFields": [
      {
        "id": "string",
        "fieldName": "string",
        "fieldValue": {}
      }
    ],
    "documentLines": [
      {
        "lineNumber": "string",
        "itemDescription": "string",
        "itemCode": "string",
        "quantity": 0,
        "unitOfMeasure": "string",
        "unitPrice": 0,
        "lineAmountExVat": 0,
        "lineVatAmount": 0,
        "lineVatRate": 0,
        "lineAmountInclVat": 0,
        "customFields": [
          null
        ]
      }
    ],
    "allowanceCharges": [
      {
        "isCharge": true,
        "reason": "string",
        "amountExVat": 0,
        "vatRate": 0,
        "vatAmount": 0,
        "amountInclVat": 0
      }
    ]
  },
  "userId": "\"12345-67890-abcdef\" (a unique identifier for the user)"
}