Financial Document OCR Node.js
The Node.js OCR SDK supports the Financial Document API.
Using the sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.
Quick-Start
const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";
// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });
// Load a file from disk
const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");
// Parse the file
const apiResponse = mindeeClient.parse(
mindee.product.FinancialDocumentV1,
inputSource
);
// Handle the response Promise
apiResponse.then((resp) => {
// print a string summary
console.log(resp.document.toString());
});
Output (RST):
########
Document
########
:Mindee ID: 81c1d637-3a84-41d9-b40a-f72ca2a58826
:Filename: default_sample.jpg
Inference
#########
:Product: mindee/financial_document v1.1
:Rotation applied: Yes
Prediction
==========
:Locale: en; en; USD;
:Invoice Number:
:Reference Numbers:
:Purchase Date: 2014-07-07
:Due Date: 2014-07-07
:Total Net: 40.48
:Total Amount: 53.82
:Taxes:
+---------------+--------+----------+---------------+
| Base | Code | Rate (%) | Amount |
+===============+========+==========+===============+
| | TAX | | 3.34 |
+---------------+--------+----------+---------------+
:Supplier Payment Details:
:Supplier name: LOGANS
:Supplier Company Registrations:
:Supplier Address: 2513 s stemmons freeway lewisville tx 75067
:Supplier Phone Number: 9724596042
:Customer name:
:Customer Company Registrations:
:Customer Address:
:Document Type: EXPENSE RECEIPT
:Purchase Subcategory: restaurant
:Purchase Category: food
:Total Tax: 3.34
:Tip and Gratuity: 10.00
:Purchase Time: 20:20
:Line Items:
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
| Description | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit Price |
+======================================+==============+==========+============+==============+==============+============+
| TAX | | | | | 3.34 | |
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
Page Predictions
================
Page 0
------
:Locale: en; en; USD;
:Invoice Number:
:Reference Numbers:
:Purchase Date: 2014-07-07
:Due Date: 2014-07-07
:Total Net: 40.48
:Total Amount: 53.82
:Taxes:
+---------------+--------+----------+---------------+
| Base | Code | Rate (%) | Amount |
+===============+========+==========+===============+
| | TAX | | 3.34 |
+---------------+--------+----------+---------------+
:Supplier Payment Details:
:Supplier name: LOGANS
:Supplier Company Registrations:
:Supplier Address: 2513 s stemmons freeway lewisville tx 75067
:Supplier Phone Number: 9724596042
:Customer name:
:Customer Company Registrations:
:Customer Address:
:Document Type: EXPENSE RECEIPT
:Purchase Subcategory: restaurant
:Purchase Category: food
:Total Tax: 3.34
:Tip and Gratuity: 10.00
:Purchase Time: 20:20
:Line Items:
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
| Description | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit Price |
+======================================+==============+==========+============+==============+==============+============+
| TAX | | | | | 3.34 | |
+--------------------------------------+--------------+----------+------------+--------------+--------------+------------+
Field Types
Standard Fields
These fields are generic and used in several products.
Basic Field
Each prediction object contains a set of fields that inherit from the generic Field
class.
A typical Field
object will have the following attributes:
- value (number|string): corresponds to the field value. Can be
undefined
if no value was extracted. - confidence (
number
): the confidence score of the field prediction. - boundingBox (
[Point, Point, Point, Point]
): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document. - polygon (
Point[]
): contains the relative vertices coordinates (Point
) of a polygon containing the field in the image. - pageId (
number
): the ID of the page, isundefined
when at document-level. - reconstructed (
boolean
): indicates whether or not an object was reconstructed (not extracted as the API gave it).
Note: A
Point
simply refers to an array of two numbers ([number, number]
).
Aside from the previous attributes, all basic fields have access to a toString()
method that can be used to print their value as a string.
Amount Field
The amount field AmountField
only has one constraint: its value is a number
(or undefined
).
Classification Field
The classification field ClassificationField
does not implement all the basic Field
attributes. It only implements value, confidence and pageId.
Note: a classification field's
value is always a
string`.
Company Registration Field
Aside from the basic Field
attributes, the company registration field CompanyRegistrationField
also implements the following:
- type (
string
): the type of company.
Date Field
Aside from the basic Field
attributes, the date field DateField
also implements the following:
- dateObject (
Date
): an accessible representation of the value as a JavaScript object.
Locale Field
The locale field LocaleField
only implements the value, confidence and pageId base Field
attributes, but it comes with its own:
- language (
string
): ISO 639-1 language code (e.g.:en
for English). Can beundefined
. - country (
string
): ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code for countries (e.g.:GRB
orGB
for "Great Britain"). Can beundefined
. - currency (
string
): ISO 4217 code for currencies (e.g.:USD
for "US Dollars"). Can beundefined
.
Payment Details Field
Aside from the basic Field
attributes, the payment details field PaymentDetailsField
also implements the following:
- accountNumber (
string
): number of an account, expressed as a string. Can beundefined
. - iban (
string
): International Bank Account Number. Can beundefined
. - routingNumber (
string
): routing number of an account. Can beundefined
. - swift (
string
): the account holder's bank's SWIFT Business Identifier Code (BIC). Can beundefined
.
String Field
The text field StringField
only has one constraint: its value is a string
(or undefined
).
Taxes Field
Tax
Aside from the basic Field
attributes, the tax field TaxField
also implements the following:
- rate (
number
): the tax rate applied to an item can be undefined. Expressed as a percentage. Can beundefined
. - code (
number
): tax code (or equivalent, depending on the origin of the document). Can beundefined
. - base (
number
): base amount used for the tax. Can beundefined
.
Note: currently
TaxField
is not used on its own, and is accessed through a parentTaxes
object, an array-like structure.
Taxes (Array)
The Taxes
field represents an array-like collection of TaxField
objects. As it is the representation of several objects, it has access to a custom toString()
method that can render a TaxField
object as a table line.
Specific Fields
Fields which are specific to this product; they are not used in any other product.
Line Items Field
List of line item details.
A FinancialDocumentV1LineItem
implements the following attributes:
description
(string): The item description.productCode
(string): The product code referring to the item.quantity
(number): The item quantitytaxAmount
(number): The item tax amount.taxRate
(number): The item tax rate in percentage.totalAmount
(number): The item total amount.unitPrice
(number): The item unit price.
Attributes
The following fields are extracted for Financial Document V1:
Purchase Category
category (ClassificationField): The purchase category among predefined classes.
console.log(result.document.inference.prediction.category.value);
Customer Address
customerAddress (StringField): The address of the customer.
console.log(result.document.inference.prediction.customerAddress.value);
Customer Company Registrations
customerCompanyRegistrations (CompanyRegistrationField[]): List of company registrations associated to the customer.
for (const customerCompanyRegistrationsElem of result.document.inference.prediction.customerCompanyRegistrations) {
console.log(customerCompanyRegistrationsElem.value);
}
Customer name
customerName (StringField): The name of the customer.
console.log(result.document.inference.prediction.customerName.value);
Purchase Date
date (DateField): The date the purchase was made.
console.log(result.document.inference.prediction.date.value);
Document Type
documentType (ClassificationField): One of: 'INVOICE', 'CREDIT NOTE', 'CREDIT CARD RECEIPT', 'EXPENSE RECEIPT'.
console.log(result.document.inference.prediction.documentType.value);
Due Date
dueDate (DateField): The date on which the payment is due.
console.log(result.document.inference.prediction.dueDate.value);
Invoice Number
invoiceNumber (StringField): The invoice number or identifier.
console.log(result.document.inference.prediction.invoiceNumber.value);
Line Items
lineItems (FinancialDocumentV1LineItem[]): List of line item details.
for (const lineItemsElem of result.document.inference.prediction.lineItems) {
console.log(lineItemsElem.value);
}
Locale
locale (LocaleField): The locale detected on the document.
console.log(result.document.inference.prediction.locale.value);
Reference Numbers
referenceNumbers (StringField[]): List of Reference numbers, including PO number.
for (const referenceNumbersElem of result.document.inference.prediction.referenceNumbers) {
console.log(referenceNumbersElem.value);
}
Purchase Subcategory
subcategory (ClassificationField): The purchase subcategory among predefined classes for transport and food.
console.log(result.document.inference.prediction.subcategory.value);
Supplier Address
supplierAddress (StringField): The address of the supplier or merchant.
console.log(result.document.inference.prediction.supplierAddress.value);
Supplier Company Registrations
supplierCompanyRegistrations (CompanyRegistrationField[]): List of company registrations associated to the supplier.
for (const supplierCompanyRegistrationsElem of result.document.inference.prediction.supplierCompanyRegistrations) {
console.log(supplierCompanyRegistrationsElem.value);
}
Supplier name
supplierName (StringField): The name of the supplier or merchant.
console.log(result.document.inference.prediction.supplierName.value);
Supplier Payment Details
supplierPaymentDetails (PaymentDetailsField[]): List of payment details associated to the supplier.
for (const supplierPaymentDetailsElem of result.document.inference.prediction.supplierPaymentDetails) {
console.log(supplierPaymentDetailsElem.value);
}
Supplier Phone Number
supplierPhoneNumber (StringField): The phone number of the supplier or merchant.
console.log(result.document.inference.prediction.supplierPhoneNumber.value);
Taxes
taxes (TaxField[]): List of tax lines information.
for (const taxesElem of result.document.inference.prediction.taxes) {
console.log(taxesElem.toString());
}
Purchase Time
time (StringField): The time the purchase was made.
console.log(result.document.inference.prediction.time.value);
Tip and Gratuity
tip (AmountField): The total amount of tip and gratuity
console.log(result.document.inference.prediction.tip.value);
Total Amount
totalAmount (AmountField): The total amount paid: includes taxes, tips, fees, and other charges.
console.log(result.document.inference.prediction.totalAmount.value);
Total Net
totalNet (AmountField): The net amount paid: does not include taxes, fees, and discounts.
console.log(result.document.inference.prediction.totalNet.value);
Total Tax
totalTax (AmountField): The total amount of taxes.
console.log(result.document.inference.prediction.totalTax.value);
Questions?
Updated 22 days ago