Delivery Note

Usage

Copy the code block, replace YOUR_API_KEY with your API key, then process documents quickly.

from abbyy_document_ai import DocumentAi

with DocumentAi(api_key_auth=YOUR_API_KEY) as document_ai:
  res = document_ai.models.delivery_note.begin_field_extraction(input_source={
    "url": "https://example.com/document.pdf",
  })

  assert res.documents is not None
  doc_id = res.documents[0].id

  processed = False
  while not processed:
      time.sleep(3)  # Wait 3 seconds between checks
      res = document_ai.models.delivery_note.get_extracted_fields(
          document_id=doc_id
      )
      processed = res.delivery_note.meta.status == "Processed"

  print(res.delivery_note.fields)

Extracted Fields

Field Name	Description
Document Information	Information about the delivery note.
Number	The delivery note number.
Date	The date of the delivery note.
Buyer	Information about the buyer.
Buyer ID	The unique identifier of the buyer in an external system.
Name	The name of the buyer.
Address	The address of the buyer.
Tax ID	The international tax ID of the buyer.
IBAN	The international bank account number of the buyer.
Vendor	Information about the vendor.
Vendor ID	The unique identifier of the vendor in an external system.
Name	The name of the vendor.
Address	The address of the vendor.
Tax ID	The international tax ID of the vendor.
National Tax ID	The national tax ID of the vendor.
IBAN	The international bank account number of the vendor.
Bank Code	The bank code of the vendor.
Bank Account	The bank account number of the vendor.
Ship to	Information about the delivery address.
Name	The name at the delivery address.
Address	The delivery address.
Bill to	Information about the billing address.
Name	The name at the billing address.
Address	The address where the invoice should be sent.
Delivery Date	The date on which the goods are expected to be delivered.
Due Date	The date on which the goods are expected to arrive at the delivery address.
Shipping Date	The date on which the goods are shipped.
Purchaser Name	The name of the buyer.
Purchase Order Number	The purchase order number (if one is specified in the document).
Purchase Order Date	The date when the purchase order was created.
Invoice Number	The invoice number (if one is specified in the document).
Delivery Terms	The delivery terms.
Amounts	Information about the monetary amounts.
Total	The total amount specified in the delivery note.
Currency	The currency of the total amount.
Taxes (repeating group)	Information about taxes.
Tax	The total tax amount.
Additional Costs	Information about additional charges.
Additional Cost	The total additional charges.
Total Net Weight	The total net weight of the goods.
Total Gross Weight	The total gross weight of the goods.
Weight Unit of Measurement	The unit of measurement for the weight of the goods (kilograms, pounds, etc.).
Line Items (repeating group)	Information about individual line items.
Item Number	The item number.
Order Number	The order number.
Article Number	The article number.
Description	A description of the line item.
Quantity Ordered	The number of units ordered.
Unit Price	The price of one item of goods.
Total Price	The price of the line item including tax.
Currency	The currency of the line item.
Delivery Date	The planned delivery date for the line item.
Quantity Delivered	The number of units delivered.
Unit of Measurement	The unit of measurement used for the goods.
Net Weight	The net weight of the line item.
Gross Weight	The gross weight of the line item.
Weight Unit of Measurement	The unit of measurement for the weight of the line item (kilograms, pounds, etc.).
Serial Number	A unique identifier assigned to each item of goods. All serial numbers can be extracted together as a single field.
Batch Number	A unique identifier assigned to a specific group or batch of items that are being transported or delivered together.
EAN Number	A unique identifier from the European Article Numbering (EAN) system. The EAN number typically refers to the barcode associated with the specific product being shipped or delivered.

Validation Rules

Rule	Description
Total gross weight: Fill from Line Items	If the Total Gross Weight field is empty, the rule will populate that field with the value specified for Total Gross Weight in Line Items.
Total net weight: Fill from Line Items	If the Total Net Weight field is empty, the rule will populate that field with the value specified for Total Net Weight in Line Items.
Separate currency from amount in money fields	Splits the amount and the currency in a field containing an amount of money, and copies the currency into the Currency field if it is empty.
Sum of Line Items amount should be equal to Total	Adds up the amounts in the line items, applies the additional charges, and checks that the result is equal to the Total amount of the delivery note.
Separate currency from amount in Line Items money field	Splits the amount and the currency in Line Items fields, and copies the currency into the Currency field if it is empty.
Check item amount	Multiplies the number of units in the line item by the price of one unit, applies the discount, and checks that the result is equal to the total price of the line item.
Copy Delivery Notes and Line Items currency	If the Currency field is empty, the rule will populate that field with the currency indicated in the Currency field in Line Items. Likewise, the rule will populate the Currency field in Line Items with the currency from the main Currency field. The rule can also populate the Currency field using the country of the buyer (if it has been detected). Only values matching one of the following currency codes will be copied: USD, EUR, CHF, CZK, GBP, PLN, RUB, HUF, CAD, AUD, NZD, JPY, CNY, DKK, NOK, SEK, BGN, HRK, MDL, RON, or RSD. If the currency is marked using the $, €, US$ , CA $, AU$ , NZ$, or £ symbols, the value will still be copied, but it will be normalized to the standard value (i.e. USD, EUR, etc.).
Check currency value	Checks that the value of the Currency field corresponds to the currency format. If the field is empty or if the value does not correspond to the currency format, adds a list of suggested values.
Check line item currency value	Checks that the value of the Currency field in Line Items corresponds to the currency format. If the field is empty or if the value does not correspond to the currency format, adds a list of suggested values.
Delivery Note Number is required	Checks that the Delivery Note Number field is not empty.
Delivery Note Date is required	Checks that the Delivery Note Date field is not empty.
Total is required	Checks that the Total field is not empty.
Currency is required	Checks that the Currency field is not empty.
Vendor VATID is required	Checks that the Vendor VATID field is not empty.

Supported Languages

Countries	Languages
Global	English, German, French

Get Started

Models

Usage

Extracted Fields

Validation Rules

Supported Languages

Get Started

Models

​Usage

​Extracted Fields

​Validation Rules

​Supported Languages

Usage

Extracted Fields

Validation Rules

Supported Languages