Skip to content

Commit 60f714e

Browse files
vl-albedovl-albedo
committed
Invoice parsing
1 parent 0a18fe1 commit 60f714e

File tree

5 files changed

+312
-1
lines changed

5 files changed

+312
-1
lines changed

‎ocr/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,5 @@ Even the complex recognition tasks can be done with a couple of API calls. You d
3737
Master Aspose.OCR Cloud API and and build your own cross-platform OCR applications.
3838
- [How-to's](/ocr/how-to/)
3939
Find answers to the most common questions you may have when using Aspose.OCR Cloud.
40-
- [Release Notes](https://releases.aspose.cloud/ocr/release-notes/)
40+
- [Release Notes](/ocr/release-notes/)
4141
Read a summary of recent changes, enhancements and bug fixes in Aspose.OCR Cloud.

‎ocr/developer-reference/recognize-parse-invoice/_index.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
weight: 70
3+
date: "2023-11-02"
4+
author: "Vladimir Lapin"
5+
type: docs
6+
url: /recognize-parse-invoice/
7+
feedback: OCRCLOUD
8+
title: Extracting information from scanned invoices
9+
description: Extract information such as numbers, dates, items, and totals from scanned invoices using the Aspose.OCR Cloud API.
10+
keywords:
11+
- OCR
12+
- recognize
13+
- invoice
14+
- parse
15+
- details
16+
- statement
17+
---
18+
19+
Invoices are commonly exchanged as scanned documents in many business and financial transactions. Aspose.OCR Cloud extends beyond traditional optical character recognition by employing natural language processing to extract specific information from invoices and filters out specific information from them. The results can serve various purposes, such as generating summary reports, stored in a database, or seamlessly integrated into accounting, financial, and banking software.
20+
21+
The processing is performed in 3 API calls:
22+
23+
1. [Get access token](/ocr/authorization/)
24+
2. [Send invoice for recognition](/ocr/send-invoice-for-recognition/)
25+
3. [Fetch machine-readable invoice data](/ocr/fetch-invoice-recognition-result/)
26+
27+
Because Aspose.OCR Cloud is provided as a REST API, invoice processing can be performed from any platform with Internet access.
28+
29+
Aspose also provides open-source [SDKs](/ocr/invoice-recognition-sdk/) for all popular programming languages, that wrap all routine invoice processing into a few native methods. It makes interaction with Aspose.OCR Cloud services much easier, allowing you to focus on the task at hand rather than technical details.
30+
31+
{{% alert color="primary" %}}
32+
Make sure the application has access to the **api.aspose.cloud** domain.
33+
{{% /alert %}}

‎ocr/developer-reference/recognize-parse-invoice/fetch-recognition-result/_index.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
weight: 20
3+
date: "2023-11-02"
4+
author: "Vladimir Lapin"
5+
type: docs
6+
url: /fetch-invoice-recognition-result/
7+
feedback: OCRCLOUD
8+
title: Fetching invoice processing result
9+
description: How to get the parsed invoice data from the Aspose.OCR Cloud queue.
10+
keywords:
11+
- OCR
12+
- recognize
13+
- queue
14+
- get
15+
- obtain
16+
- fetch
17+
- result
18+
- invoice
19+
---
20+
21+
When an invoice is [submitted](/ocr/send-invoice-for-recognition/) for processing, it is [queued](/ocr/recognition-workflow/) to ensure a stable response even under high load. To obtain the result, send a **GET** request to the `https://api.aspose.cloud/v5.0/ocr/RecognizeAndParseInvoice` Aspose.OCR Cloud REST API endpoint. To authorize the request, pass the [access token](/ocr/authorization/) in **Authorization** header (_Bearer authentication_).
22+
23+
Provide the [unique identifier](/ocr/send-invoice-for-recognition/#return-value) of the invoice processing task in `id` parameter:
24+
25+
```bash
26+
curl --request GET --location 'https://api.aspose.cloud/v5.0/ocr/RecognizeAndParseInvoice?id=39b37b24-86e8-4e91-9a99-6c2574853eb5' \
27+
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...HaRYOxBcCRCPLnrFCVXpw7UA' \
28+
```
29+
30+
## Processing results
31+
32+
The processing result is returned in JSON format in the response body.
33+
34+
```json
35+
{
36+
"id": "39b37b24-86e8-4e91-9a99-6c2574853eb5",
37+
"responseStatusCode": "Ok",
38+
"taskStatus": "Completed",
39+
"results": [
40+
{
41+
"type": "Text",
42+
"data": "eyJpc3N1ZV9kYXRlIjogIjIwMTctMTEtMjciL...sICJhY2NvdW50IjogIjJ4eHh4MG9veGsifQ=="
43+
}
44+
],
45+
"error": null
46+
}
47+
```
48+
49+
{{% alert color="primary" %}}
50+
Processing results are stored in the Aspose cloud and can be obtained by the task ID within **24 hours** after the invoice was sent to Aspose.OCR Cloud.
51+
{{% /alert %}}
52+
53+
Property | Type | Description
54+
--------- | ---- | -----------
55+
`id` | string | Unique identifier of the invoice processing task. Equals to the value of the `id` request property.
56+
`taskStatus` | string | [Current state](#task-statuses) of the invoice processing task in the queue.
57+
`responseStatusCode` | string | Processing response status.
58+
`results` | Base64 encoded JSON | [Invoice details](#invoice-details) in JSON format.<br />The data is returned as Base64 encoded string. You must decode it to deserialize into an object, display on the screen or save to a file.
59+
`error/messages` | string[] | Processing error messages, if any.<br />Even if the invoice was processed, you can still get notifications and warnings about non-fatal processing errors.
60+
61+
## Invoice details
62+
63+
The parsed invoice contents are returned in JSON format:
64+
65+
```json
66+
{
67+
"issue_date": "2017-11-27",
68+
"due_date": "",
69+
"supplier_name": "abc exports",
70+
"supplier_address": "4300 longbeach blvd longbeach california 90807 united states",
71+
"supplier_email": "",
72+
"supplier_phone": "15627349957",
73+
"supplier_tax_id": "",
74+
"receiver_name": "abc imports",
75+
"receiver_address": "140 wecker road manstield brisbane queensland 4122 australia",
76+
"receiver_tax_id": "",
77+
"currency": "usd",
78+
"total_amount": 43550.0,
79+
"vat": -1,
80+
"net_amount": 43550.0,
81+
"bank_name": "bank of america",
82+
"bic": "",
83+
"account": "2xxxx0ooxk"
84+
}
85+
```
86+
87+
At the moment, Aspose.OCR API recognizes the following invoice data:
88+
89+
Property | Format | Description
90+
-------- | ------ | -----------
91+
"issue_date" | string | Invoice issue date in _YYYY-MM-dd_ format.
92+
"due_date" | string | Invoice due date in _YYYY-MM-dd_ format.
93+
"supplier_name" | string | Supplier or service provider name.
94+
"supplier_address" | string | Supplier or service provider address (as one string).
95+
"supplier_email" | string | Supplier or service provider email address.
96+
"supplier_phone" | string | Supplier or service provider phone number (as provided in the invoice, without conversion to international format).
97+
"supplier_tax_id" | string | Supplier or service provider TIN or similar ID.
98+
"receiver_name" | string | Receiver name.
99+
"receiver_address" | string | Receiver address (as one string).
100+
"receiver_tax_id" | string | Receiver TIN or similar ID.
101+
"currency" | string | Invoice currency.
102+
"total_amount" | number | Total (raw) amount due.
103+
"vat" | number | VAT, percent. `-1` if the value is missing in the invoice.
104+
"net_amount" | number | Net amount due.
105+
"bank_name" | string | Supplier's bank name.
106+
"bic" | string | Supplier's SWIFT or similar code.
107+
"account" | string | Supplier's account number.
108+
109+
{{% alert color="primary" %}}
110+
The availability of the properties above depends on the invoice text and structure.
111+
{{% /alert %}}
112+
113+
## Task statuses
114+
115+
Processing may take up to several seconds depending on the Aspose.OCR cloud load and the size of the original scan or photo. The status of the processing task is indicated in the `taskStatus` property of the processing result.
116+
117+
Status code | Description | To do
118+
----------- | ----------- | ------
119+
Pending | The invoice is queued for processing, but not yet processed. | Try fetching the result in a couple of seconds using the same ID.
120+
Processing | The invoice is currently being processed. | Fetch the result again using the same ID.
121+
Completed | The invoice is processed. | Read the result from `results` property.
122+
Error | An error occurred during processing. | Check messages in the `error` property for more information.
123+
NotExist | The request with the specified ID does not exist, or the result has already been deleted from the cloud storage. | Check the ID or [send the invoice for processing](/ocr/send-invoice-for-recognition/) again with the same parameters.

‎ocr/developer-reference/recognize-parse-invoice/recognition-sdk/_index.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
weight: 30
3+
date: "2023-11-02"
4+
author: "Vladimir Lapin"
5+
type: docs
6+
url: /invoice-recognition-sdk/
7+
feedback: OCRCLOUD
8+
title: Invoice processing with Aspose.OCR Cloud SDK
9+
description: How to use Aspose.OCR Cloud SDK for parsing scanned or photographed invoices.
10+
keywords:
11+
- OCR
12+
- process
13+
- parse
14+
- programming
15+
- development
16+
- SDK
17+
- invoice
18+
---
19+
20+
Although you can directly call the Aspose.OCR Cloud REST API to [send invoices for processing](/ocr/send-invoice-for-recognition/) and [fetch parsed data](/ocr/fetch-invoice-recognition-result/), there is a much easier way to implement OCR functionality in your applications. We provide software development kits (SDKs) for all popular programming languages. They wrap up all routine operations such as establishing connections, sending API requests, and parsing responses into a few simple methods. It makes interaction with Aspose.OCR Cloud services much easier, allowing you to focus on business logic rather than technical details.
21+
22+
{{< tabs tabID="1" tabTotal="1" tabName1=".NET" >}}
23+
24+
{{< tab tabNum="1" >}}
25+
```csharp
26+
using Aspose.OCR.Cloud.SDK.Api;
27+
using Aspose.OCR.Cloud.SDK.Model;
28+
using System.Text;
29+
30+
namespace Example
31+
{
32+
internal class Program
33+
{
34+
static void Main(string[] args)
35+
{
36+
/** Authorize your requests to Aspose.OCR Cloud API */
37+
RecognizeAndParseInvoiceApi api = new RecognizeAndParseInvoiceApi("<Client Id>", "<Client Secret>");
38+
/** Read invoice image to array of bytes */
39+
byte[] invoice = File.ReadAllBytes("invoice.png");
40+
/** Specify recognition language */
41+
OCRSettingsRecognizeAndParseInvoice recognitionSettings = new OCRSettingsRecognizeAndParseInvoice {
42+
Language = Language.English
43+
};
44+
/** Send invoice for processing */
45+
OCRRecognizeAndParseInvoiceBody source = new OCRRecognizeAndParseInvoiceBody(invoice, recognitionSettings);
46+
string taskID = api.PostRecognizeReceipt(source);
47+
/** Fetch recognition result */
48+
OCRResponse result = api.GetRecognizeAndParseInvoice(taskID);
49+
Console.WriteLine(Encoding.UTF8.GetString(result.Results[0].Data));
50+
}
51+
}
52+
}
53+
```
54+
55+
Visit our GitHub repository for a working code and sample files: https://github.com/aspose-ocr-cloud/aspose-ocr-cloud-dotnet
56+
{{< /tab >}}
57+
58+
{{< /tabs >}}

‎ocr/developer-reference/recognize-parse-invoice/send-for-recognition/_index.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
weight: 10
3+
date: "2023-11-02"
4+
author: "Vladimir Lapin"
5+
type: docs
6+
url: /send-invoice-for-recognition/
7+
feedback: OCRCLOUD
8+
title: Sending invoice for recognition
9+
description: How to send a photo or scan of the invoice for processing to the Aspose.OCR Cloud API.
10+
keywords:
11+
- OCR
12+
- recognize
13+
- queue
14+
- send
15+
- invoice
16+
---
17+
18+
To extract information from a scanned or photographed invoice, send a **POST** request to the `https://api.aspose.cloud/v5.0/ocr/RecognizeAndParseInvoice` Aspose.OCR Cloud REST API endpoint. To authorize the request, pass the [access token](/ocr/authorization/) in **Authorization** header (_Bearer authentication_).
19+
20+
The invoice and recognition parameters are provided in JSON format in the request body.
21+
22+
```json
23+
{
24+
"image": "Base64 string",
25+
"settings": {
26+
"language": "English",
27+
"makeSkewCorrect": true,
28+
"rotate": 0,
29+
"makeBinarization": false,
30+
"makeUpsampling": false,
31+
"makeSpellCheck": false,
32+
}
33+
}
34+
```
35+
36+
## Providing invoice image
37+
38+
Photo or scan of the invoice is provided in a value of `image` property as a Base64 encoded string.
39+
40+
{{% alert color="caution" %}}
41+
Base64 encoded file can be very long, especially when recognizing scans and high resolution photos. As a result, you may encounter an error when calling recognition via cURL in a shell command. Use the `getconf ARG_MAX` command to check the maximum length of the command arguments (in bytes).
42+
{{% /alert %}}
43+
44+
## Recognition settings
45+
46+
Property | Type | Default&nbsp;value | Description
47+
------- | ---- | ------------- | -----------
48+
`language` | string | `English` | Specify a [language](/ocr/supported-languages/) for recognition.
49+
`makeSkewCorrect` | boolean | `true` | Automatically correct invoice image tilt (deskew) before proceeding to recognition.<br />Automatic deskew works for images rotated 15 degrees or less. If the scan or photo is rotated by a larger degree or upside down, you must manually specify the rotation angle.
50+
`rotate` | integer | `0` | Rotate an invoice image by the specified degree.<br />Should be used when the image is rotated by a significant angle or turned upside down.
51+
`makeBinarization` | boolean | `false` | Automatically convert an invoice to black and white before proceeding to recognition.
52+
`makeUpsampling` | boolean | `false` | Intellectually upscale an invoice image to improve small font recognition and detection of dense lines.
53+
`makeSpellCheck` | boolean | `false` | Automatically replace commonly misspelled words in recognition results with the correct ones. The dictionary is based on the [selected recognition language](/ocr/supported-languages/).
54+
55+
## Image preprocessing order
56+
57+
If image preprocessing filters are enabled, they are applied one after the other in the following order:
58+
59+
1. [Upsampling](/ocr/upsample-image/#using-the-recognition-setting) (`"makeUpsampling": true`)
60+
2. [Skew correction](/ocr/deskew-image/#using-the-recognition-setting) (`"makeSkewCorrect": true`)
61+
62+
If you want to apply preprocessing filters in another order, disable the corresponding recognition settings and use [self-managed preprocessing](/ocr/preprocess-image/).
63+
64+
## Return value
65+
66+
If successful, this method returns a string with a unique identifier (GUID) of the invoice recognition request in the [queue](/ocr/recognition-workflow/).
67+
68+
Otherwise, it returns a HTTP status code corresponding to the error.
69+
70+
## What's next
71+
72+
Recognition and processing will take a few seconds, depending on the size of the source file and the current Aspose.Cloud load. See the article [Fetching invoice processing result](/ocr/fetch-invoice-recognition-result/) for information on how to get a JSON with parsed invoice data from the server.
73+
74+
## cURL example
75+
76+
{{< tabs tabID="1" tabTotal="2" tabName1="Request" tabName2="Response" >}}
77+
{{< tab tabNum="1" >}}
78+
```bash
79+
curl --location --request POST 'https://api.aspose.cloud/v5.0/ocr/RecognizeAndParseInvoice' \
80+
--header 'Accept: text/plain' \
81+
--header 'Content-Type: application/json' \
82+
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...HaRYOxBcCRCPLnrFCVXpw7UA' \
83+
--data-raw '{
84+
"image": "/9j/4AAQSkZJRgABAQEBLAEsAAD...8AkTf/2Q==",
85+
"settings": {
86+
"language": "English",
87+
"makeSpellCheck": true
88+
}
89+
}'
90+
```
91+
{{< /tab >}}
92+
{{< tab tabNum="2" >}}
93+
```
94+
39b37b24-86e8-4e91-9a99-6c2574853eb5
95+
```
96+
{{< /tab >}}
97+
{{< /tabs >}}

0 commit comments

Comments
 (0)