> For the complete documentation index, see [llms.txt](https://imbrace.gitbook.io/imbrace-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://imbrace.gitbook.io/imbrace-documentation/integrations/mindee/mindee-api.md).

# Mindee API

the Mindee node returns a subset of the fields returned from the Mindee API.

## Expense Receipt

The Mindee node returns a JSON object with the following fields for a receipt prediction:

<table><thead><tr><th width="193.33333333333331">Field</th><th width="318">Description</th><th>Notes</th></tr></thead><tbody><tr><td>id: string</td><td>UUID for the API request.</td><td></td></tr><tr><td>name: string</td><td>Document name.</td><td></td></tr><tr><td>number_of_pages: number</td><td>If using a PDF document with multiple pages, returns the number of pages processed by the Mindee API.</td><td>Single images will return a value of 1 for this field.</td></tr><tr><td>category: string</td><td>The receipt category among 8 predefined classes.</td><td>toll, food, parking, transport, accommodation, gasoline, telecom, miscellaneous.<br><br>The class 'telecom' will only be supported in the future.</td></tr><tr><td>date: string</td><td>Purchase date on the receipt given as an ISO date yyyy-mm-dd. Works for both European and US date formats.</td><td></td></tr><tr><td>currency: string</td><td>ISO 4217 code among 44 predefined currencies.</td><td>AED, ARS, AUD, BRL, CAD, CHF, CLP, CNY, COP, CZK, DKK, DZD, EUR, GBP, HKD, HUF, IDR, ILS, INR, JPY, KRW, MAD, MXN, MYR, NOK, OMR, PHP, PLN, QAR, RON, RUB, SAR, SEK, SGD, THB, TND, TRY, TWD, USD, VND, XAF, XOF, XPF, ZAR</td></tr><tr><td>locale: string</td><td>Two-letter language code (ISO 639-1) followed by two-letter country code (ISO 3166-1 alpha-2).</td><td></td></tr><tr><td>supplier: string</td><td>Name of the receipt supplier.</td><td></td></tr><tr><td>taxes: object</td><td></td><td></td></tr><tr><td>    rate: number</td><td>The tax rate in percentage.</td><td>12% tax rate is given as a value of 12, not 0.12</td></tr><tr><td>time: string</td><td>Time of purchase with 24 hour formatting (hh:mm).</td><td></td></tr><tr><td>total_incl: number</td><td>The total amount paid including taxes, discounts, fees, tips and gratuity.</td><td></td></tr></tbody></table>

## Invoice

The Mindee node returns a JSON object with the following fields for an invoice prediction:

<table><thead><tr><th width="192.66666666666666">Field</th><th width="319">Description</th><th>Notes</th></tr></thead><tbody><tr><td>id: string</td><td>UUID for the API request.</td><td></td></tr><tr><td>name: string</td><td>Document name.</td><td></td></tr><tr><td>number_of_pages: number</td><td>If using a PDF document with multiple pages, returns the number of pages processed by the Mindee API.</td><td>Single images will return a value of 1 for this field.</td></tr><tr><td>customer: string</td><td>Name of customer.</td><td></td></tr><tr><td>customer_address: string</td><td>Address of customer.</td><td></td></tr><tr><td>date: string</td><td>Purchase date given as an ISO date yyyy-mm-dd. Works for both European and US date formats.</td><td></td></tr><tr><td>document_type: string</td><td>Type of document.</td><td>Beta field, currently only returns either 'INVOICE' or 'CREDIT NOTE'.</td></tr><tr><td>due_date: string</td><td>Due date given as an ISO date yyyy-mm-dd. Works for both European and US date formats.</td><td></td></tr><tr><td>invoice_number: string</td><td>Invoice number.</td><td></td></tr><tr><td>currency: string</td><td>ISO 4217 code among 22 predefined currencies.</td><td>AED, AUD, BRL, CAD, CHF, CNY, COP, CZK, DKK, EUR, GBP, GNF, HKD, HUF, JPY, NOK, NZD, PLN, SEK, SGD, USD, XPF</td></tr><tr><td>supplier: string</td><td>Name of  supplier.</td><td></td></tr><tr><td>supplier_address: string</td><td>Address of supplier.</td><td></td></tr><tr><td>taxes: object</td><td></td><td></td></tr><tr><td>    rate: number</td><td>The tax rate in percentage.</td><td>12% tax rate is given as a value of 12, not 0.12</td></tr><tr><td>total_excl: number</td><td>The total amount to be paid without taxes.</td><td></td></tr><tr><td>total_incl: number</td><td>The total amount to be paid.</td><td></td></tr></tbody></table>