Financial Parser

post https://api.edenai.run/v2/ocr/financial_parser

Available Providers

Provider	Model	Version	Document Type	Price	Billing unit
affinda	-	`v3`	`invoice`	0.08 (per 1 page)	1 page
affinda	-	`v3`	`receipt`	0.07 (per 1 page)	1 page
amazon	-	`boto3 1.26.8`	-	0.01 (per 1 page)	1 page
base64	-	`latest`	-	0.25 (per 1 page)	1 page
google	-	`DocumentAI v1 beta3`	`invoice`	0.01 (per 1 page)	10 page
google	-	`DocumentAI v1 beta3`	`receipt`	0.01 (per 1 page)	10 page
klippa	-	`v1`	-	0.1 (per 1 file)	1 file
microsoft	-	`rest API 4.0 (2024-02-29-preview)`	-	0.01 (per 1 page)	1 page
mindee	-	`v1.2`	-	0.1 (per 1 page)	1 page
tabscanner	-	`latest`	-	0.08 (per 1 page)	1 page
veryfi	-	`v8`	`receipt`	0.08 (per 1 file)	1 file
veryfi	-	`v8`	`invoice`	0.16 (per 1 file)	1 file
eagledoc	-	`v1`	-	0.03 (per 1 page)	1 page
extracta	-	`v1`	-	0.1 (per 1 page)	1 page
openai	-	`v1.0`	-	0.04 (per 1 page)	1 page
openai	gpt-4o	`v1.0`	-	0.04 (per 1 page)	1 page
openai	gpt-4o-mini	`v1.0`	-	0.002 (per 1 page)	1 page
openai	gpt-4-turbo	`v1.0`	-	0.1 (per 1 page)	1 page
openai	gpt-3.5-turbo	`v1.0`	-	0.008 (per 1 page)	1 page

Supported Languages

Name	Value
Afrikaans	`af`
Albanian	`sq`
Amharic	`am`
Arabic	`ar`
Armenian	`hy`
Azerbaijani	`az`
Basque	`eu`
Belarusian	`be`
Bengali	`bn`
Bosnian	`bs`
Bulgarian	`bg`
Burmese	`my`
Catalan	`ca`
Cebuano	`ceb`
Chinese	`zh`
Corsican	`co`
Croatian	`hr`
Czech	`cs`
Danish	`da`
Dutch	`nl`
English	`en`
Esperanto	`eo`
Estonian	`et`
Finnish	`fi`
French	`fr`
Galician	`gl`
Georgian	`ka`
German	`de`
Gujarati	`gu`
Haitian	`ht`
Hausa	`ha`
Hawaiian	`haw`
Hebrew	`he`
Hindi	`hi`
Hmong	`hmn`
Hungarian	`hu`
Icelandic	`is`
Igbo	`ig`
Indonesian	`id`
Irish	`ga`
Italian	`it`
Japanese	`ja`
Javanese	`jv`
Kannada	`kn`
Kazakh	`kk`
Khmer	`km`
Kinyarwanda	`rw`
Kirghiz	`ky`
Korean	`ko`
Kurdish	`ku`
Lao	`lo`
Latin	`la`
Latvian	`lv`
Lithuanian	`lt`
Luxembourgish	`lb`
Macedonian	`mk`
Malagasy	`mg`
Malay (macrolanguage)	`ms`
Malayalam	`ml`
Maltese	`mt`
Maori	`mi`
Marathi	`mr`
Modern Greek (1453-)	`el`
Mongolian	`mn`
Nepali (macrolanguage)	`ne`
Norwegian	`no`
Nyanja	`ny`
Oriya (macrolanguage)	`or`
Panjabi	`pa`
Persian	`fa`
Polish	`pl`
Portuguese	`pt`
Pushto	`ps`
Romanian	`ro`
Russian	`ru`
Samoan	`sm`
Scottish Gaelic	`gd`
Serbian	`sr`
Shona	`sn`
Sindhi	`sd`
Sinhala	`si`
Slovak	`sk`
Slovenian	`sl`
Somali	`so`
Southern Sotho	`st`
Spanish	`es`
Sundanese	`su`
Swahili (macrolanguage)	`sw`
Swedish	`sv`
Tagalog	`tl`
Tajik	`tg`
Tamil	`ta`
Tatar	`tt`
Telugu	`te`
Thai	`th`
Turkish	`tr`
Turkmen	`tk`
Uighur	`ug`
Ukrainian	`uk`
Urdu	`ur`
Uzbek	`uz`
Vietnamese	`vi`
Welsh	`cy`
Western Frisian	`fy`
Xhosa	`xh`
Yiddish	`yi`
Yoruba	`yo`
Zulu	`zu`

Supported Detailed Languages

Name	Value
Auto detection	`auto-detect`
Catalan (Spain)	`ca-ES`
Chinese (China)	`zh-CN`
Chinese (China)	`zh-cn`
Chinese (Taiwan)	`zh-TW`
Chinese (Taiwan)	`zh-tw`
Danish (Denmark)	`da-DK`
Dutch (Netherlands)	`nl-NL`
English (United Kingdom)	`en-GB`
English (United States)	`en-US`
French (Canada)	`fr-CA`
French (France)	`fr-FR`
French (Switzerland)	`fr-CH`
German (Germany)	`de-DE`
German (Switzerland)	`de-CH`
Italian (Italy)	`it-IT`
Italian (Switzerland)	`it-CH`
Portuguese (Portugal)	`pt-PT`
Spanish (Spain)	`es-ES`

Supported Models

Default Models

Name	Value
openai	`gpt-4o`

Body Params

settings

string

Defaults to [object Object]

A dictionnary or a json object to specify specific models to use for some providers.
It can be in the following format: {"google" : "google_model", "ibm": "ibm_model"...}.

providers

array of strings

required

It can be one (ex: 'amazon' or 'google') or multiple provider(s) (ex: 'amazon,microsoft,google') that the data will be redirected to in order to get the processed results.
Providers can also be invoked with specific models (ex: providers: 'amazon/model1, amazon/model2, google/model3')

providers*

fallback_providers

array of strings

length ≤ 5

Defaults to

Providers in this list will be used as fallback if the call to provider in providers parameter fails.
To use this feature, you must input only one provider in the providers parameter. but you can put up to 5 fallbacks.

They will be tried in the same order they are input, and it will stop to the first provider who doesn't fail.

Doesn't work with async subfeatures.

fallback_providers

response_as_dict

boolean

Defaults to true

Optional : When set to true (default), the response is an object of responses with providers names as keys :

{"google" : { "status": "success", ... }, }

When set to false the response structure is a list of response objects :

[{"status": "success", "provider": "google" ... }, ].

attributes_as_list

boolean

Defaults to false

Optional : When set to false (default) the structure of the extracted items is list of objects having different attributes :

{'items': [{"attribute_1": "x1","attribute_2": "y2"}, ... ]}

When it is set to true, the response contains an object with each attribute as a list :

{ "attribute_1": ["x1","x2", ...], "attribute_2": [y1, y2, ...]}

show_base_64

boolean

Defaults to true

show_original_response

boolean

Defaults to false

Optional : Shows the original response of the provider.

When set to true, a new attribute original_response will appear in the response object.

file

File to analyse in binary format to be used with content-type: multipart/form-data
Does not work with application/json !

file_url

uri | null

File URL to analyse to be used with with content-type: application/json.

file_password

string | null

If your PDF file has a password, you can pass it here!

language

string | null

Language code of the language the document is written in (ex: fr (French), en (English), es (Spanish))

document_type

string

Defaults to invoice

auto-detect - auto-detect
invoice - invoice
receipt - receipt

convert_to_pdf

boolean | null

Defaults to false

Boolean value to specify weather to convert the doc/docx files to pdf format to be accepted by a majority of the providers

Responses

Response body

object

klippa

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

eagledoc

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

affinda

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

openai

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

mindee

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

microsoft

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

base64

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

tabscanner

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

amazon

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

dataleon

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

extracta

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

google

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

veryfi

object

extracted_data

array of objects

List of parsed financial data objects (per page).

Extracted Data

object

customer_information

object

required

merchant_information

object

required

payment_information

object

required

financial_document_information

object

required

local

object

required

bank

object

required

item_lines

array of objects

List of line items associated with the document.

Item Lines

object

tax

integer

Defaults to null

Tax amount for the line item.

amount_line

integer

Defaults to null

Total amount for the line item.

description

string

Defaults to null

Description of the line item.

quantity

integer

Defaults to null

Quantity of units for the line item.

unit_price

integer

Defaults to null

Unit price for each unit in the line item.

unit_type

string

Defaults to null

Type of unit (e.g., hours, items).

date

string

Defaults to null

Date associated with the line item.

product_code

string

Defaults to null

Product code or identifier for the line item.

purchase_order

string

Defaults to null

Purchase order related to the line item.

tax_rate

integer

Defaults to null

Tax rate applied to the line item.

base_total

integer

Defaults to null

Base total amount before any discounts or taxes.

sub_total

integer

Defaults to null

Subtotal amount for the line item.

discount_amount

integer

Defaults to null

Amount of discount applied to the line item.

discount_rate

integer

Defaults to null

Rate of discount applied to the line item.

discount_code

string

Defaults to null

Code associated with any discount applied to the line item.

order_number

string

Defaults to null

Order number associated with the line item.

title

string

Defaults to null

Title or name of the line item.

document_metadata

object

required

original_response

string

Defaults to null

original response sent by the provider, hidden by default, show it by passing the show_original_response field to true in your request

status

string

required

sucess fail

Language

Credentials

Bearer

JWT


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.edenai.run/v2/ocr/financial_parser \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "response_as_dict": true,
8
  "attributes_as_list": false,
9
  "show_base_64": true,
10
  "show_original_response": false,
11
  "document_type": "invoice",
12
  "convert_to_pdf": false
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400

403

404

500