Skip to content

Delivery note extraction#

The Delivery note extraction workflow performs ocr and extractions steps specifically suited for delivery notes.

It is used with the workflow identifier delivery_note_extraction, at the processing endpoint i.e. POST /processing/delivery_note_extraction.

Supported workflow-parameters#

To be submitted as a configuration object with the parameters form field.

field type default
language one of de (german) or en (english) unset, i.e. multi-language (at the potential cost of OCR accuracy)

Supported return values#

As automatically included in the response JSON, unless otherwise specified via include query parameters.

Credit cost#

A Freemium account allows for up to 100 pages per month, where the cost is 50 credits per page, and 75 credits per document.

Note

A document is usually a bundle of 10 pages.

Extractions formats#

The value of the extractions key for this workflow has the following form:

For document_type = delivery_note

All supported fields
  • schema_version: integer (possible values: [2])
  • document_type: string (possible values: ['delivery_note'])
  • receiver: Receiver
    • name: StringExtraction
    • address: Address
      • address_line_1: StringExtraction
      • address_line_2: StringExtraction
      • city: StringExtraction
      • zip: StringExtraction
      • country: CountryExtraction
    • vat_id: StringExtraction
    • tax_number: StringExtraction
    • eori_number: StringExtraction
    • customer_number: StringExtraction
  • sender: Sender
    • name: StringExtraction
    • address: Address
      • address_line_1: StringExtraction
      • address_line_2: StringExtraction
      • city: StringExtraction
      • zip: StringExtraction
      • country: CountryExtraction
    • vat_id: StringExtraction
    • tax_number: StringExtraction
    • eori_number: StringExtraction
    • phone: StringExtraction
    • fax: StringExtraction
    • url: StringExtraction
    • e_mail: StringExtraction
  • number: StringExtraction
  • order_number: StringExtraction
  • order_confirmation_number: StringExtraction
  • shipping_number: StringExtraction
  • date: DateExtraction
  • shipping_date: DateExtraction
  • delivery_date: DateExtraction
  • total_weight: FloatExtraction
  • total_quantity: FloatExtraction
  • total_goods_value: FloatExtraction
  • origin_of_goods: StringExtraction
  • goods: array of LineItem
    • pos_id: StringExtraction
    • article_id: StringExtraction
    • description: StringExtraction
    • quantity_ordered: FloatExtraction
    • quantity_delivered: FloatExtraction
    • unit: FloatExtraction
    • weight: FloatExtraction

Note

For a reference of the structure of each of the extractions objects see Extracted Values. Also, for accessing individual processing results or artifacts, have a look at Fetch Processing Results and Artifacts.

Important

The structure of extractions might contain optional paths. See this and this part of the documentation.