Page Comparison

Page Properties

hidden	true

Status

Status

colour	PurpleYellow
title	startedfor review

Approver

Pavel Shkadzko

Table of Contents

...

Name	Type	Description
`entity`	`string`	Key A key (primary identification) of an entity type (e.g. `iban`). See available extraction entities , for example, `iban`. See Extraction Entities for possible values.
`value`	`string`	A normalized textual representation of the Text/Information provided by the extraction value (e.g. , for example, iban without spaces between the digits).
`box`	bounding-box	(Optional) bounding : Bounding box containing the position of the extraction value on the document.

Code Block

language	json

//document extraction

{
  "entity": "amount",
  "value": "20.00:EUR",
  "box": { ... }
}

...

Specific extractions

A specific extraction assigns a semantic property to the extraction. It also has an additional candidates field:

Name	Type	Description
`candidates`	`string`	(Optional): A reference to extraction candidates. See available extraction candidates Extraction Entities for possible values.

Code Block

language	json

//specific extractions

{
  "amountToPay": {
      "entity": "amount",
      "value": "20.00:EUR",
      "box": { ... },
      "candidates": "amounts"
  }
}

...

Available specific extractions

n/a

Name	Description	Entity	Candidates
`amountToPay`	The amount which yet to be paid.	amount	amounts
`bic`	The bic of a payment recipient.	bic	bics
`docType`	The document type of a given document.	doctype	n/a
`iban`	The IBAN of a document sender.	iban	ibans
`paymentPurpose`	The payment purpose text	text	n/a
`paymentRecipient`	The payment recipient, beneficiary of a money transfer activity	companyname	paymentRecipients
`paymentReference`	The payment reference.	reference	n/a
amountsAreConsistent	(Return Assistant) A special extraction to check the correctness of the line item values.	amounts_are_consistent	n/a
shipment-addon	(Return Assistant) The amount of a shipment cost.	amount	n/a
discount-addon	(Return Assistant) The amount of a discount.	amount	n/a
giftcard-addon	(Return Assistant) The amount of a discount issued in a form of a giftcard.	amount	n/a
other-discounts-addon	(Return Assistant) The total sum of all additional discounts.	amount	n/a
other-charges-addon	(Return Assistant) The total sum of all additional charges.	amount

We differentiate between paymentPurpose and paymentReferences on remittance slips only (Verwendungszweck vs. Zahlungsreferenz).

On invoices, you only find the paymentPurpose field.

Versions Compared

Old Version 6

New Version Current

Key

Specific extractions

Available specific extractions