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

The document date.

dueDatestring<date>nullablerequired

The document due date.

currencyCodestringnullablerequired

The document currency code.

amountExVatnumber<double>nullablerequired

The total amount excluding VAT.

vatAmountnumber<double>nullablerequired

The total VAT amount.

vatRatenumber<double>nullablerequired

The VAT rate.

amountInclVatnumber<double>nullablerequired

The total amount including VAT.

vendorInvoiceNumberstringnullablerequired

The vendor invoice number.

orderNumberstringnullablerequired

The order number.

projectNumberstringnullablerequired

The project number.

purchaseOrderNumberstringnullablerequired

The purchase order number.

contractNumberstringnullablerequired

The contract number.

customerNumberstringnullablerequired

The customer number.

buyer objectnullablerequired

The buyer company information.

namestringnullablerequired

Name of the party.

taxIdentificationNumberstringnullablerequired

The tax identification number of the party.

emailAddressstringnullablerequired

The email address of the party.

phoneNumberstringnullablerequired

The phone number of the party.

address objectnullablerequired

The address information of the party.

streetstringnullablerequired

The street name and number of the address.

citystringnullablerequired

The city of the address.

postalCodestringnullablerequired

The postal code of the address.

statestringnullablerequired

The state or region of the address.

countryCodestringnullablerequired

The country code of the address.

vendor objectnullablerequired

The vendor company information.

namestringnullablerequired

Name of the party.

taxIdentificationNumberstringnullablerequired

The tax identification number of the party.

emailAddressstringnullablerequired

The email address of the party.

phoneNumberstringnullablerequired

The phone number of the party.

address objectnullablerequired

The address information of the party.

streetstringnullablerequired

The street name and number of the address.

citystringnullablerequired

The city of the address.

postalCodestringnullablerequired

The postal code of the address.

statestringnullablerequired

The state or region of the address.

countryCodestringnullablerequired

The country code of the address.

deliveryAddress objectnullablerequired

The delivery address information.

streetstringnullablerequired

The street name and number of the address.

citystringnullablerequired

The city of the address.

postalCodestringnullablerequired

The postal code of the address.

statestringnullablerequired

The state or region of the address.

countryCodestringnullablerequired

The country code of the address.

paymentInformation objectnullablerequired

The payment information.

paymentMethodstringnullablerequired

The payment method.

bankSwiftCodestringnullablerequired

The SWIFT code of the bank.

bankIbanNumberstringnullablerequired

The IBAN number of the bank account.

customFields object[]nullablerequired

The list of header custom fields associated with the document.

Array [

idstringrequired

The unique identifier of the custom field.

fieldNamestringrequired

The name of the custom field.

fieldValue objectnullablerequired

The value of the custom field, which can be either a string or a number.

oneOf

string

string

number

number

]

documentLines object[]nullablerequired

The list of document lines.

Array [

lineNumberstringnullablerequired

The document line number.

itemDescriptionstringnullablerequired

The description of the item.

itemCodestringnullablerequired

The code of the item.

quantitynumber<double>nullablerequired

The quantity of the item.

unitOfMeasurestringnullablerequired

The unit of measure for the item.

unitPricenumber<double>nullablerequired

The unit price of the item.

lineAmountExVatnumber<double>nullablerequired

The line amount excluding VAT.

lineVatAmountnumber<double>nullablerequired

The line VAT amount.

lineVatRatenumber<double>nullablerequired

The line VAT rate.

lineAmountInclVatnumber<double>nullablerequired

The line amount including VAT.

customFields object[]nullablerequired

The list of line-level custom fields associated with the document line.

Array [

idstringrequired

The unique identifier of the custom field.

fieldNamestringrequired

The name of the custom field.

fieldValue objectnullablerequired

The value of the custom field, which can be either a string or a number.

oneOf

string

string

number

number

]

]

allowanceCharges object[]nullablerequired

The list of allowance and charge items associated with the document.

Array [

isChargebooleannullablerequired

Indicates whether the allowance/charge is a charge.

reasonstringnullablerequired

The reason for the allowance/charge.

amountExVatnumber<double>nullablerequired

The amount excluding VAT.

vatRatenumber<double>nullablerequired

The VAT rate applicable to the allowance/charge.

vatAmountnumber<double>nullablerequired

The VAT amount for the allowance/charge.

amountInclVatnumber<double>nullablerequired

The amount including VAT.

]

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": "string"
      }
    ],
    "documentLines": [
      {
        "lineNumber": "string",
        "itemDescription": "string",
        "itemCode": "string",
        "quantity": 0,
        "unitOfMeasure": "string",
        "unitPrice": 0,
        "lineAmountExVat": 0,
        "lineVatAmount": 0,
        "lineVatRate": 0,
        "lineAmountInclVat": 0,
        "customFields": [
          {
            "id": "string",
            "fieldName": "string",
            "fieldValue": "string"
          }
        ]
      }
    ],
    "allowanceCharges": [
      {
        "isCharge": true,
        "reason": "string",
        "amountExVat": 0,
        "vatRate": 0,
        "vatAmount": 0,
        "amountInclVat": 0
      }
    ]
  },
  "userId": "\"12345-67890-abcdef\" (a unique identifier for the user)"
}