Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejson
//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": {},
 
		"candidatespaymentRecipient": {},   

			"compoundExtractionsentity": { 
"companyname",
			"skontoDiscountsvalue": "Mindener 
			{Stadtwerke GmbH",
				"skontoDueDatebox": {
					"entitytop": "date", 392.5,
					"valueleft": "2024-06-01",   196.5,
					"box": {		
			"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"
            },
            "topskontoRemainingDays": 1.0,{
   			            "leftentity": 1.0"numeric",
   			            "widthvalue": 28.9, "2"
            }
  			        }

		],
	},
	"heightcandidates": 32.0,   
{
		"paymentRecipients": [
			{
				"entity": "companyname",
				"value": "Mindener Stadtwerke        "page": 1   GmbH",
				"box": {
					}
				}, 
"top": 392.5,
					"skontoDuePeriodleft": {196.5,
					"entitywidth": "timeperiod", 268.0,
					"valueheight": "2:week"21.0,
  
					"boxpage": {}	   1
				},
			}
		],
		"skontoPercentageDiscountedamounts": [
			{
					"entity": "numericamount",
					"value": "5145.000:EUR",
					"box": {}
 
					}"top": 1490.5,

					"skontoAmountDiscountedleft": {1403.5,
					"entitywidth": "amount", 78.0,
					"valueheight": "5.00:EUR"21.0,
					"boxpage": { 1
				}
				}, 
				"skontoPercentageToPay": {
					"entity": "textamount",

					"value": "5%50.43:EUR",
					"box": {}
					}"top": 1174.8,

					"skontoAmountToPayleft": {1421.8,
					"entitywidth": "amount", 62.40000000000009,
					"valueheight": "100.00:EUR"22.0,
					"boxpage": {}1
				}
			}
		]
	}
}