...
Once the document is processed, the document extractions become available for retrieval. See Document Extractions for Payment for more details.
| Code Block | ||
|---|---|---|
| ||
//extractions can be retrieved by performing a GET request with the extractions URI:
GET /documents/{id}/extractions |
Request
Headers
Header | Value |
|---|---|
|
|
| Code Block | ||
|---|---|---|
| ||
//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/extractions |
Response
Headers
Status Code | Description |
|---|---|
200 (OK) | Operation is successful. |
...
Status Code | Description |
|---|---|
404 (Not Found) | Requested entity couldn't be found. |
| Code Block | ||
|---|---|---|
| ||
//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": [ ... ] } } |