Package Exports

mindee
mindee/mindee/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mindee) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

API SDK for Node.js

Installation

Requirements

The SDK is officially supported on Node.js LTS active and maintenance versions.

From source code

Download and decompress or clone the source code from GitHub and then do in your Node.js project:

npm install mindee

Usage

You can use the SDK easily by creating a Client like this:

const { Client } = require("mindee");

const mindeeClient = new Client({
  invoiceToken: "invoiceApiToken",
  receiptToken: "receiptExpenseApiToken",
});

mindeeClient.invoice.parse({ input: "path/to/file", inputType: "file" });
mindeeClient.receipt.parse({ input: base64String, inputType: "base64" });
mindeeClient.financialDocument.parse({
  input: base64String,
  inputType: "base64",
});

Three apis are actually supported : invoice (ìnvoice), receipt (receipt) and financial document (financialDocument)

You can find more examples on how to use the SDK into the folder examples.

Client

The Mindee client can take multiple parameters to be initialize. Some this parameters can also be set with env variables. If the env variable and the parameter are both set, the parameter will be the one chosen by the client. This is a list of them:

invoiceToken (env variable : MINDEE_INVOICE_TOKEN) The expense api token
receiptToken (env variable : MINDEE_RECEIPT_TOKEN) The invoice api token
throwOnError (true by default) If true, the SDK will throw on error
debug (env variable : MINDEE_DEBUG, false by default) If true, logging will be in debug mode

Depending on what type of document you want to parse, you need to add specifics auth token for each endpoint. We suggest storing your credentials as environment variables for security reasons.

Parsing Invoices

const { Client } = require("mindee");
const fs = require("fs");

// Invoice token can be set by Env (MINDEE_INVOICE_TOKEN) or via params (Client({invoiceToken: "token"}))
const mindeeClient = new Client();

// parsing invoice from pdf
mindeeClient.invoice
  .parse({ input: "./documents/invoices/invoice.pdf" }) // see examples for more input types
  .then((res) => {
    console.log("Success !");
    console.log(res.invoices);
    console.log(res.invoice);
  })
  .catch((err) => {
    console.error(err);
  });

Parsing receipts

const { Client } = require("mindee");
const fs = require("fs");

// Receipt token can be set by Env (MINDEE_RECEIPT_TOKEN) or via params (Client({receiptToken: "token"}))
const mindeeClient = new Client();

// parsing receipt from picture
mindeeClient.receipt
  .parse({ input: "./documents/receipts/receipt.jpg" }) // see examples for more input types
  .then((res) => {
    console.log("Success !");
    console.log(res.receipts);
    console.log(res.receipt);
  })
  .catch((err) => {
    console.error(err);
  });

Parsing a mix of invoices and receipts: Financial document

The Financial document API optimizes the parsing results when you don't know if your file is a receipt or an invoice.

const { Client } = require("mindee");

// Invoice token and Receipt token must be set
// Receipt token can be set by Env (MINDEE_RECEIPT_TOKEN) or via params (Client({receiptToken: "token"}))
// Invoice token can be set by Env (MINDEE_INVOICE_TOKEN) or via params (Client({invoiceToken: "token"}))

const mindeeClient = new Client();

// parsing receipt from picture
mindeeClient.financialDocument
  .parse({ input: "./documents/receipts/receipt.jpg" })
  .then((res) => {
    console.log("Success !");
    console.log(res.financialDocuments);
    console.log(res.financialDocument);
  })
  .catch((err) => {
    console.error(err);
  });

Tests

To run the tests, use the command npm run test

Documentation

A basic documentation of the sdk has been done with the help of JSDoc. If you want to generate it, you can use the command npm run documentation. A folder docs will be created with generated documentation. Open the index.html in your browser to read the documentation.