GET
/
v1-preview
/
models
/
delivery-note
/
{documentId}
from abbyy_document_ai import DocumentAi
import os


with DocumentAi(
    api_key_auth=os.getenv("DOCUMENTAI_API_KEY_AUTH", ""),
) as document_ai:

    res = document_ai.models.delivery_note.get_extracted_fields(document_id="wh23anb5xjf0ntw5taase5qz")

    assert res.delivery_note is not None

    # Handle response
    print(res.delivery_note)
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "delivery-note",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "buyer": {
      "buyerId": "BU-001",
      "name": "Acme Corp",
      "address": "123 Business Street",
      "taxId": "ATU12345678",
      "iban": "DE89370400440532013000"
    },
    "vendor": {
      "vendorId": "V-001",
      "name": "Tech Supplies GmbH",
      "address": "456 Vendor Avenue",
      "taxId": "DE987654321",
      "nationalTaxId": "DE987654321",
      "iban": "DE89370400440532013000",
      "bankCode": "1234567890",
      "bankAccount": "1234567890"
    },
    "shipTo": {
      "name": "John Doe",
      "address": "123 Main St"
    },
    "billTo": {
      "name": "Jane Doe",
      "address": "456 Main St"
    },
    "deliveryNoteNumber": "DN-2024-001",
    "deliveryNoteDate": "2024-03-20",
    "deliveryDate": "2024-03-15",
    "dueDate": "2024-03-25",
    "shippingDate": "2024-03-10",
    "purchaserName": "John Smith",
    "purchaseOrderNumber": "PO-2024-001",
    "purchaseOrderDate": "2024-03-01",
    "invoiceNumber": "INV-2024-001",
    "deliveryTerms": "FOB",
    "amounts": {
      "total": 1234.56,
      "currency": "EUR"
    },
    "taxes": [
      {
        "tax": 12.2
      }
    ],
    "totalNetWeight": 10.5,
    "totalGrossWeight": 12,
    "weightUnitOfMeasurement": "kg",
    "additionalCosts": {
      "additionalCost": 50
    },
    "lineItems": [
      {
        "itemNumber": "ITEM-001",
        "orderNumber": "ORD-001",
        "articleNumber": "ART-001",
        "description": "High-end laptop computer",
        "quantityOrdered": 1,
        "unitPrice": 1000,
        "totalPrice": 1234.56,
        "currency": "EUR",
        "deliveryDate": "2024-03-10",
        "quantityDelivered": 1,
        "unitOfMeasurement": "pcs",
        "netWeight": 2.5,
        "grossWeight": 3,
        "weightUnitOfMeasurement": "kg",
        "serialNumber": "SN123456",
        "batchNumber": "BATCH-001",
        "eanNumber": "4003301018398"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com

Path Parameters

​
documentId
string
required

The id of the document

Response

200
application/json

Extracted Delivery Note Data Response

​
meta
object
required

Represents a document that has been submitted for processing.

Example:
{
  "id": "wh23anb5xjf0ntw5taase5qz",
  "name": "document.jpg",
  "createdAt": "2025-02-07T17:44:06.949Z",
  "model": "image-to-text",
  "status": "Processed",
  "pageCount": 10,
  "errors": [{ "message": "Total is required" }]
}
​
fields
object

Fields extracted from a delivery note

Example:
{
  "buyer": {
    "buyerId": "BU-001",
    "name": "Acme Corp",
    "address": "123 Business Street",
    "taxId": "ATU12345678",
    "iban": "DE89370400440532013000"
  },
  "vendor": {
    "vendorId": "V-001",
    "name": "Tech Supplies GmbH",
    "address": "456 Vendor Avenue",
    "taxId": "DE987654321",
    "nationalTaxId": "DE987654321",
    "iban": "DE89370400440532013000",
    "bankCode": "1234567890",
    "bankAccount": "1234567890"
  },
  "shipTo": {
    "name": "John Doe",
    "address": "123 Main St"
  },
  "billTo": {
    "name": "Jane Doe",
    "address": "456 Main St"
  },
  "deliveryNoteNumber": "DN-2024-001",
  "deliveryNoteDate": "2024-03-20",
  "deliveryDate": "2024-03-15",
  "dueDate": "2024-03-25",
  "shippingDate": "2024-03-10",
  "purchaserName": "John Smith",
  "purchaseOrderNumber": "PO-2024-001",
  "purchaseOrderDate": "2024-03-01",
  "invoiceNumber": "INV-2024-001",
  "deliveryTerms": "FOB",
  "amounts": { "total": 1234.56, "currency": "EUR" },
  "taxes": [{ "tax": 12.2 }],
  "totalNetWeight": 10.5,
  "totalGrossWeight": 12,
  "weightUnitOfMeasurement": "kg",
  "additionalCosts": { "additionalCost": 50 },
  "lineItems": [
    {
      "itemNumber": "ITEM-001",
      "orderNumber": "ORD-001",
      "articleNumber": "ART-001",
      "description": "High-end laptop computer",
      "quantityOrdered": 1,
      "unitPrice": 1000,
      "totalPrice": 1234.56,
      "currency": "EUR",
      "deliveryDate": "2024-03-10",
      "quantityDelivered": 1,
      "unitOfMeasurement": "pcs",
      "netWeight": 2.5,
      "grossWeight": 3,
      "weightUnitOfMeasurement": "kg",
      "serialNumber": "SN123456",
      "batchNumber": "BATCH-001",
      "eanNumber": "4003301018398"
    }
  ]
}
​
validationErrors
object[]

An array of validation errors that occurred while processing the document. These typically do not prevent field extraction, but rather indicate issues extracting key fields.

Was this page helpful?