SuccessResultResponseOfDocumentAIResultResponseDto

result objectnullablerequired

idstring<uuid>required

The unique kaunt identifier of the document

Example: 227aebd0-36a4-4d17-b96d-c5b5d071abd4

fileNamestringnullable

The filename including file ending.

Example: Invoice001.pdf

mimeTypestringrequired

The mimetype/media type of the file

Example: application/pdf

processingStatePublicDocumentStateEnumrequired

The Processing state of the document.

Possible values: [Unspecified, Pending, Processed, Error]

Example: Pending

processingErrorMessagestringnullable

The document prosessing error message if a document could not be processed.

Example: Invalid document type

documentAIResult objectnullablerequired

The result of the Document AI processing.

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

]

documentTypeNullableOfDocumentTypeEnumnullablerequired

The type of the document.

Possible values: [Unknown, Invoice, CreditNote, Receipt, Reminder, BankStatement, null]

Example: Invoice

appliedInstructions object[]nullablerequired

The list of applied instructions to the document.

Array [

linkstringnullablerequired

idstringrequired

titlestringnullablerequired

scopeInstructionScopeDtorequired

Possible values: [Vendor, Buyer, Company, Tenant]

]

correlationIdstring<uuid>

A unique ID of the request

Example: fb0ccbbc-62bc-447f-a47e-02b490e25690

isSuccessboolean

Indication of whether the request was successfull

SuccessResultResponseOfDocumentAIResultResponseDto

{
  "result": {
    "id": "227aebd0-36a4-4d17-b96d-c5b5d071abd4",
    "fileName": "Invoice001.pdf",
    "mimeType": "application/pdf",
    "processingState": "Pending",
    "processingErrorMessage": "Invalid document type",
    "documentAIResult": {
      "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
        }
      ]
    },
    "documentType": "Invoice",
    "appliedInstructions": "[\n             {\n                \"id\": \"12414-1234-1234-1234-123456789012\",\n                \"title\": \"Always prefix order number with 'O1-'\",\n                \"scope\": \"vendor\"\n             }\n            ]"
  },
  "correlationId": "fb0ccbbc-62bc-447f-a47e-02b490e25690",
  "isSuccess": true
}