Retrieve Extractions
- Former user (Deleted)
- Bart Gosiewski
Owned by Former user (Deleted), created
Once the document is processed, the document extractions become available for retrieval. See Document Extractions for Payment for more details.
//extractions can be retrieved by performing a GET request with the extractions URI:
GET /documents/{id}/extractionsRequest
Headers
Header | Value |
|---|---|
|
|
//get extractions
curl -H 'Authorization: BEARER <token>'
-X GET -H 'Accept: application/vnd.gini.v1+json'
-i https://pay-api.gini.net/documents/c292af40-d06a-11e2-9a2f-000000000000/extractionsResponse
Headers
Status Code | Description |
|---|---|
200 (OK) | Operation is successful. |
Header | Value |
|---|---|
|
|
Body (application/vnd.gini.v1+json)
Find the information about the response format in the Document Extractions section.
Name | Type | Description |
|---|---|---|
|
| Labels to extractions mapping (specific-extractions). |
|
| A mapping of labels to a list of extraction-candidates. |
Errors
Status Code | Description |
|---|---|
404 (Not Found) | Requested entity couldn't be found. |
//example response
{
"extractions": {
"amountToPay": {
"box": {
"height": 9.0,
"left": 516.0,
"page": 1,
"top": 588.0,
"width": 42.0
},
"entity": "amount",
"value": "24.99:EUR",
"candidates": "amounts"
}
},
"candidates": {
"amounts": [
{
"box": {
"height": 9.0,
"left": 516.0,
"page": 1,
"top": 588.0,
"width": 42.0
},
"entity": "amount",
"value": "24.99:EUR"
},
{
"box": {
"height": 9.0,
"left": 241.0,
"page": 1,
"top": 588.0,
"width": 42.0
},
"entity": "amount",
"value": "21.0:EUR"
}
]
...
}
}
//example response with Return Assistant specific extractions
{
"extractions": {
"amountToPay": {
"box": {
"height": 9,
"left": 516,
"page": 1,
"top": 588,
"width": 42
},
"entity": "amount",
"value": "24.99:EUR",
"candidates": "amounts"
},
"amountsAreConsistent": {
"entity": "text",
"value": "true"
},
"shipment-addon": {
"entity": "amount",
"value": "5.00:EUR"
},
"discount-addon": {
"entity": "amount",
"value": "-5.00:EUR"
},
"giftcard-addon": {
"entity": "amount",
"value": "1.00:EUR"
},
"other-discounts-addon": {
"entity": "amount",
"value": "-1.00:EUR"
},
"other-charges-addon": {
"entity": "amount",
"value": "1.00:EUR"
}
},
"compoundExtractions": {
"lineItems": [
{
"artNumber": {
"value": "10101",
"entity": "text",
"box": {
"height": 7,
"left": 55,
"page": 1,
"top": 546,
"width": 100
}
},
"quantity": {
"value": "12",
"entity": "numeric"
}
},
{
"artNumber": {
"value": "10103",
"entity": "text"
},
"quantity": {
"value": "3",
"entity": "numeric"
}
}
...
]
},
"returnReasons": [ ... ],
"candidates": {
"amounts": [ ... ]
}
}
//example response with Skonto specific extractions
{
"extractions": {
"paymentRecipient": {
"entity": "companyname",
"value": "Mindener Stadtwerke GmbH",
"box": {
"top": 392.5,
"left": 196.5,
"width": 268.0,
"height": 21.0,
"page": 1
},
"candidates": "paymentRecipients"
},
"docType": {
"entity": "doctype",
"value": "Invoice"
},
"amountToPay": {
"entity": "amount",
"value": "145.00:EUR",
"box": {
"top": 1490.5,
"left": 1403.5,
"width": 78.0,
"height": 21.0,
"page": 1
},
"candidates": "amounts"
},
"paymentPurpose": {
"entity": "reference",
"value": "ReNr TST-00019, KdNr 765432, Faligkeitsdatum 29.01.14, Rechnungsdatum 14.01.14, Verbrauchsstellennummer 5959595"
}
},
"compoundExtractions": {
"skontoDiscounts": [{
"skontoDueDate":{
"entity":"date",
"value":"2024-06-01",
"box":{
"top":1.0,
"left":1.0,
"width":28.9,
"height":32.0,
"page":1
}
},
"skontoDueDateCalculated":{
"entity":"date",
"value":"2024-06-01"
},
"skontoDuePeriod":{
"entity":"timeperiod",
"value":"2:week",
"box":{
"top":1.0,
"left":1.0,
"width":28.9,
"height":32.0,
"page":1
}
},
"skontoPercentageDiscounted":{
"entity":"numeric",
"value":"5.0",
"box":{
"top":1.0,
"left":1.0,
"width":28.9,
"height":32.0,
"page":1
}
},
"skontoPercentageDiscountedCalculated":{
"entity":"numeric",
"value":"5.0"
},
"skontoAmountDiscounted":{
"entity":"amount",
"value":"5.00:EUR",
"box":{
"top":1.0,
"left":1.0,
"width":28.9,
"height":32.0,
"page":1
}
},
"skontoAmountDiscountedCalculated":{
"entity":"amount",
"value":"5.00:EUR"
},
"skontoPercentageToPay":{
"entity":"numeric",
"value":"5.0",
"box":{
"top":1.0,
"left":1.0,
"width":28.9,
"height":32.0,
"page":1
}
},
"skontoAmountToPay":{
"entity":"amount",
"value":"100.00:EUR",
"box":{
"top":1.0,
"left":1.0,
"width":28.9,
"height":32.0,
"page":1
}
},
"skontoAmountToPayCalculated":{
"entity":"text",
"value":"100.00:EUR"
},
"skontoPaymentMethod":{
"entity":"text",
"value":"Cash"
},
"skontoRemainingDays":{
"entity":"numeric",
"value":"2"
}
}
],
},
"candidates": {
"paymentRecipients": [
{
"entity": "companyname",
"value": "Mindener Stadtwerke GmbH",
"box": {
"top": 392.5,
"left": 196.5,
"width": 268.0,
"height": 21.0,
"page": 1
}
}
],
"amounts": [
{
"entity": "amount",
"value": "145.00:EUR",
"box": {
"top": 1490.5,
"left": 1403.5,
"width": 78.0,
"height": 21.0,
"page": 1
}
},
{
"entity": "amount",
"value": "50.43:EUR",
"box": {
"top": 1174.8,
"left": 1421.8,
"width": 62.40000000000009,
"height": 22.0,
"page": 1
}
}
]
}
}