Hypatos API v2 documentation (1.1.0)

Download OpenAPI specification:Download

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Cloud authentication

Obtain API access token

access_token is used as Authorization Bearer token in header for cloud extractions requests.

Request Body schema: application/x-www-form-urlencoded

client_id required	string Value: "extractionapi"
username required	string
password required	string
grant_type required	string Value: "password"

Responses

Response samples

Content type

application/json

{"access_token": "string",
"scope": "string",
"session_state": "string",
"token_type": "string"
}

Cloud extractions

Community Edition - EU invoice extraction

Extract PDF invoice file using Community Edition. For software projects requiring basic document data capturing AI.

Authorizations:

bearerAuth

query Parameters

probabilities	boolean Default: false will output confidence score of each extracted entity
regions	boolean Default: false will output entity regions
ocr	boolean Default: false will output ocr results, in json format or xml (ocrFormat)
dpi	integer Default: 200 DPI configuration. Higher the resolution, slower the API response
ocrFormat	string Default: "xml" Enum: "json" "xml" OCR format

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

string <binary>

Responses

Response samples

Content type

application/json

{"entities": {"recipientPoNumber": "PXF34976GH",
"currency": "EUR",
"deliveredAt": "2018-01-10",
"issuedAt": "2018-01-01",
"items": [{"itemNumber": "010203",
"name": "Some AdWards campaign",
"paid": false,
"positionTaxRate": "\"19%\"",
"positionTotalPrice": 119,
"qty": 1,
"unit": "qty",
"unitNet": 100
}
],
"number": "RE201801011234",
"payment": {"bank": "ING-DiBa",
"bic": "INGABCDESFXX",
"iban": "DE89 3704 0044 0532 0130 00",
"method": "online",
"note": "Payment note",
"terms": [{"discount": 10,
"dueDays": 7,
"type": "default"
}
]
},
"recipient": {"address": "Berlinerstraße 3927",
"city": "Berlin",
"companyName": "Company Inc.",
"contactMail": "mr.smith@email.com",
"contactName": "Mr. Smith",
"country": "Germany",
"customerNumber": "030 98 29423",
"postcode": "13359"
},
"sender": {"address": "Green Avenue 123",
"city": "New York",
"companyName": "Supplier Inc.",
"contactMail": "anna.smith@supplr.com",
"contactName": "Anna Smith",
"country": "USA",
"customerNumber": "646-352-2400",
"postcode": "123-456-234",
"taxNumber": "12345678901",
"vatId": "USXXXXXXXXX"
},
"totals": {"due": 119,
"gross": 119,
"net": 100,
"tax": [{"amount": 19,
"net": 100,
"rate": 0.19
}
]
},
"others": {"shippingCost": 9.99,
"taxRateExemption": "Umsatzsteuerfreie Leistungen gemäß §19 UStG."
},
"type": "invoice"
},
"infos": {"numPages": 1
},
"probabilities": {"currency": 0.9757067561149597,
"deliveredAt": 0.9757067561149597,
"infos": {"numPages": 0.9757067561149597
},
"issuedAt": 0.9757067561149597,
"items": [{"itemNumber": 0.9757067561149597,
"name": 0.9757067561149597,
"positionTaxRate": 0.9757067561149597,
"positionTotalPrice": 0.9757067561149597,
"qty": 0.9757067561149597,
"unit": 0.9757067561149597,
"unitNet": 0.9757067561149597
}
],
"number": 0.9757067561149597,
"others": {"shippingCost": 0.9757067561149597,
"taxRateExemption": 0.9757067561149597
},
"payment": {"bank": 0.9757067561149597,
"bic": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"iban": 0.9757067561149597,
"note": 0.9757067561149597,
"terms": [{"discount": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"type": 0.9757067561149597
}
]
},
"recipient": {"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactName": 0.9757067561149597,
"country": 0.9757067561149597,
"customerNumber": 0.9757067561149597,
"postcode": 0.9757067561149597
},
"sender": {"address": 0.9757067561149597,
"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactMail": 0.9757067561149597,
"contactPhone": 0.9757067561149597,
"country": 0.9757067561149597,
"postcode": 0.9757067561149597,
"taxNumber": 0.9757067561149597,
"vatId": 0.9757067561149597
},
"totals": {"due": 0.9757067561149597,
"gross": 0.9757067561149597,
"net": 0.9757067561149597,
"tax": [{"amount": 0.9757067561149597,
"rate": 0.9757067561149597
}
]
},
"type": 0.9757067561149597
},
"regions": {"currency": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"deliveredAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"issuedAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"items": [{"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
],
"number": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"others": {"shippingCost": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxRateExemption": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"payment": {"bank": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"bic": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"iban": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"note": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"terms": [{"discount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"recipient": {"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"customerNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"sender": {"address": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactMail": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactPhone": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"vatId": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"totals": {"due": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"gross": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"net": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"tax": [{"amount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"rate": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
}

Community Edition - English invoice extraction

Extract PDF invoice file using Community Edition. For software projects requiring basic document data capturing AI. This is english language focused model.

Authorizations:

bearerAuth

query Parameters

probabilities	boolean Default: false will output confidence score of each extracted entity
regions	boolean Default: false will output entity regions
ocr	boolean Default: false will output ocr results, in json format or xml (ocrFormat)
dpi	integer Default: 200 DPI configuration. Higher the resolution, slower the API response
ocrFormat	string Default: "xml" Enum: "json" "xml" OCR format

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

string <binary>

Responses

Response samples

Content type

application/json

{"entities": {"recipientPoNumber": "PXF34976GH",
"currency": "EUR",
"deliveredAt": "2018-01-10",
"issuedAt": "2018-01-01",
"items": [{"itemNumber": "010203",
"name": "Some AdWards campaign",
"paid": false,
"positionTaxRate": "\"19%\"",
"positionTotalPrice": 119,
"qty": 1,
"unit": "qty",
"unitNet": 100
}
],
"number": "RE201801011234",
"payment": {"bank": "ING-DiBa",
"bic": "INGABCDESFXX",
"iban": "DE89 3704 0044 0532 0130 00",
"method": "online",
"note": "Payment note",
"terms": [{"discount": 10,
"dueDays": 7,
"type": "default"
}
]
},
"recipient": {"address": "Berlinerstraße 3927",
"city": "Berlin",
"companyName": "Company Inc.",
"contactMail": "mr.smith@email.com",
"contactName": "Mr. Smith",
"country": "Germany",
"customerNumber": "030 98 29423",
"postcode": "13359"
},
"sender": {"address": "Green Avenue 123",
"city": "New York",
"companyName": "Supplier Inc.",
"contactMail": "anna.smith@supplr.com",
"contactName": "Anna Smith",
"country": "USA",
"customerNumber": "646-352-2400",
"postcode": "123-456-234",
"taxNumber": "12345678901",
"vatId": "USXXXXXXXXX"
},
"totals": {"due": 119,
"gross": 119,
"net": 100,
"tax": [{"amount": 19,
"net": 100,
"rate": 0.19
}
]
},
"others": {"shippingCost": 9.99,
"taxRateExemption": "Umsatzsteuerfreie Leistungen gemäß §19 UStG."
},
"type": "invoice"
},
"infos": {"numPages": 1
},
"probabilities": {"currency": 0.9757067561149597,
"deliveredAt": 0.9757067561149597,
"infos": {"numPages": 0.9757067561149597
},
"issuedAt": 0.9757067561149597,
"items": [{"itemNumber": 0.9757067561149597,
"name": 0.9757067561149597,
"positionTaxRate": 0.9757067561149597,
"positionTotalPrice": 0.9757067561149597,
"qty": 0.9757067561149597,
"unit": 0.9757067561149597,
"unitNet": 0.9757067561149597
}
],
"number": 0.9757067561149597,
"others": {"shippingCost": 0.9757067561149597,
"taxRateExemption": 0.9757067561149597
},
"payment": {"bank": 0.9757067561149597,
"bic": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"iban": 0.9757067561149597,
"note": 0.9757067561149597,
"terms": [{"discount": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"type": 0.9757067561149597
}
]
},
"recipient": {"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactName": 0.9757067561149597,
"country": 0.9757067561149597,
"customerNumber": 0.9757067561149597,
"postcode": 0.9757067561149597
},
"sender": {"address": 0.9757067561149597,
"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactMail": 0.9757067561149597,
"contactPhone": 0.9757067561149597,
"country": 0.9757067561149597,
"postcode": 0.9757067561149597,
"taxNumber": 0.9757067561149597,
"vatId": 0.9757067561149597
},
"totals": {"due": 0.9757067561149597,
"gross": 0.9757067561149597,
"net": 0.9757067561149597,
"tax": [{"amount": 0.9757067561149597,
"rate": 0.9757067561149597
}
]
},
"type": 0.9757067561149597
},
"regions": {"currency": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"deliveredAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"issuedAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"items": [{"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
],
"number": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"others": {"shippingCost": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxRateExemption": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"payment": {"bank": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"bic": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"iban": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"note": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"terms": [{"discount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"recipient": {"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"customerNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"sender": {"address": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactMail": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactPhone": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"vatId": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"totals": {"due": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"gross": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"net": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"tax": [{"amount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"rate": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
}

Subscription Edition - EU invoice extraction.

Extract PDF invoice file with subscription edition. For software projects requiring advanced document understanding, flexible deployment options and high scalability.

Authorizations:

bearerAuth

query Parameters

probabilities	boolean Default: false will output confidence score of each extracted entity
regions	boolean Default: false will output entity regions
ocr	boolean Default: false will output ocr results, in json format or xml (ocrFormat)
dpi	integer Default: 200 DPI configuration. Higher the resolution, slower the API response
ocrFormat	string Default: "xml" Enum: "json" "xml" OCR format

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

string <binary>

Responses

Response samples

Content type

application/json

{"entities": {"recipientPoNumber": "PXF34976GH",
"currency": "EUR",
"deliveredAt": "2018-01-10",
"issuedAt": "2018-01-01",
"items": [{"itemNumber": "010203",
"name": "Some AdWards campaign",
"paid": false,
"positionTaxRate": "\"19%\"",
"positionTotalPrice": 119,
"qty": 1,
"unit": "qty",
"unitNet": 100
}
],
"number": "RE201801011234",
"payment": {"bank": "ING-DiBa",
"bic": "INGABCDESFXX",
"iban": "DE89 3704 0044 0532 0130 00",
"method": "online",
"note": "Payment note",
"terms": [{"discount": 10,
"dueDays": 7,
"type": "default"
}
]
},
"recipient": {"address": "Berlinerstraße 3927",
"city": "Berlin",
"companyName": "Company Inc.",
"contactMail": "mr.smith@email.com",
"contactName": "Mr. Smith",
"country": "Germany",
"customerNumber": "030 98 29423",
"postcode": "13359"
},
"sender": {"address": "Green Avenue 123",
"city": "New York",
"companyName": "Supplier Inc.",
"contactMail": "anna.smith@supplr.com",
"contactName": "Anna Smith",
"country": "USA",
"customerNumber": "646-352-2400",
"postcode": "123-456-234",
"taxNumber": "12345678901",
"vatId": "USXXXXXXXXX"
},
"totals": {"due": 119,
"gross": 119,
"net": 100,
"tax": [{"amount": 19,
"net": 100,
"rate": 0.19
}
]
},
"others": {"shippingCost": 9.99,
"taxRateExemption": "Umsatzsteuerfreie Leistungen gemäß §19 UStG."
},
"type": "invoice"
},
"infos": {"numPages": 1
},
"probabilities": {"currency": 0.9757067561149597,
"deliveredAt": 0.9757067561149597,
"infos": {"numPages": 0.9757067561149597
},
"issuedAt": 0.9757067561149597,
"items": [{"itemNumber": 0.9757067561149597,
"name": 0.9757067561149597,
"positionTaxRate": 0.9757067561149597,
"positionTotalPrice": 0.9757067561149597,
"qty": 0.9757067561149597,
"unit": 0.9757067561149597,
"unitNet": 0.9757067561149597
}
],
"number": 0.9757067561149597,
"others": {"shippingCost": 0.9757067561149597,
"taxRateExemption": 0.9757067561149597
},
"payment": {"bank": 0.9757067561149597,
"bic": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"iban": 0.9757067561149597,
"note": 0.9757067561149597,
"terms": [{"discount": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"type": 0.9757067561149597
}
]
},
"recipient": {"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactName": 0.9757067561149597,
"country": 0.9757067561149597,
"customerNumber": 0.9757067561149597,
"postcode": 0.9757067561149597
},
"sender": {"address": 0.9757067561149597,
"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactMail": 0.9757067561149597,
"contactPhone": 0.9757067561149597,
"country": 0.9757067561149597,
"postcode": 0.9757067561149597,
"taxNumber": 0.9757067561149597,
"vatId": 0.9757067561149597
},
"totals": {"due": 0.9757067561149597,
"gross": 0.9757067561149597,
"net": 0.9757067561149597,
"tax": [{"amount": 0.9757067561149597,
"rate": 0.9757067561149597
}
]
},
"type": 0.9757067561149597
},
"regions": {"currency": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"deliveredAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"issuedAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"items": [{"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
],
"number": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"others": {"shippingCost": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxRateExemption": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"payment": {"bank": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"bic": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"iban": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"note": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"terms": [{"discount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"recipient": {"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"customerNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"sender": {"address": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactMail": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactPhone": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"vatId": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"totals": {"due": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"gross": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"net": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"tax": [{"amount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"rate": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
}

Subscription Edition - English invoice extraction.

Extract PDF invoice file with subscription edition. For software projects requiring advanced document understanding, flexible deployment options and high scalability. This is english language focused model.

Authorizations:

bearerAuth

query Parameters

probabilities	boolean Default: false will output confidence score of each extracted entity
regions	boolean Default: false will output entity regions
ocr	boolean Default: false will output ocr results, in json format or xml (ocrFormat)
dpi	integer Default: 200 DPI configuration. Higher the resolution, slower the API response
ocrFormat	string Default: "xml" Enum: "json" "xml" OCR format

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

string <binary>

Responses

Response samples

Content type

application/json

{"entities": {"recipientPoNumber": "PXF34976GH",
"currency": "EUR",
"deliveredAt": "2018-01-10",
"issuedAt": "2018-01-01",
"items": [{"itemNumber": "010203",
"name": "Some AdWards campaign",
"paid": false,
"positionTaxRate": "\"19%\"",
"positionTotalPrice": 119,
"qty": 1,
"unit": "qty",
"unitNet": 100
}
],
"number": "RE201801011234",
"payment": {"bank": "ING-DiBa",
"bic": "INGABCDESFXX",
"iban": "DE89 3704 0044 0532 0130 00",
"method": "online",
"note": "Payment note",
"terms": [{"discount": 10,
"dueDays": 7,
"type": "default"
}
]
},
"recipient": {"address": "Berlinerstraße 3927",
"city": "Berlin",
"companyName": "Company Inc.",
"contactMail": "mr.smith@email.com",
"contactName": "Mr. Smith",
"country": "Germany",
"customerNumber": "030 98 29423",
"postcode": "13359"
},
"sender": {"address": "Green Avenue 123",
"city": "New York",
"companyName": "Supplier Inc.",
"contactMail": "anna.smith@supplr.com",
"contactName": "Anna Smith",
"country": "USA",
"customerNumber": "646-352-2400",
"postcode": "123-456-234",
"taxNumber": "12345678901",
"vatId": "USXXXXXXXXX"
},
"totals": {"due": 119,
"gross": 119,
"net": 100,
"tax": [{"amount": 19,
"net": 100,
"rate": 0.19
}
]
},
"others": {"shippingCost": 9.99,
"taxRateExemption": "Umsatzsteuerfreie Leistungen gemäß §19 UStG."
},
"type": "invoice"
},
"infos": {"numPages": 1
},
"probabilities": {"currency": 0.9757067561149597,
"deliveredAt": 0.9757067561149597,
"infos": {"numPages": 0.9757067561149597
},
"issuedAt": 0.9757067561149597,
"items": [{"itemNumber": 0.9757067561149597,
"name": 0.9757067561149597,
"positionTaxRate": 0.9757067561149597,
"positionTotalPrice": 0.9757067561149597,
"qty": 0.9757067561149597,
"unit": 0.9757067561149597,
"unitNet": 0.9757067561149597
}
],
"number": 0.9757067561149597,
"others": {"shippingCost": 0.9757067561149597,
"taxRateExemption": 0.9757067561149597
},
"payment": {"bank": 0.9757067561149597,
"bic": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"iban": 0.9757067561149597,
"note": 0.9757067561149597,
"terms": [{"discount": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"type": 0.9757067561149597
}
]
},
"recipient": {"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactName": 0.9757067561149597,
"country": 0.9757067561149597,
"customerNumber": 0.9757067561149597,
"postcode": 0.9757067561149597
},
"sender": {"address": 0.9757067561149597,
"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactMail": 0.9757067561149597,
"contactPhone": 0.9757067561149597,
"country": 0.9757067561149597,
"postcode": 0.9757067561149597,
"taxNumber": 0.9757067561149597,
"vatId": 0.9757067561149597
},
"totals": {"due": 0.9757067561149597,
"gross": 0.9757067561149597,
"net": 0.9757067561149597,
"tax": [{"amount": 0.9757067561149597,
"rate": 0.9757067561149597
}
]
},
"type": 0.9757067561149597
},
"regions": {"currency": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"deliveredAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"issuedAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"items": [{"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
],
"number": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"others": {"shippingCost": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxRateExemption": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"payment": {"bank": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"bic": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"iban": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"note": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"terms": [{"discount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"recipient": {"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"customerNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"sender": {"address": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactMail": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactPhone": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"vatId": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"totals": {"due": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"gross": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"net": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"tax": [{"amount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"rate": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
}

Subscription Edition - German receipt extraction.

Extract PDF receipt file with subscription edition. For software projects requiring advanced document understanding, flexible deployment options and high scalability.

Authorizations:

bearerAuth

query Parameters

probabilities	boolean Default: false will output confidence score of each extracted entity
regions	boolean Default: false will output entity regions
ocr	boolean Default: false will output ocr results, in json format or xml (ocrFormat)
dpi	integer Default: 100 DPI configuration. Higher the resolution, slower the API response
ocrFormat	string Default: "xml" Enum: "json" "xml" OCR format

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

string <binary>

Responses

Response samples

Content type

application/json

{"entities": {"receiptNumber": "PXF34976GH",
"currency": "EUR",
"tip": "$2.00",
"date": "2018-01-10",
"time": "17:01",
"items": [{"itemNumber": "1",
"name": "Hawaiian Pizza",
"positionTaxRate": "\"19%\"",
"positionTotalPrice": 7,
"qty": 2,
"unit": "qty",
"unitNet": 7
}
],
"payment": {"amount": "15,40€",
"method": "EC-Card"
},
"recipient": {"address": "Berlinerstraße 3927",
"city": "Berlin",
"companyName": "Pizza House GmbH.",
"contactMail": "mr.pizza@email.com",
"contactName": "Mr. Smith",
"country": "Germany",
"customerNumber": "030 98 29423",
"postcode": "13359"
},
"vendor": {"address": "Green Avenue 123",
"city": "New York",
"companyName": "Supplier Inc.",
"contactMail": "anna.smith@supplr.com",
"contactPhone": "0176-343-3432",
"postcode": "123-456-234",
"taxNumber": "12345678901",
"taxId": "USXXXXXXXXX"
},
"totals": {"gross": 119,
"net": 100,
"tax": [{"amount": 19,
"net": 100,
"rate": 0.19
}
]
},
"type": "receipt"
},
"infos": {"numPages": 1
},
"probabilities": {"currency": 0.9757067561149597,
"tip": 0.9757067561149597,
"date": 0.9757067561149597,
"infos": {"numPages": 0.9757067561149597
},
"time": 0.9757067561149597,
"items": [{"itemNumber": 0.9757067561149597,
"name": 0.9757067561149597,
"positionTaxRate": 0.9757067561149597,
"positionTotalPrice": 0.9757067561149597,
"qty": 0.9757067561149597,
"unit": 0.9757067561149597,
"unitNet": 0.9757067561149597
}
],
"receiptNumber": 0.9757067561149597,
"payment": {"amount": 0.9757067561149597,
"method": 0.9757067561149597
},
"recipient": {"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactName": 0.9757067561149597,
"country": 0.9757067561149597,
"customerNumber": 0.9757067561149597,
"postcode": 0.9757067561149597
},
"vendor": {"address": 0.9757067561149597,
"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactMail": 0.9757067561149597,
"contactPhone": 0.9757067561149597,
"postcode": 0.9757067561149597,
"taxNumber": 0.9757067561149597,
"taxId": 0.9757067561149597
},
"totals": {"gross": 0.9757067561149597,
"net": 0.9757067561149597,
"tax": [{"amount": 0.9757067561149597,
"rate": 0.9757067561149597
}
]
},
"type": 0.9757067561149597
},
"regions": {"currency": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"tip": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"date": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"time": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"items": [{"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
],
"receiptNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"payment": {"amount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"method": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"recipient": {"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"customerNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"vendor": {"address": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactMail": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactPhone": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxId": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"totals": {"gross": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"net": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"tax": [{"amount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"rate": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
}

On premise extractions

Extract invoice endpoint in on-premise solution

This endpoint is available only with On Premise installation

query Parameters

probabilities	boolean Default: false will output confidence score of each extracted entity
regions	boolean Default: false will output entity regions
ocr	boolean Default: false will output ocr results, in json format or xml (ocrFormat)
dpi	integer Default: 200 DPI configuration. Higher the resolution, slower the API response
ocrFormat	string Default: "xml" Enum: "json" "xml" OCR format
maxPages	integer Default: 10 number of pages to extract

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

string <binary>

Responses

Response samples

Content type

application/json

{"entities": {"recipientPoNumber": "PXF34976GH",
"currency": "EUR",
"deliveredAt": "2018-01-10",
"issuedAt": "2018-01-01",
"items": [{"itemNumber": "010203",
"name": "Some AdWards campaign",
"paid": false,
"positionTaxRate": "\"19%\"",
"positionTotalPrice": 119,
"qty": 1,
"unit": "qty",
"unitNet": 100
}
],
"number": "RE201801011234",
"payment": {"bank": "ING-DiBa",
"bic": "INGABCDESFXX",
"iban": "DE89 3704 0044 0532 0130 00",
"method": "online",
"note": "Payment note",
"terms": [{"discount": 10,
"dueDays": 7,
"type": "default"
}
]
},
"recipient": {"address": "Berlinerstraße 3927",
"city": "Berlin",
"companyName": "Company Inc.",
"contactMail": "mr.smith@email.com",
"contactName": "Mr. Smith",
"country": "Germany",
"customerNumber": "030 98 29423",
"postcode": "13359"
},
"sender": {"address": "Green Avenue 123",
"city": "New York",
"companyName": "Supplier Inc.",
"contactMail": "anna.smith@supplr.com",
"contactName": "Anna Smith",
"country": "USA",
"customerNumber": "646-352-2400",
"postcode": "123-456-234",
"taxNumber": "12345678901",
"vatId": "USXXXXXXXXX"
},
"totals": {"due": 119,
"gross": 119,
"net": 100,
"tax": [{"amount": 19,
"net": 100,
"rate": 0.19
}
]
},
"others": {"shippingCost": 9.99,
"taxRateExemption": "Umsatzsteuerfreie Leistungen gemäß §19 UStG."
},
"type": "invoice"
},
"infos": {"numPages": 1
},
"probabilities": {"currency": 0.9757067561149597,
"deliveredAt": 0.9757067561149597,
"infos": {"numPages": 0.9757067561149597
},
"issuedAt": 0.9757067561149597,
"items": [{"itemNumber": 0.9757067561149597,
"name": 0.9757067561149597,
"positionTaxRate": 0.9757067561149597,
"positionTotalPrice": 0.9757067561149597,
"qty": 0.9757067561149597,
"unit": 0.9757067561149597,
"unitNet": 0.9757067561149597
}
],
"number": 0.9757067561149597,
"others": {"shippingCost": 0.9757067561149597,
"taxRateExemption": 0.9757067561149597
},
"payment": {"bank": 0.9757067561149597,
"bic": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"iban": 0.9757067561149597,
"note": 0.9757067561149597,
"terms": [{"discount": 0.9757067561149597,
"dueDays": 0.9757067561149597,
"type": 0.9757067561149597
}
]
},
"recipient": {"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactName": 0.9757067561149597,
"country": 0.9757067561149597,
"customerNumber": 0.9757067561149597,
"postcode": 0.9757067561149597
},
"sender": {"address": 0.9757067561149597,
"city": 0.9757067561149597,
"companyName": 0.9757067561149597,
"contactMail": 0.9757067561149597,
"contactPhone": 0.9757067561149597,
"country": 0.9757067561149597,
"postcode": 0.9757067561149597,
"taxNumber": 0.9757067561149597,
"vatId": 0.9757067561149597
},
"totals": {"due": 0.9757067561149597,
"gross": 0.9757067561149597,
"net": 0.9757067561149597,
"tax": [{"amount": 0.9757067561149597,
"rate": 0.9757067561149597
}
]
},
"type": 0.9757067561149597
},
"regions": {"currency": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"deliveredAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"issuedAt": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"items": [{"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
],
"number": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"others": {"shippingCost": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxRateExemption": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"payment": {"bank": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"bic": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"iban": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"note": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"terms": [{"discount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"dueDays": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"recipient": {"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"customerNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"sender": {"address": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"city": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"companyName": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactMail": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"contactPhone": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"country": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"postcode": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"taxNumber": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"vatId": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
},
"totals": {"due": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"gross": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"net": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"tax": [{"amount": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
},
"rate": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
]
},
"type": {"height": 0.007268063274903813,
"indicies": [72
],
"left": 0.28960096735187424,
"page": 1,
"top": 0.9080803762291577,
"width": 0.09129383313180173
}
}
}

Hypatos API v2 documentation (1.1.0)

Authentication

bearerAuth

Cloud authentication

Obtain API access token

Request Body schema: application/x-www-form-urlencoded

Responses

Response samples

Cloud extractions

Community Edition - EU invoice extraction

Authorizations:

query Parameters

Request Body schema: application/pdfapplication/pdfimage/jpegimage/pngimage/tiff

Responses

Response samples

Community Edition - English invoice extraction

Authorizations:

query Parameters

Request Body schema: application/pdfapplication/pdfimage/jpegimage/pngimage/tiff

Responses

Response samples

Subscription Edition - EU invoice extraction.

Authorizations:

query Parameters

Request Body schema: application/pdfapplication/pdfimage/jpegimage/pngimage/tiff

Responses

Response samples

Subscription Edition - English invoice extraction.

Authorizations:

query Parameters

Request Body schema: application/pdfapplication/pdfimage/jpegimage/pngimage/tiff

Responses

Response samples

Subscription Edition - German receipt extraction.

Authorizations:

query Parameters

Request Body schema: application/pdfapplication/pdfimage/jpegimage/pngimage/tiff

Responses

Response samples

On premise extractions

Extract invoice endpoint in on-premise solution

query Parameters

Request Body schema: application/pdfapplication/pdfimage/jpegimage/pngimage/tiff

Responses

Response samples

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff

Request Body schema:
application/pdf
application/pdf
image/jpeg
image/png
image/tiff