Skip to content

Commit 98c4ba4

Browse files
sebastianMindeesebastianMindee
authored
✨ add support for financial document v1.14, US healthcare cards v1.3 & invoice v4.11 (#188)
1 parent 5761398 commit 98c4ba4

29 files changed

+191
-114
lines changed

‎docs/global_products/expense_receipts_v5.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Receipt API](https://platform.mindee.com/m
1212
> | Specification | Details |
1313
> | ------------------------------ | -------------------------------------------------- |
1414
> | Endpoint Name | `expense_receipts` |
15-
> | Recommended Version | `v5.3` |
15+
> | Recommended Version | `v5.4` |
1616
> | Supports Polling/Webhooks | ✔️ Yes |
1717
> | Support Synchronous HTTP Calls | ✔️ Yes |
1818
> | Geography | 🌐 Global |
@@ -264,6 +264,9 @@ The following fields are extracted for Receipt V5:
264264
- 'gasoline'
265265
- 'telecom'
266266
- 'miscellaneous'
267+
- 'software'
268+
- 'shopping'
269+
- 'energy'
267270

268271
```rb
269272
puts result.document.inference.prediction.category.value
@@ -319,6 +322,15 @@ puts result.document.inference.prediction.receipt_number.value
319322
- 'train'
320323
- 'restaurant'
321324
- 'shopping'
325+
- 'other'
326+
- 'groceries'
327+
- 'cultural'
328+
- 'electronics'
329+
- 'office_supplies'
330+
- 'micromobility'
331+
- 'car_rental'
332+
- 'public'
333+
- 'delivery'
322334
- nil
323335

324336
```rb

‎docs/global_products/financial_document_v1.md‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Financial Document API](https://platform.m
1212
> | Specification | Details |
1313
> | ------------------------------ | -------------------------------------------------- |
1414
> | Endpoint Name | `financial_document` |
15-
> | Recommended Version | `v1.12` |
15+
> | Recommended Version | `v1.14` |
1616
> | Supports Polling/Webhooks | ✔️ Yes |
1717
> | Support Synchronous HTTP Calls | ✔️ Yes |
1818
> | Geography | 🌐 Global |
@@ -93,12 +93,12 @@ puts result.document
9393
########
9494
Document
9595
########
96-
:Mindee ID: a80ac0ee-26f6-4e2e-988a-960b240d5ba7
96+
:Mindee ID: 6dd26385-719b-4527-bf6f-87d9da619de5
9797
:Filename: default_sample.jpg
9898
9999
Inference
100100
#########
101-
:Product: mindee/financial_document v1.11
101+
:Product: mindee/financial_document v1.14
102102
:Rotation applied: Yes
103103
104104
Prediction
@@ -134,6 +134,7 @@ Prediction
134134
:Shipping Address: 2019 Redbud Drive New York, NY 10011
135135
:Billing Address: 4312 Wood Road New York, NY 10031
136136
:Document Type: INVOICE
137+
:Document Type Extended: INVOICE
137138
:Purchase Subcategory:
138139
:Purchase Category: miscellaneous
139140
:Total Tax: 9.75
@@ -186,6 +187,7 @@ Page 0
186187
:Shipping Address: 2019 Redbud Drive New York, NY 10011
187188
:Billing Address: 4312 Wood Road New York, NY 10031
188189
:Document Type: INVOICE
190+
:Document Type Extended: INVOICE
189191
:Purchase Subcategory:
190192
:Purchase Category: miscellaneous
191193
:Total Tax: 9.75
@@ -309,7 +311,7 @@ puts result.document.inference.prediction.billing_address.value
309311
```
310312

311313
## Purchase Category
312-
**category** ([ClassificationField](#classification-field)): The purchase category, only for receipts.
314+
**category** ([ClassificationField](#classification-field)): The purchase category.
313315

314316
#### Possible values include:
315317
- 'toll'
@@ -320,6 +322,9 @@ puts result.document.inference.prediction.billing_address.value
320322
- 'gasoline'
321323
- 'telecom'
322324
- 'miscellaneous'
325+
- 'software'
326+
- 'shopping'
327+
- 'energy'
323328

324329
```rb
325330
puts result.document.inference.prediction.category.value
@@ -468,14 +473,23 @@ puts result.document.inference.prediction.shipping_address.value
468473
```
469474

470475
## Purchase Subcategory
471-
**subcategory** ([ClassificationField](#classification-field)): The purchase subcategory for transport and food, only for receipts.
476+
**subcategory** ([ClassificationField](#classification-field)): The purchase subcategory for transport, food and shooping.
472477

473478
#### Possible values include:
474479
- 'plane'
475480
- 'taxi'
476481
- 'train'
477482
- 'restaurant'
478483
- 'shopping'
484+
- 'other'
485+
- 'groceries'
486+
- 'cultural'
487+
- 'electronics'
488+
- 'office_supplies'
489+
- 'micromobility'
490+
- 'car_rental'
491+
- 'public'
492+
- 'delivery'
479493
- nil
480494

481495
```rb

‎docs/global_products/international_id_v2.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Ruby Client Library supports the [International ID API](https://platform.min
1212
> | Specification | Details |
1313
> | ------------------------------ | -------------------------------------------------- |
1414
> | Endpoint Name | `international_id` |
15-
> | Recommended Version | `v2.1` |
15+
> | Recommended Version | `v2.2` |
1616
> | Supports Polling/Webhooks | ✔️ Yes |
1717
> | Support Synchronous HTTP Calls | ❌ No |
1818
> | Geography | 🌐 Global |

‎docs/global_products/invoice_splitter_v1.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Invoice Splitter API](https://platform.min
1212
> | Specification | Details |
1313
> | ------------------------------ | -------------------------------------------------- |
1414
> | Endpoint Name | `invoice_splitter` |
15-
> | Recommended Version | `v1.2` |
15+
> | Recommended Version | `v1.4` |
1616
> | Supports Polling/Webhooks | ✔️ Yes |
1717
> | Support Synchronous HTTP Calls | ❌ No |
1818
> | Geography | 🌐 Global |

‎docs/global_products/invoices_v4.md‎

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The Ruby Client Library supports the [Invoice API](https://platform.mindee.com/m
1212
> | Specification | Details |
1313
> | ------------------------------ | -------------------------------------------------- |
1414
> | Endpoint Name | `invoices` |
15-
> | Recommended Version | `v4.10` |
15+
> | Recommended Version | `v4.11` |
1616
> | Supports Polling/Webhooks | ✔️ Yes |
1717
> | Support Synchronous HTTP Calls | ✔️ Yes |
1818
> | Geography | 🌐 Global |
@@ -93,12 +93,12 @@ puts result.document
9393
########
9494
Document
9595
########
96-
:Mindee ID: b55db8f9-ae3b-4f05-b2f1-ec0ced5e5b70
96+
:Mindee ID: 744748d5-9051-461c-b70c-bbf81f5ff943
9797
:Filename: default_sample.jpg
9898
9999
Inference
100100
#########
101-
:Product: mindee/invoices v4.9
101+
:Product: mindee/invoices v4.11
102102
:Rotation applied: Yes
103103
104104
Prediction
@@ -133,6 +133,9 @@ Prediction
133133
:Shipping Address:
134134
:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
135135
:Document Type: INVOICE
136+
:Document Type Extended: INVOICE
137+
:Purchase Subcategory:
138+
:Purchase Category: miscellaneous
136139
:Line Items:
137140
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
138141
| Description | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
@@ -179,6 +182,9 @@ Page 0
179182
:Shipping Address:
180183
:Billing Address: 1954 Bloor Street West Toronto, ON, M6P 3K9 Canada
181184
:Document Type: INVOICE
185+
:Document Type Extended: INVOICE
186+
:Purchase Subcategory:
187+
:Purchase Category: miscellaneous
182188
:Line Items:
183189
+--------------------------------------+--------------+----------+------------+--------------+--------------+-----------------+------------+
184190
| Description | Product code | Quantity | Tax Amount | Tax Rate (%) | Total Amount | Unit of measure | Unit Price |
@@ -296,6 +302,25 @@ The following fields are extracted for Invoice V4:
296302
puts result.document.inference.prediction.billing_address.value
297303
```
298304

305+
## Purchase Category
306+
**category** ([ClassificationField](#classification-field)): The purchase category.
307+
308+
#### Possible values include:
309+
- 'toll'
310+
- 'food'
311+
- 'parking'
312+
- 'transport'
313+
- 'accommodation'
314+
- 'telecom'
315+
- 'miscellaneous'
316+
- 'software'
317+
- 'shopping'
318+
- 'energy'
319+
320+
```rb
321+
puts result.document.inference.prediction.category.value
322+
```
323+
299324
## Customer Address
300325
**customer_address** ([StringField](#string-field)): The address of the customer.
301326

@@ -422,6 +447,30 @@ end
422447
puts result.document.inference.prediction.shipping_address.value
423448
```
424449

450+
## Purchase Subcategory
451+
**subcategory** ([ClassificationField](#classification-field)): The purchase subcategory for transport, food and shopping.
452+
453+
#### Possible values include:
454+
- 'plane'
455+
- 'taxi'
456+
- 'train'
457+
- 'restaurant'
458+
- 'shopping'
459+
- 'other'
460+
- 'groceries'
461+
- 'cultural'
462+
- 'electronics'
463+
- 'office_supplies'
464+
- 'micromobility'
465+
- 'car_rental'
466+
- 'public'
467+
- 'delivery'
468+
- nil
469+
470+
```rb
471+
puts result.document.inference.prediction.subcategory.value
472+
```
473+
425474
## Supplier Address
426475
**supplier_address** ([StringField](#string-field)): The address of the supplier or merchant.
427476

‎docs/localized_products/energy_bill_fra_v1.md‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -63,58 +63,58 @@ puts result.document
6363
########
6464
Document
6565
########
66-
:Mindee ID: 17f0ccef-e3fe-4a28-838d-d704489d6ce7
66+
:Mindee ID: ff1f2ca8-4d29-44d8-a564-599a982a4ef7
6767
:Filename: default_sample.pdf
6868
6969
Inference
7070
#########
71-
:Product: mindee/energy_bill_fra v1.0
72-
:Rotation applied: No
71+
:Product: mindee/energy_bill_fra v1.2
72+
:Rotation applied: Yes
7373
7474
Prediction
7575
==========
76-
:Invoice Number: 10123590373
77-
:Contract ID: 1234567890
76+
:Invoice Number: 1234567890
77+
:Contract ID: 9876543210
7878
:Delivery Point: 98765432109876
7979
:Invoice Date: 2021-01-29
8080
:Due Date: 2021-02-15
8181
:Total Before Taxes: 1241.03
8282
:Total Taxes: 238.82
8383
:Total Amount: 1479.85
8484
:Energy Supplier:
85-
:Address: TSA 12345, 12345 DEMOCITY CEDEX, 75001 PARIS
85+
:Address: TSA 12345, 12345 DEMOCITY CEDEX
8686
:Name: EDF
8787
:Energy Consumer:
88-
:Address: 12 AVENUE DES RÊVES, RDC A 123 COUR FAUSSE A, 75000 PARIS
89-
:Name: John Doe
88+
:Address: 123 RUE DE L'IMAGINAIRE, 75001 PARIS
89+
:Name: JOHN DOE
9090
:Subscription:
9191
+--------------------------------------+------------+------------+----------+-----------+------------+
9292
| Description | End Date | Start Date | Tax Rate | Total | Unit Price |
9393
+======================================+============+============+==========+===========+============+
9494
| Abonnement électricité | 2021-02-28 | 2021-01-01 | 5.50 | 59.00 | 29.50 |
9595
+--------------------------------------+------------+------------+----------+-----------+------------+
9696
:Energy Usage:
97-
+--------------------------------------+------------+------------+----------+-----------+------------+
98-
| Description | End Date | Start Date | Tax Rate | Total | Unit Price |
99-
+======================================+============+============+==========+===========+============+
100-
| Consommation (HT) | 2021-01-27 | 2020-11-28 | 20.00 | 898.43 | 10.47 |
101-
+--------------------------------------+------------+------------+----------+-----------+------------+
97+
+-------------+--------------------------------------+------------+------------+----------+-----------+-----------------+------------+
98+
| Consumption | Description | End Date | Start Date | Tax Rate | Total | Unit of Measure | Unit Price |
99+
+=============+======================================+============+============+==========+===========+=================+============+
100+
| 8581.00 | Consommation électricité | 2021-01-27 | 2020-11-28 | 20.00 | 898.43 | kWh | 0.1047 |
101+
+-------------+--------------------------------------+------------+------------+----------+-----------+-----------------+------------+
102102
:Taxes and Contributions:
103103
+--------------------------------------+------------+------------+----------+-----------+------------+
104104
| Description | End Date | Start Date | Tax Rate | Total | Unit Price |
105105
+======================================+============+============+==========+===========+============+
106-
| Contribution au Service Public de... | 2021-01-27 | 2020-11-28 | 20.00 | 193.07 | 2.25 |
106+
| Contribution au Service Public de... | 2021-01-27 | 2020-11-28 | 20.00 | 193.07 | 0.0225 |
107107
+--------------------------------------+------------+------------+----------+-----------+------------+
108-
| Départementale sur la Conso Final... | 2020-12-31 | 2020-11-28 | 20.00 | 13.98 | 0.3315 |
108+
| Taxe Départementale sur la Conso ... | 2021-01-27 | 2020-11-28 | 20.00 | 13.98 | 0.003315 |
109109
+--------------------------------------+------------+------------+----------+-----------+------------+
110-
| Communale sur la Conso Finale Ele... | 2021-01-27 | 2021-01-01 | 20.00 | 28.56 | 0.6545 |
110+
| Taxe Communale sur la Conso Final... | 2021-01-27 | 2020-11-28 | 20.00 | 28.56 | 0.006545 |
111111
+--------------------------------------+------------+------------+----------+-----------+------------+
112-
| Contribution Tarifaire d'Achemine... | 2020-12-31 | 2020-11-28 | 20.00 | 27.96 | 0.663 |
112+
| Taxe Communale sur la Conso Final... | 2021-01-27 | 2020-11-28 | 20.00 | 27.96 | 0.00663 |
113113
+--------------------------------------+------------+------------+----------+-----------+------------+
114114
:Meter Details:
115115
:Meter Number: 620
116116
:Meter Type: electricity
117-
:Unit of Measure: kWh
117+
:Unit of Power: 36kVA
118118
```
119119

120120
# Field Types

‎docs/localized_products/ind_passport_v1.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Document
6868
6969
Inference
7070
#########
71-
:Product: mindee/ind_passport v1.0
71+
:Product: mindee/ind_passport v1.2
7272
:Rotation applied: Yes
7373
7474
Prediction
@@ -91,10 +91,10 @@ Prediction
9191
:Name of Mother:
9292
:Old Passport Date of Issue:
9393
:Old Passport Number:
94+
:Old Passport Place of Issue:
9495
:Address Line 1:
9596
:Address Line 2:
9697
:Address Line 3:
97-
:Old Passport Place of Issue:
9898
:File Number:
9999
```
100100

0 commit comments

Comments
 (0)