Skip to content

Receipt extraction#

The Receipt extraction workflow performs ocr and extractions steps specifically suited for receipts.

It is used with the workflow identifier receipt_extraction, at the processing endpoint i.e. POST /processing/receipt_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.


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 = receipt

All supported fields
  • schema_version: integer (possible values: [1])
  • document_type: string (possible values: ['receipt'])
  • article_amount: FloatExtraction
  • receipt_date: DateExtraction
  • gross_amount: FloatExtraction
  • net_amount: FloatExtraction
  • tax_amount: FloatExtraction
  • discount_amount: FloatExtraction
  • tax_calculation: array of TaxCalculation
    • tax_code: StringExtraction
    • tax_rate: FloatExtraction
    • tax_amount: FloatExtraction
    • net_amount: FloatExtraction
    • gross_amount: FloatExtraction
  • card_number: StringExtraction
  • payment_method: PaymentMethodExtraction
  • receipt_number: StringExtraction
  • line_items: array of LineItem
    • article_id: StringExtraction
    • description: StringExtraction
    • quantity: FloatExtraction
    • total_price: FloatExtraction
    • article_name: StringExtraction
    • tax_rate: FloatExtraction
    • tax_code: StringExtraction
    • discount: FloatExtraction
  • vendor: Vendor
    • name: StringExtraction
    • address: Address
      • address_line_1: StringExtraction
      • address_line_2: StringExtraction
      • city: StringExtraction
      • zip: StringExtraction
      • country: CountryExtraction
    • vat_id: StringExtraction
    • tax_number: StringExtraction
    • store: StringExtraction


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.


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