Invoice

The PHP SDK supports the Mindee V1 Invoice API.

Product Specifications

Specification

Details

Endpoint Name

invoices

Recommended Version

v4.11

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

<?php

use Mindee\Client;
use Mindee\Product\Invoice\InvoiceV4;

// Init a new client
$mindeeClient = new Client("my-api-key");

// Load a file from disk
$inputSource = $mindeeClient->sourceFromPath("/path/to/the/file.ext");

// Parse the file
$apiResponse = $mindeeClient->parse(InvoiceV4::class, $inputSource);

echo $apiResponse->document;

You can also call this product asynchronously:

<?php

use Mindee\Client;
use Mindee\Product\Invoice\InvoiceV4;

// Init a new client
$mindeeClient = new Client("my-api-key");

// Load a file from disk
$inputSource = $mindeeClient->sourceFromPath("/path/to/the/file.ext");

// Parse the file asynchronously
$apiResponse = $mindeeClient->enqueueAndParse(InvoiceV4::class, $inputSource);

echo $apiResponse->document;

Sample Output (rST)

########
Document
########
:Mindee ID: 744748d5-9051-461c-b70c-bbf81f5ff943
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/invoices v4.11
:Rotation applied: Yes

Prediction
==========
:Locale: en-CA; en; CA; CAD;
:Invoice Number: 14
:Purchase Order Number: AD29094
:Reference Numbers: AD29094
:Purchase Date: 2018-09-25
:Due Date:
:Payment Date:
:Total Net: 2145.00
:Total Amount: 2608.20
:Total Tax: 193.20
:Taxes:
  +---------------+--------+----------+---------------+
  | Base          | Code   | Rate (%) | Amount        |
  +===============+========+==========+===============+
  | 2145.00       |        | 8.00     | 193.20        |
  +---------------+--------+----------+---------------+
:Supplier Payment Details:
:Supplier Name: TURNPIKE DESIGNS
:Supplier Company Registrations:
:Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
:Supplier Phone Number: 4165551212
:Supplier Website:
:Supplier Email: [email protected]
:Customer Name: JIRO DOI
:Customer Company Registrations:
:Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
:Customer ID:
:Shipping Address:
:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
:Document Type: INVOICE
:Document Type Extended: INVOICE
:Purchase Subcategory:
:Purchase Category: miscellaneous
:Line Items:
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
  +======================================+==============+==========+============+==============+==============+=================+============+
  | Platinum web hosting package Down... |              | 1.00     |            |              | 65.00        |                 | 65.00      |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | 2 page website design Includes ba... |              | 3.00     |            |              | 2100.00      |                 | 2100.00    |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | Mobile designs Includes responsiv... |              | 1.00     |            |              | 250.00       | 1               | 250.00     |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+

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

Page 0
------
:Locale: en-CA; en; CA; CAD;
:Invoice Number: 14
:Purchase Order Number: AD29094
:Reference Numbers: AD29094
:Purchase Date: 2018-09-25
:Due Date:
:Payment Date:
:Total Net: 2145.00
:Total Amount: 2608.20
:Total Tax: 193.20
:Taxes:
  +---------------+--------+----------+---------------+
  | Base          | Code   | Rate (%) | Amount        |
  +===============+========+==========+===============+
  | 2145.00       |        | 8.00     | 193.20        |
  +---------------+--------+----------+---------------+
:Supplier Payment Details:
:Supplier Name: TURNPIKE DESIGNS
:Supplier Company Registrations:
:Supplier Address: 156 University Ave, Toronto ON, Canada, M5H 2H7
:Supplier Phone Number: 4165551212
:Supplier Website:
:Supplier Email: [email protected]
:Customer Name: JIRO DOI
:Customer Company Registrations:
:Customer Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
:Customer ID:
:Shipping Address:
:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
:Document Type: INVOICE
:Document Type Extended: INVOICE
:Purchase Subcategory:
:Purchase Category: miscellaneous
:Line Items:
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | Description                          | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
  +======================================+==============+==========+============+==============+==============+=================+============+
  | Platinum web hosting package Down... |              | 1.00     |            |              | 65.00        |                 | 65.00      |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | 2 page website design Includes ba... |              | 3.00     |            |              | 2100.00      |                 | 2100.00    |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
  | Mobile designs Includes responsiv... |              | 1.00     |            |              | 250.00       | 1               | 250.00     |
  +--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+

Field Types

Standard Fields

These fields are generic and used in several products.

BaseField

Each prediction object contains a set of fields that inherit from the generic BaseField class. A typical BaseField object will have the following attributes:

value (float|string): corresponds to the field value. Can be null if no value was extracted.
confidence (float): 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 (integer): the ID of the page, always null when at document-level.
reconstructed (bool): indicates whether an object was reconstructed (not extracted as the API gave it).

A Point simply refers to a list of two numbers ([float, float]).

Aside from the previous attributes, all basic fields have access to a custom __toString 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:

streetNumber (?string): String representation of the street number. Can be null.
streetName (?string): Name of the street. Can be null.
poBox (?string): String representation of the PO Box number. Can be null.
addressComplement (?string): Address complement. Can be null.
city (?string): City name. Can be null.
postalCode (?string): String representation of the postal code. Can be null.
state (?string): State name. Can be null.
country (?string): Country name. Can be null.

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

AmountField

The amount field AmountField only has one constraint: its value is an optional ?float.

ClassificationField

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

A classification field's value is always a string.

CompanyRegistrationField

Aside from the basic BaseField attributes, the company registration field CompanyRegistrationField also implements the following:

type (string): the type of company.

DateField

Aside from the basic BaseField attributes, the date field DateField also implements the following:

dateObject (date): an accessible representation of the value as a php object. Can be null.

LocaleField

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

language (string): ISO 639-1 language code (e.g.: en for English). Can be null.
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 null.
currency (string): ISO 4217 code for currencies (e.g.: USD for "US Dollars"). Can be null.

PaymentDetailsField

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

accountNumber (string): number of an account, expressed as a string. Can be null.
iban (string): International Bank Account Number. Can be null.
routingNumber (string): routing number of an account. Can be null.
swift (string): the account holder's bank's SWIFT Business Identifier Code (BIC). Can be null.

StringField

The text field StringField implements the following:

value (string): represents the value of the field as a string.
rawValue (string): the value of the string as it appears on the document.

TaxesField

Tax

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

rate (float): the tax rate applied to an item expressed as a percentage. Can be null.
code (string): tax code (or equivalent, depending on the origin of the document). Can be null.
basis (float): base amount used for the tax. Can be null.
value (float): the value of the tax. Can be null.

Currently TaxField is not used on its own, and is accessed through a parent Taxes object, a list-like structure.

Taxes (Array)

The Taxes field represents a list-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 all the line items present on the invoice.

A InvoiceV4LineItem implements the following attributes:

description (string): The item description.
productCode (string): The product code of the item.
quantity (float): The item quantity
taxAmount (float): The item tax amount.
taxRate (float): The item tax rate in percentage.
totalAmount (float): The item total amount.
unitMeasure (string): The item unit of measure.
unitPrice (float): The item unit price.

Attributes

The following fields are extracted for Invoice V4:

Billing Address

billingAddress : The customer billing address.

echo $result->document->inference->prediction->billingAddress->value;

Purchase Category

category : The purchase category.

Possible values include:

'toll'
'food'
'parking'
'transport'
'accommodation'
'telecom'
'miscellaneous'
'software'
'shopping'
'energy'

echo $result->document->inference->prediction->category->value;

Customer Address

customerAddress : The address of the customer.

echo $result->document->inference->prediction->customerAddress->value;

Customer Company Registrations

customerCompanyRegistrations : List of company registration numbers associated to the customer.

foreach ($result->document->inference->prediction->customerCompanyRegistrations as $customerCompanyRegistrationsElem)
{
    echo $customerCompanyRegistrationsElem->value;
}

Customer ID

customerId : The customer account number or identifier from the supplier.

echo $result->document->inference->prediction->customerId->value;

Customer Name

customerName : The name of the customer or client.

echo $result->document->inference->prediction->customerName->value;

Purchase Date

date : The date the purchase was made.

echo $result->document->inference->prediction->date->value;

Document Type

documentType : Document type: INVOICE or CREDIT NOTE.

Possible values include:

'INVOICE'
'CREDIT NOTE'

echo $result->document->inference->prediction->documentType->value;

Document Type Extended

documentTypeExtended : Document type extended.

Possible values include:

'CREDIT NOTE'
'INVOICE'
'OTHER'
'OTHER_FINANCIAL'
'PAYSLIP'
'PURCHASE ORDER'
'QUOTE'
'RECEIPT'
'STATEMENT'

echo $result->document->inference->prediction->documentTypeExtended->value;

Due Date

dueDate : The date on which the payment is due.

echo $result->document->inference->prediction->dueDate->value;

Invoice Number

invoiceNumber : The invoice number or identifier.

echo $result->document->inference->prediction->invoiceNumber->value;

Line Items

lineItems ([InvoiceV4LineItem]): List of all the line items present on the invoice.

foreach ($result->document->inference->prediction->lineItems as $lineItemsElem)
{
    echo $lineItemsElem->value;
}

Locale

locale : The locale of the document.

echo $result->document->inference->prediction->locale->value;

Payment Date

paymentDate : The date on which the payment is due / was full-filled.

echo $result->document->inference->prediction->paymentDate->value;

Purchase Order Number

poNumber : The purchase order number.

echo $result->document->inference->prediction->poNumber->value;

Reference Numbers

referenceNumbers : List of all reference numbers on the invoice, including the purchase order number.

foreach ($result->document->inference->prediction->referenceNumbers as $referenceNumbersElem)
{
    echo $referenceNumbersElem->value;
}

Shipping Address

shippingAddress : Customer's delivery address.

echo $result->document->inference->prediction->shippingAddress->value;

Purchase Subcategory

subcategory : The purchase subcategory for transport, food and shopping.

Possible values include:

'plane'
'taxi'
'train'
'restaurant'
'shopping'
'other'
'groceries'
'cultural'
'electronics'
'office_supplies'
'micromobility'
'car_rental'
'public'
'delivery'
null

echo $result->document->inference->prediction->subcategory->value;

Supplier Address

supplierAddress : The address of the supplier or merchant.

echo $result->document->inference->prediction->supplierAddress->value;

Supplier Company Registrations

supplierCompanyRegistrations : List of company registration numbers associated to the supplier.

foreach ($result->document->inference->prediction->supplierCompanyRegistrations as $supplierCompanyRegistrationsElem)
{
    echo $supplierCompanyRegistrationsElem->value;
}

Supplier Email

supplierEmail : The email address of the supplier or merchant.

echo $result->document->inference->prediction->supplierEmail->value;

Supplier Name

supplierName : The name of the supplier or merchant.

echo $result->document->inference->prediction->supplierName->value;

Supplier Payment Details

supplierPaymentDetails : List of payment details associated to the supplier of the invoice.

foreach ($result->document->inference->prediction->supplierPaymentDetails as $supplierPaymentDetailsElem)
{
    echo $supplierPaymentDetailsElem->value;
    echo $supplierPaymentDetailsElem->rate;
    echo $supplierPaymentDetailsElem->code;
    echo $supplierPaymentDetailsElem->basis;
}

Supplier Phone Number

supplierPhoneNumber : The phone number of the supplier or merchant.

echo $result->document->inference->prediction->supplierPhoneNumber->value;

Supplier Website

supplierWebsite : The website URL of the supplier or merchant.

echo $result->document->inference->prediction->supplierWebsite->value;

Taxes

taxes : List of taxes. Each item contains the detail of the tax.

foreach ($result->document->inference->prediction->taxes as $taxesElem)
{
    echo $taxesElem->value;
}

Total Amount

totalAmount : The total amount of the invoice: includes taxes, tips, fees, and other charges.

echo $result->document->inference->prediction->totalAmount->value;

Total Net

totalNet : The net amount of the invoice: does not include taxes, fees, and discounts.

echo $result->document->inference->prediction->totalNet->value;

Total Tax

totalTax : The total tax: the sum of all the taxes for this invoice.

echo $result->document->inference->prediction->totalTax->value;

PreviousFinancial Document NextReceipt

Last updated 1 month ago

Was this helpful?

Good night

Invoice

Product Specifications

Quick-Start

Sample Code

Sample Output (rST)

Field Types

Standard Fields

BaseField

AddressField

AmountField

ClassificationField

CompanyRegistrationField

DateField

LocaleField

PaymentDetailsField

StringField

TaxesField

Specific Fields

Line Items Field

Attributes

Billing Address

Purchase Category

Customer Address

Customer Company Registrations

Customer ID

Customer Name

Purchase Date

Document Type

Document Type Extended

Due Date

Invoice Number

Line Items

Locale

Payment Date

Purchase Order Number

Reference Numbers

Shipping Address

Purchase Subcategory

Supplier Address

Supplier Company Registrations

Supplier Email

Supplier Name

Supplier Payment Details

Supplier Phone Number

Supplier Website

Taxes

Total Amount

Total Net

Total Tax