INVOICE-EXTRACTOR

INTRODUCTION

Helping company accounting teams quickly extract and export information from multiple invoices at once and dump the data into a CSV file.

PROJECT REQUIREMENTS

• The code must be reusable.
• It must be able to read PDF files.
• We should be able to specify the format of the information we want to extract.
• It must rename the files using relevant information from the document to allow quick identification.
• It must extract the information and create a CSV file with it.

LANGUAGE

The source code is developed in TypeScript. However, you can modify it as you wish to work with the language you're most comfortable with.

PREREQUISITES AND DEPENDENCIES

• Node.js >= 16
• npm >=
• CommonJS (pdf-parse does not work properly with ESM)
• fs module
• TypeScript
• pdf-parse
• @types/node

SET UP

Setting up a new project is quite simple with the invoice-extractor CLI. With npm installed, you can create a new invoice-extractor project with the following commands in your OS terminal:

npx invoice-extractor init

GETTING STARTED

1. Create your project folder and navigate into it.

2. Run the following command in terminal:

   npx invoice-extractor init

[!IMPORTANT] Don't forget to install your project's dependencies.

npm install

3. Create as many scripts as needed based on the number of vendors you have.

4. Modify the object you’ll pass as an argument according to the invoice’s structure and how the information appears — keep in mind that pdf-parse returns the content line by line.

5. Adjust the regex for each value you need to extract.

6. Modify the JSON structure based on the vendor, or add new ones if necessary.

[!IMPORTANT] Remember that for each new TypeScript file you create, you need to run the command npm run build to generate its corresponding JavaScript file in the ./dist folder..

7. Place your supplier's invoices in the 'pdfs' folder. Remember that invoices from different suppliers must not be mixed. Therefore, to use the script, only the invoices from that specific supplier should be in the folder (Delete the .gitignore file).

8. Run the script and pick up the csv document in the folder "result".

LICENSE

MIT License

Copyright (C) 2025 Miguel Angel Quintero

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

KEYWORDS

fs, invoice, pdf-parse, csv, pdf

LINKS