Skip to main content

​
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.purchase_order.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.purchase_order.get_extracted_fields(
          document_id=doc_id
      )
      processed = res.purchase_order.meta.status == "Processed"

  print(res.purchase_order.fields)

​
Extracted Fields

Field NameDescription
Order NumberThe number of the purchase order.
Order DateThe date when the purchase order was created.
BuyerInformation about the buyer.
  NameThe name of the buyer.
  AddressThe address of the buyer.
  CountryThe country of the buyer.
  Tax IDThe tax identification number of the buyer.
  Buyer IDThe buyer ID.
  Bank CodeThe bank code of the buyer.
  Bank AccountThe bank account number of the buyer.
  StreetThe street part of the buyer’s address.
  ZIP CodeThe ZIP code part of the buyer’s address.
  CityThe city part of the buyer’s address.
  StateThe state part of the buyer’s address.
SupplierInformation about the supplier.
  NameThe name of the supplier.
  AddressThe address of the supplier.
  CountryThe country of the supplier.
  Tax IDThe tax identification number of the supplier.
  Supplier IDThe supplier ID.
  StreetThe street part of the supplier’s address.
  ZIP CodeThe ZIP code part of the supplier’s address.
  CityThe city part of the supplier’s address.
  StateThe state part of the supplier’s address.
Ship toInformation about the delivery address.
  NameThe name of the delivery recipient.
  AddressThe delivery address.
Bill toInformation about the billing address.
  NameThe name of the billing recipient.
  AddressThe billing address.
Line ItemsInformation about the ordered items.
  PositionThe position number of the line item.
  DescriptionThe description of the ordered item.
  QuantityThe quantity of items ordered.
  UnitThe unit of measurement for the quantity.
  PriceThe price per unit.
  DiscountThe discount applied to the line item.
  Total PriceThe total price of the line item.
  CurrencyThe currency used for the line item.
TaxesInformation about taxes.
  Total Tax AmountThe total amount of tax.
  Total Net AmountThe total amount before tax.
CurrencyThe currency used for the purchase order.
TotalThe total amount of the purchase order.
Delivery DateThe date when the goods should be delivered.

​
Validation Rules

RuleDescription
Total: Amount checkChecks that: Line Items/Total Price equals Total, Line Items/Total Price + Taxes/Total Tax Amount equals Total, Line Items/Total Price equals Taxes/Total Net Amount. If none of the conditions are fulfilled, returns an error and suggests corrected values. If the Taxes/Total Tax Amount and Taxes/Total Net Amount fields are empty, and the Total field is not empty, fills the Taxes/Total Net Amount field with the value of the Total field. Suggests calculated values for Taxes/Total, Taxes/Total Tax Amount, or Taxes/Total Net Amount, if any of these fields is not detected.
Check item amountMultiplies the number of units ordered in the line item by the price of one unit, applies the discount, and suggests a value if the result is not equal to the total price of the line item.
Quantity is requiredChecks that the quantity of goods has been detected on the document.
Delivery date must be later than order dateChecks that the delivery date is later than the date of the purchase order.
Copy PO and Line Items currencyIf the Currency field is empty, fills it in using the value of the Line Items/Currency field. This rule also applies to the Line Items/Currency field, which is filled in using the value of the Currency field. Only the values that correspond to the ISO format are copied. If the currency is marked using the ”$” sign, the value is still copied, but is then formatted to be the standard “USD” value. If the Currency fields are empty, checks the value of the Supplier/Country field. If the country of the supplier is the US, fills the Currency field with the value “USD”.
Separate currency from amount in Line Items money fieldSplits the amount and the currency in the amount fields and copies the currency into the Currency field if it is empty.
Separate currency from amount in Total fieldSplits the amount and the currency in the amount fields and copies the currency into the Currency field if it is empty.
Check currency valueChecks that the value of the Currency field in the order corresponds to a currency format. Adds a list of suggested values if the field is empty or if its value does not correspond to any currency code.
Check Line Items currency valueChecks that the value of the Currency field in Line Items corresponds to a currency format. Adds a list of suggested values if the field is empty or if its value does not correspond to any currency code.
Set Default CountryIf the Country fields in the Supplier and Buyer groups are not filled in, fills them in using the default value (US).
Supplier DB lookupChecks information about the supplier against the corresponding data catalog. If the data catalog contains information about that supplier, but the values are either different or incomplete, fills in the appropriate fields using data from the data catalog. If the supplier was not detected correctly, the operator may select a different supplier from the data catalog manually during manual review. The Supplier ID, Name, Street and Country fields should be filled in in the Suppliers data catalog.
Buyer DB lookupChecks information about the buyer against the corresponding data catalog. If the data catalog contains information about that buyer, but the values are either different or incomplete, fills in the appropriate fields using data from the data catalog. If the buyer was not detected correctly, the operator may select a different buyer from the data catalog manually during manual review. The Buyer ID, Name, Street, Country, and Company Correlation ID (Supplier ID) fields should be filled in in the Buyers data catalog.

​
Supported Languages

CountriesLanguages
USA, France, Germany, SpainEnglish, French, German, Spanish
⌘I