Financial Document

The Ruby Client Library supports the Financial Document API.

Product Specifications

Specification	Details
Endpoint Name	financial_document
Recommended Version	v1.15
Supports Polling/Webhooks	✔️ Yes
Support Synchronous HTTP Calls	✔️ Yes
Geography	🌐 Global

Quick-Start

Using the sample below, we are going to illustrate how to extract the data that we want using the SDK.

Sample Code

#
# Install the Ruby client library by running:
# gem install mindee
#

require 'mindee'

# Init a new client
mindee_client = Mindee::Client.new(api_key: 'my-api-key')

# Load a file from disk
input_source = mindee_client.source_from_path('/path/to/the/file.ext')

# Parse the file
result = mindee_client.parse(
  input_source,
  Mindee::Product::FinancialDocument::FinancialDocumentV1,
  enqueue: false
)

# Print a full summary of the parsed data in RST format
puts result.document

# Print the document-level parsed data
# puts result.document.inference.prediction

You can also call this product asynchronously:

#
# Install the Ruby client library by running:
# gem install mindee
#

require 'mindee'

# Init a new client
mindee_client = Mindee::Client.new(api_key: 'my-api-key')

# Load a file from disk
input_source = mindee_client.source_from_path('/path/to/the/file.ext')

# Parse the file
result = mindee_client.parse(
  input_source,
  Mindee::Product::FinancialDocument::FinancialDocumentV1
)

# Print a full summary of the parsed data in RST format
puts result.document

# Print the document-level parsed data
# puts result.document.inference.prediction

Sample Output (rST)

########
Document
########
:Mindee ID: 6dd26385-719b-4527-bf6f-87d9da619de5
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/financial_document v1.14
:Rotation applied: Yes

Prediction
==========
:Locale: en-US; en; US; USD;
:Invoice Number: INT-001
:Purchase Order Number: 2412/2019
:Receipt Number:
:Document Number: INT-001
:Reference Numbers: 2412/2019
:Purchase Date: 2019-11-02
:Due Date: 2019-11-17
:Payment Date: 2019-11-17
:Total Net: 195.00
:Total Amount: 204.75
:Taxes:
  +---------------+--------+----------+---------------+
  | Base          | Code   | Rate (%) | Amount        |
  +===============+========+==========+===============+
  | 195.00        |        | 5.00     | 9.75          |
  +---------------+--------+----------+---------------+
:Supplier Payment Details:
:Supplier Name: JOHN SMITH
:Supplier Company Registrations:
:Supplier Address: 4490 Oak Drive Albany, NY 12210
:Supplier Phone Number:
:Customer Name: JESSIE M HORNE
:Supplier Website:
:Supplier Email:
:Customer Company Registrations:
:Customer Address: 2019 Redbud Drive New York, NY 10011
:Customer ID: 1234567890
:Shipping Address: 2019 Redbud Drive New York, NY 10011
:Billing Address: 4312 Wood Road New York, NY 10031
:Document Type: INVOICE
:Document Type Extended: INVOICE
:Purchase Subcategory:
:Purchase Category: miscellaneous
:Total Tax: 9.75
:Tip and Gratuity:
:Purchase Time:
:Line Items:
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
  +======================================+==============+==========+============+==============+==============+=================+============+
  | Front and rear brake cables          |              | 1.00     |            |              | 100.00       |                 | 100.00     |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | New set of pedal arms                |              | 2.00     |            |              | 50.00        |                 | 25.00      |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | Labor 3hrs                           |              | 3.00     |            |              | 45.00        |                 | 15.00      |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+

Page Predictions
================

Page 0
------
:Locale: en-US; en; US; USD;
:Invoice Number: INT-001
:Purchase Order Number: 2412/2019
:Receipt Number:
:Document Number: INT-001
:Reference Numbers: 2412/2019
:Purchase Date: 2019-11-02
:Due Date: 2019-11-17
:Payment Date: 2019-11-17
:Total Net: 195.00
:Total Amount: 204.75
:Taxes:
  +---------------+--------+----------+---------------+
  | Base          | Code   | Rate (%) | Amount        |
  +===============+========+==========+===============+
  | 195.00        |        | 5.00     | 9.75          |
  +---------------+--------+----------+---------------+
:Supplier Payment Details:
:Supplier Name: JOHN SMITH
:Supplier Company Registrations:
:Supplier Address: 4490 Oak Drive Albany, NY 12210
:Supplier Phone Number:
:Customer Name: JESSIE M HORNE
:Supplier Website:
:Supplier Email:
:Customer Company Registrations:
:Customer Address: 2019 Redbud Drive New York, NY 10011
:Customer ID: 1234567890
:Shipping Address: 2019 Redbud Drive New York, NY 10011
:Billing Address: 4312 Wood Road New York, NY 10031
:Document Type: INVOICE
:Document Type Extended: INVOICE
:Purchase Subcategory:
:Purchase Category: miscellaneous
:Total Tax: 9.75
:Tip and Gratuity:
:Purchase Time:
:Line Items:
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
  +======================================+==============+==========+============+==============+==============+=================+============+
  | Front and rear brake cables          |              | 1.00     |            |              | 100.00       |                 | 100.00     |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | New set of pedal arms                |              | 2.00     |            |              | 50.00        |                 | 25.00      |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | Labor 3hrs                           |              | 3.00     |            |              | 45.00        |                 | 15.00      |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+

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 (String, Float, Integer, bool): corresponds to the field value. Can be nil if no value was extracted.

• confidence (Float, nil): the confidence score of the field prediction.

• bounding_box (Mindee::Geometry::Quadrilateral, nil): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.

• polygon (Mindee::Geometry::Polygon, nil): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.

• page_id (Integer, nil): the ID of the page, always nil when at document-level.

• reconstructed (bool): indicates whether an object was reconstructed (not extracted as the API gave it).

Aside from the previous attributes, all basic fields have access to a to_s method that can be used to print their value as a string.

AddressField

Aside from the basic BaseField attributes, the address field AddressField also implements the following:

• street_number (String): String representation of the street number. Can be nil.

• street_name (String): Name of the street. Can be nil.

• po_box (String): String representation of the PO Box number. Can be nil.

• address_complement (String): Address complement. Can be nil.

• city (String): City name. Can be nil.

• postal_code (String): String representation of the postal code. Can be nil.

• state (String): State name. Can be nil.

• country (String): Country name. Can be nil.

The value field of an AddressField should be a concatenation of the rest of the values.

Amount Field

The amount field AmountField only has one constraint: its value is a Float (or nil).

Classification Field

The classification field ClassificationField does not implement all the basic Field attributes. It only implements value, confidence and page_id.

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:

• date_object (Date): an accessible representation of the value as a JavaScript object.

Locale Field

The locale field LocaleField only implements the value, confidence and page_id base Field attributes, but it comes with its own:

• language (String): ISO 639-1 language code (e.g.: en for English). Can be nil.

• country (String): ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code for countries (e.g.: GRB or GB for "Great Britain"). Can be nil.

• currency (String): ISO 4217 code for currencies (e.g.: USD for "US Dollars"). Can be nil.

Payment Details Field

Aside from the basic Field attributes, the payment details field PaymentDetailsField also implements the following:

• account_number (String): number of an account, expressed as a string. Can be nil.

• iban (String): International Bank Account Number. Can be nil.

• routing_number (String): routing number of an account. Can be nil.

• swift (String): the account holder's bank's SWIFT Business Identifier Code (BIC). Can be nil.

String Field

The text field StringField only has one constraint: it's value is a String (or nil).

Taxes Field

Tax

Aside from the basic Field attributes, the tax field TaxField also implements the following:

• rate (Float): the tax rate applied to an item can be expressed as a percentage. Can be nil.

• code (String): tax code (or equivalent, depending on the origin of the document). Can be nil.

• base (Float): base amount used for the tax. Can be nil.

• value (Float): the value of the tax. Can be nil.

Currently TaxField is not used on its own, and is accessed through a parent Taxes 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 to_s 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 present on the document.

A FinancialDocumentV1LineItem implements the following attributes:

• description (String): The item description.

• product_code (String): The product code referring to the item.

• quantity (Float): The item quantity

• tax_amount (Float): The item tax amount.

• tax_rate (Float): The item tax rate in percentage.

• total_amount (Float): The item total amount.

• unit_measure (String): The item unit of measure.

• unit_price (Float): The item unit price.

Attributes

The following fields are extracted for Financial Document V1:

Billing Address

billing_address (AddressField): The customer's address used for billing.

puts result.document.inference.prediction.billing_address.value

Purchase Category

category (ClassificationField): The purchase category.

Possible values include:

• 'toll'

• 'food'

• 'parking'

• 'transport'

• 'accommodation'

• 'gasoline'

• 'telecom'

• 'miscellaneous'

• 'software'

• 'shopping'

• 'energy'

puts result.document.inference.prediction.category.value

Customer Address

customer_address (AddressField): The address of the customer.

puts result.document.inference.prediction.customer_address.value

Customer Company Registrations

customer_company_registrations (Array<CompanyRegistrationField>): List of company registration numbers associated to the customer.

result.document.inference.prediction.customer_company_registrations do |customer_company_registrations_elem|
  puts customer_company_registrations_elem.value
end

Customer ID

customer_id (StringField): The customer account number or identifier from the supplier.

puts result.document.inference.prediction.customer_id.value

Customer Name

customer_name (StringField): The name of the customer.

puts result.document.inference.prediction.customer_name.value

Purchase Date

date (DateField): The date the purchase was made.

puts result.document.inference.prediction.date.value

Document Number

document_number (StringField): The document number or identifier (invoice number or receipt number).

puts result.document.inference.prediction.document_number.value

Document Type

document_type (ClassificationField): The type of the document: INVOICE or CREDIT NOTE if it is an invoice, CREDIT CARD RECEIPT or EXPENSE RECEIPT if it is a receipt.

Possible values include:

• 'INVOICE'

• 'CREDIT NOTE'

• 'CREDIT CARD RECEIPT'

• 'EXPENSE RECEIPT'

• 'OTHER'

puts result.document.inference.prediction.document_type.value

Document Type Extended

document_type_extended (ClassificationField): Document type extended.

Possible values include:

• 'CREDIT NOTE'

• 'INVOICE'

• 'OTHER'

• 'OTHER_FINANCIAL'

• 'PAYSLIP'

• 'PURCHASE ORDER'

• 'QUOTE'

• 'RECEIPT'

• 'STATEMENT'

puts result.document.inference.prediction.document_type_extended.value

Due Date

due_date (DateField): The date on which the payment is due.

puts result.document.inference.prediction.due_date.value

Invoice Number

invoice_number (StringField): The invoice number or identifier only if document is an invoice.

puts result.document.inference.prediction.invoice_number.value

Line Items

line_items (Array<FinancialDocumentV1LineItem>): List of line item present on the document.

result.document.inference.prediction.line_items do |line_items_elem|
  puts line_items_elem.value
end

Locale

locale (LocaleField): The locale of the document.

puts result.document.inference.prediction.locale.value

Payment Date

payment_date (DateField): The date on which the payment is due / fullfilled.

puts result.document.inference.prediction.payment_date.value

Purchase Order Number

po_number (StringField): The purchase order number, only if the document is an invoice.

puts result.document.inference.prediction.po_number.value

Receipt Number

receipt_number (StringField): The receipt number or identifier only if document is a receipt.

puts result.document.inference.prediction.receipt_number.value

Reference Numbers

reference_numbers (Array<StringField>): List of Reference numbers, including PO number, only if the document is an invoice.

result.document.inference.prediction.reference_numbers do |reference_numbers_elem|
  puts reference_numbers_elem.value
end

Shipping Address

shipping_address (AddressField): The customer's address used for shipping.

puts result.document.inference.prediction.shipping_address.value

Purchase Subcategory

subcategory (ClassificationField): The purchase subcategory for transport, food and shooping.

Possible values include:

• 'plane'

• 'taxi'

• 'train'

• 'restaurant'

• 'shopping'

• 'other'

• 'groceries'

• 'cultural'

• 'electronics'

• 'office_supplies'

• 'micromobility'

• 'car_rental'

• 'public'

• 'delivery'

• nil

puts result.document.inference.prediction.subcategory.value

Supplier Address

supplier_address (AddressField): The address of the supplier or merchant.

puts result.document.inference.prediction.supplier_address.value

Supplier Company Registrations

supplier_company_registrations (Array<CompanyRegistrationField>): List of company registration numbers associated to the supplier.

result.document.inference.prediction.supplier_company_registrations do |supplier_company_registrations_elem|
  puts supplier_company_registrations_elem.value
end

Supplier Email

supplier_email (StringField): The email of the supplier or merchant.

puts result.document.inference.prediction.supplier_email.value

Supplier Name

supplier_name (StringField): The name of the supplier or merchant.

puts result.document.inference.prediction.supplier_name.value

Supplier Payment Details

supplier_payment_details (Array<PaymentDetailsField>): List of payment details associated to the supplier (only for invoices).

result.document.inference.prediction.supplier_payment_details do |supplier_payment_details_elem|
  puts supplier_payment_details_elem.value
  puts supplier_payment_details_elem.rate
  puts supplier_payment_details_elem.code
  puts supplier_payment_details_elem.basis
end

Supplier Phone Number

supplier_phone_number (StringField): The phone number of the supplier or merchant.

puts result.document.inference.prediction.supplier_phone_number.value

Supplier Website

supplier_website (StringField): The website URL of the supplier or merchant.

puts result.document.inference.prediction.supplier_website.value

Taxes

taxes (Array<TaxField>): List of all taxes on the document.

result.document.inference.prediction.taxes do |taxes_elem|
  puts taxes_elem.value
end

Purchase Time

time (StringField): The time the purchase was made (only for receipts).

puts result.document.inference.prediction.time.value

Tip and Gratuity

tip (AmountField): The total amount of tip and gratuity

puts result.document.inference.prediction.tip.value

Total Amount

total_amount (AmountField): The total amount paid: includes taxes, tips, fees, and other charges.

puts result.document.inference.prediction.total_amount.value

Total Net

total_net (AmountField): The net amount paid: does not include taxes, fees, and discounts.

puts result.document.inference.prediction.total_net.value

Total Tax

total_tax (AmountField): The sum of all taxes present on the document.

puts result.document.inference.prediction.total_tax.value