{"swagger":"2.0","info":{"title":"Blumatix.Capture.Webservice.Client.Hosted","version":"1.16"},"host":"blumatixcapturesdk-v1-16.azurewebsites.net","basePath":"/","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/invoicedetail/detect":{"post":{"tags":["invoicedetail"],"summary":"Extracts invoice features of a provided invoice.","description":"Extracts invoice features of a provided invoice.","operationId":"DetectInvoiceRequestdetect_Post","consumes":["application/x-www-form-urlencoded"],"produces":["application/json"],"parameters":[{"name":"Filter","in":"formData","description":"Filter for Invoice details that shall be predicted
flag 'None' will return all available Invoice details for your subscription,
else define the filter by providing a bitmask for the Invoice details that shall be predicted.
e.g. Filter = GrandTotalAmount | Ibans.

Filters:
","type":"integer","format":"int64","required":false,"x-nullable":false},{"name":"Invoice","in":"formData","description":"Invoice (encoded as base64 string) - accepted formats: PDF, JPG, PNG, GIF, TIFF","type":"string","required":false},{"name":"Format","in":"formData","description":"Special Invoice format.
for future use only","type":"integer","format":"int32","required":false,"x-nullable":false},{"name":"CreateResultPdf","in":"formData","description":"If this flag is set, the response will contain the sent invoice as pdf-document with marked predictions.","type":"boolean","required":false,"x-nullable":false},{"name":"AddOcrResult","in":"formData","description":"If this flag is set, the response will contain the OCR-Result as json string.","type":"boolean","required":false,"x-nullable":false},{"name":"AddOcrPageImages","in":"formData","description":"If this flag is set, the response will contain the images of the OCR-Result pages as list of Base64 encoded strings.","type":"boolean","required":false,"x-nullable":false},{"name":"AddDocumentText","in":"formData","description":"If this flag is set, the response will contain the plain text of the document as detected by the OCR.","type":"boolean","required":false,"x-nullable":false},{"name":"Languages","in":"formData","description":"Restrict invoice languages to a given set provided as a comma separates string of languages.","type":"string","required":false},{"name":"SkipJunkPages","in":"formData","description":"If this flag is set, the service will try to detect pages which do not contain any useful information (like AGBs) and it will skip them from the analysis","type":"boolean","required":false,"x-nullable":false},{"name":"body","in":"body","schema":{"$ref":"#/definitions/DetectInvoiceRequest"}}],"responses":{"200":{"description":"Service call successfully finished","schema":{"$ref":"#/definitions/DetectInvoiceResponse"}},"400":{"description":"Invoice format error","schema":{"$ref":"#/definitions/DetectInvoiceResponse"}},"401":{"description":"Unauthorized. Invalid ApiKey (or invalid ApiIdentifier)","schema":{"$ref":"#/definitions/DetectInvoiceResponse"}},"403":{"description":"Customer is not allowed to make any predictions","schema":{"$ref":"#/definitions/DetectInvoiceResponse"}},"500":{"description":"Oops, something broke","schema":{"$ref":"#/definitions/DetectInvoiceResponse"}}},"deprecated":false},"parameters":[{"$ref":"#/parameters/Accept"}]}},"definitions":{"Object":{"properties":{},"description":"Object","type":"object"},"DetectInvoiceRequest":{"title":"DetectInvoiceRequest","properties":{"Filter":{"description":"Filter for Invoice details that shall be predicted
flag 'None' will return all available Invoice details for your subscription,
else define the filter by providing a bitmask for the Invoice details that shall be predicted.
e.g. Filter = GrandTotalAmount | Ibans.

Filters:
","type":"integer","format":"int64"},"Invoice":{"description":"Invoice (encoded as base64 string) - accepted formats: PDF, JPG, PNG, GIF, TIFF","type":"string"},"Format":{"description":"Special Invoice format.
for future use only","type":"integer","format":"int32"},"PropertyStore":{"$ref":"#/definitions/Dictionary_String_String_","description":"Additional properties that will be used for invoice processing, provided as Key-Value pairs.
for future use only"},"CreateResultPdf":{"description":"If this flag is set, the response will contain the sent invoice as pdf-document with marked predictions.","type":"boolean","x-nullable":false},"AddOcrResult":{"description":"If this flag is set, the response will contain the OCR-Result as json string.","type":"boolean","x-nullable":false},"AddOcrPageImages":{"description":"If this flag is set, the response will contain the images of the OCR-Result pages as list of Base64 encoded strings.","type":"boolean","x-nullable":false},"AddDocumentText":{"description":"If this flag is set, the response will contain the plain text of the document as detected by the OCR.","type":"boolean","x-nullable":false},"Languages":{"description":"Restrict invoice languages to a given set provided as a comma separates string of languages.","type":"string"},"SkipJunkPages":{"description":"If this flag is set, the service will try to detect pages which do not contain any useful information (like AGBs) and it will skip them from the analysis","type":"boolean","x-nullable":false}},"description":"Extracts invoice features of a provided invoice.","type":"object"},"Dictionary_String_String_":{"title":"Dictionary","additionalProperties":{"type":"string"},"description":"Dictionary","type":"object"},"DetectInvoiceResponse":{"title":"DetectInvoiceResponse","properties":{"DocumentResolution":{"description":"Resolution of the original document in dpi.","type":"integer","format":"int32","x-nullable":false},"DocumentFormat":{"description":"The format of the document. It is either Letter or Receipt","type":"string"},"Language":{"description":"The detected language of the provided invoice document","type":"string"},"Countries":{"description":"The detected countires of the provided invoice document","type":"string"},"InvoiceDetailTypePredictions":{"description":"List of Predictions - One for each predicted invoice detail.","type":"array","items":{"$ref":"#/definitions/DetectionResponse"}},"PredictionGroups":{"description":"List of PredictionGroups - One for each predicted invoice detail
e.g. VatGroup, containing predictions for Vat Rate, Net Amount and Vat Amount","type":"array","items":{"$ref":"#/definitions/DetectionGroupResponse"}},"LineItemTable":{"$ref":"#/definitions/LineItemTableResponse","description":"Table of line items","type":"object"},"Sender":{"$ref":"#/definitions/ContactResponse","description":"The sender of the invoice","type":"object"},"Receiver":{"$ref":"#/definitions/ContactResponse","description":"The receiver of the invoice","type":"object"},"Contacts":{"description":"A list containing all contacts that were found on the document - this includes Sender and Receiver","type":"array","items":{"$ref":"#/definitions/ContactResponse"}},"FormattedResult":{"description":"Special invoice format. (for future use only)","type":"string"},"IsQualityOk":{"description":"Invoice quality flag. (for future use only)","type":"boolean","x-nullable":false},"OcrResult":{"description":"OCR-result as json string","type":"string"},"ResultPdf":{"description":"Result pdf-document with marked predictions. (encoded as base64 string)","type":"string"},"OcrPageImages":{"description":"List of OCR-page images (encoded as base64 string).","type":"array","items":{"type":"string"}},"DocumentText":{"description":"Plain text of the document as detected by the OCR.","type":"string"},"InvoiceState":{"description":"Describes the state of the processed invoice. 0 = Ok","type":"integer","format":"int32","x-nullable":false},"Confidence":{"description":"Describes the confidence that the invoice can be auto-processed without human validation. (-1 = unknown, 0 = validate manually, 1 = autoprocess)","type":"number","format":"float","x-nullable":false},"Measurements":{"$ref":"#/definitions/Dictionary_String_Int64_"},"Exceptions":{"type":"array","items":{"type":"string"}}},"description":"DetectInvoiceResponse","type":"object"},"DetectionResponse":{"title":"DetectionResponse","required":["Type","TypeName","Value","Score","X","Y","Width","Height"],"properties":{"Type":{"description":"Predicted invoice detail","type":"integer","format":"int64"},"TypeName":{"description":"Predicted invoice detail","type":"string"},"Value":{"description":"Predicted value

Formats:
","type":"string"},"Score":{"description":"Scored probability. Value between zero and one.","type":"number","format":"double","x-nullable":false},"X":{"description":"X-Position according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Y":{"description":"Y-Position according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Width":{"description":"Width according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Height":{"description":"Height according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Confidence":{"description":"Describes the confidence that this invoice detail can be auto-processed without human validation. (-1 = unknown, 0 = validate manually, 1 = autoprocess)","type":"number","format":"float","x-nullable":false}},"description":"DetectionResponse","type":"object"},"DetectionGroupResponse":{"title":"DetectionGroupResponse","required":["Type","TypeName"],"properties":{"Type":{"description":"Predicted invoice detail","type":"integer","format":"int64"},"TypeName":{"description":"Predicted invoice detail","type":"string"},"InvoiceDetailTypePredictions":{"description":"List of Predictions - One for each predicted invoice detail.","type":"array","items":{"$ref":"#/definitions/DetectionResponse"}}},"description":"DetectionGroupResponse","type":"object"},"LineItemTableResponse":{"title":"LineItemTableResponse","properties":{"LineItems":{"description":"List of predicted line items","type":"array","items":{"$ref":"#/definitions/LineItemResponse"}}},"description":"LineItemTableResponse","type":"object"},"LineItemResponse":{"title":"LineItemResponse","properties":{"ItemId":{"$ref":"#/definitions/DetailResponse","description":"Item id","type":"string"},"PositionNumber":{"description":"Position number of the line item","type":"integer","format":"int32","x-nullable":false},"Description":{"$ref":"#/definitions/DetailResponse","description":"Description text of the line item","type":"string"},"Quantity":{"$ref":"#/definitions/DetailResponse","description":"Quantity (number of single units) of the line item","type":"number","format":"float"},"UnitPrice":{"$ref":"#/definitions/DetailResponse","description":"Single unit price of the line item","type":"number","format":"float"},"TotalAmount":{"$ref":"#/definitions/DetailResponse","description":"Total amount of the line item","type":"number","format":"float"},"OrderId":{"$ref":"#/definitions/DetailResponse","description":"Order id of the line item","type":"number","format":"float"},"DeliveryId":{"$ref":"#/definitions/DetailResponse","description":"Delivery id of the line item","type":"number","format":"float"},"Score":{"description":"Scored probability. Value between zero and one.","type":"number","format":"double","x-nullable":false},"X":{"description":"X-Position according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Y":{"description":"Y-Position according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Width":{"description":"Width according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Height":{"description":"Height according to the document resolution","type":"integer","format":"int32","x-nullable":false}},"description":"LineItemResponse","type":"object"},"DetailResponse":{"title":"DetailResponse","properties":{"Name":{"description":"Name of the detail","type":"string"},"Text":{"description":"The content as raw text","type":"string"},"Value":{"description":"The content formatted as value","type":"string"},"Score":{"description":"Scored probability. Value between zero and one.","type":"number","format":"double","x-nullable":false},"X":{"description":"X-Position according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Y":{"description":"Y-Position according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Width":{"description":"Width according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Height":{"description":"Height according to the document resolution","type":"integer","format":"int32","x-nullable":false}},"description":"DetailResponse","type":"object"},"ContactResponse":{"title":"ContactResponse","properties":{"Name":{"$ref":"#/definitions/DetailResponse","description":"Name of the contact","type":"object"},"Address":{"$ref":"#/definitions/AddressResponse","description":"Address of the contact","type":"object"},"Score":{"description":"Scored probability. Value between zero and one.","type":"number","format":"double","x-nullable":false},"WebsiteUrl":{"description":"Website of the contact","type":"array","items":{"$ref":"#/definitions/DetailResponse"}},"Email":{"description":"Email address of the contact","type":"array","items":{"$ref":"#/definitions/DetailResponse"}},"Phone":{"$ref":"#/definitions/DetailResponse","description":"Phone number of the contact","type":"object"},"Fax":{"$ref":"#/definitions/DetailResponse","description":"Fax number of the contact","type":"object"}},"description":"ContactResponse","type":"object"},"AddressResponse":{"title":"AddressResponse","properties":{"Street":{"$ref":"#/definitions/DetailResponse","description":"Street (incl. street number)","type":"object"},"ZipCode":{"$ref":"#/definitions/DetailResponse","description":"Zip code / postal code","type":"object"},"City":{"$ref":"#/definitions/DetailResponse","description":"City","type":"object"},"Country":{"$ref":"#/definitions/DetailResponse","description":"Country","type":"object"},"X":{"description":"X-Position according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Y":{"description":"Y-Position according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Width":{"description":"Width according to the document resolution","type":"integer","format":"int32","x-nullable":false},"Height":{"description":"Height according to the document resolution","type":"integer","format":"int32","x-nullable":false}},"description":"AddressResponse","type":"object"},"Dictionary_String_Int64_":{"title":"Dictionary","additionalProperties":{"type":"integer","format":"int64","x-nullable":false},"description":"Dictionary","type":"object"}},"parameters":{"Accept":{"name":"Accept","in":"header","description":"Accept Header","type":"string","required":true,"enum":["application/json"]}},"securityDefinitions":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header"}},"tags":[{"name":"invoicedetail"}]}