Page Properties | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
Table of Contents |
---|
An extraction contains an entity
that describes a general semantic type of the extraction, such as iban, bic, or amount. The entity
also determines the format of the value
containing text information. There might be an optional box
element describing the position of the extraction value on the document. We refer to it as the bounding box. In most cases, the extractions without a bounding box are considered to be meta information such as doctype
.
Name | Type | Description |
---|---|---|
|
|
A key (primary identification) of an entity type |
iban
). See available extraction entities , for example, | ||
|
| A normalized textual representation of the Text/Information provided by the extraction value |
, for example, iban without spaces between the digits |
. | |
| bounding-box |
Optional |
: Bounding box containing the position of the extraction value on the document. |
Code Block | ||
---|---|---|
| ||
//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 |
---|---|---|
|
|
Optional |
: A reference to extraction candidates. See |
Extraction Entities for possible values. |
Code Block | ||
---|---|---|
| ||
//specific extractions
{
"amountToPay": {
"entity": "amount",
"value": "20.00:EUR",
"box": { ... },
"candidates": "amounts"
}
} |
...
Available specific extractions
Name | Description | Entity | Candidates |
---|---|---|---|
| The amount which yet to be paid. | amounts | |
| The bic of a payment recipient. | bics | |
| The document type of a given document. | n/a | |
| The IBAN of a document sender. | ibans | |
| The payment purpose text | n/a | |
| The payment recipient, beneficiary of a money transfer activity | paymentRecipients | |
| The payment reference. | n/a |
amountsAreConsistent
(Return Assistant) A special extraction to check the correctness of the line item values.
n/a
shipment-addon
(Return Assistant) The amount of a shipment cost.
n/a
discount-addon
(Return Assistant) The amount of a discount.
n/a
giftcard-addon
(Return Assistant) The amount of a discount issued in a form of a giftcard.
n/a
other-discounts-addon
(Return Assistant) The total sum of all additional discounts.
n/a
other-charges-addon
(Return Assistant) The total sum of all additional charges.
We differentiate between paymentPurpose and paymentReferences on remittance slips only (Verwendungszweck vs. Zahlungsreferenz).
On invoices, you only find the paymentPurpose field.