DocumentAIResultResponseDto
The unique kaunt identifier of the document
227aebd0-36a4-4d17-b96d-c5b5d071abd4The filename including file ending.
Invoice001.pdfThe mimetype/media type of the file
application/pdfThe Processing state of the document.
Possible values: [Unspecified, Pending, Processed, Error]
PendingThe document prosessing error message if a document could not be processed.
Invalid document typedocumentAIResult objectnullablerequired
The result of the Document AI processing.
The document date.
The document due date.
The document currency code.
The total amount excluding VAT.
The total VAT amount.
The VAT rate.
The total amount including VAT.
The vendor invoice number.
The order number.
The project number.
The purchase order number.
The contract number.
The customer number.
buyer objectnullablerequired
The buyer company information.
Name of the party.
The tax identification number of the party.
The email address of the party.
The phone number of the party.
address objectnullablerequired
The address information of the party.
The street name and number of the address.
The city of the address.
The postal code of the address.
The state or region of the address.
The country code of the address.
vendor objectnullablerequired
The vendor company information.
Name of the party.
The tax identification number of the party.
The email address of the party.
The phone number of the party.
address objectnullablerequired
The address information of the party.
The street name and number of the address.
The city of the address.
The postal code of the address.
The state or region of the address.
The country code of the address.
deliveryAddress objectnullablerequired
The delivery address information.
The street name and number of the address.
The city of the address.
The postal code of the address.
The state or region of the address.
The country code of the address.
paymentInformation objectnullablerequired
The payment information.
The payment method.
The SWIFT code of the bank.
The IBAN number of the bank account.
customFields object[]nullablerequired
The list of header custom fields associated with the document.
The unique identifier of the custom field.
The name of the custom field.
fieldValue objectnullablerequired
The value of the custom field, which can be either a string or a number.
- string
- number
documentLines object[]nullablerequired
The list of document lines.
The document line number.
The description of the item.
The code of the item.
The quantity of the item.
The unit of measure for the item.
The unit price of the item.
The line amount excluding VAT.
The line VAT amount.
The line VAT rate.
The line amount including VAT.
customFields object[]nullablerequired
The list of line-level custom fields associated with the document line.
The unique identifier of the custom field.
The name of the custom field.
fieldValue objectnullablerequired
The value of the custom field, which can be either a string or a number.
- string
- number
allowanceCharges object[]nullablerequired
The list of allowance and charge items associated with the document.
Indicates whether the allowance/charge is a charge.
The reason for the allowance/charge.
The amount excluding VAT.
The VAT rate applicable to the allowance/charge.
The VAT amount for the allowance/charge.
The amount including VAT.
The type of the document.
Possible values: [Unknown, Invoice, CreditNote, Receipt, Reminder, BankStatement, null]
InvoiceappliedInstructions object[]nullablerequired
The list of applied instructions to the document.
Possible values: [Vendor, Buyer, Company, Tenant]
{
"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": "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
}
]
},
"documentType": "Invoice",
"appliedInstructions": "[\n {\n \"id\": \"12414-1234-1234-1234-123456789012\",\n \"title\": \"Always prefix order number with 'O1-'\",\n \"scope\": \"vendor\"\n }\n ]"
}