Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

@cityssm/bill-data-extract

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@cityssm/bill-data-extract

Extracts data from scanned bill documents into usable details.


Version published
Maintainers
1
Created

Bill Data Extract

npm (scoped) DeepSource

Extract data from scanned bill documents into usable details.

Supported Bills

Installation

npm install @cityssm/bill-data-extract

Usage

import { extractEnbridgeBillData } from '@cityssm/bill-data-extract/enbridge.js'

const billData = await extractEnbridgeBillData('path/to/enbridgeBill.pdf')

console.log(billData)

/*
  {
    accountNumber: '123456789012',
    serviceAddress: '123 FAKE ST BIG CITY ON G4S 0I0',
    dueDate: 'May 04, 2024',
    gasUsage: 139,
    gasUsageUnit: 'm3',
    totalAmountDue: 60.35
  } 
*/

How Does It Work?

Enbridge Bill Sample

The extractor takes a bill as input, either as an image or as a PDF. "Zones" are identified within the bill to identify where the key details are. Using tesseract.js on those zones, data is extracted and returned as a Javascript object.

💡 Note that while scanned copies of bills are oftentimes supported, the best source is a bill downloaded directly from the utility company.

FAQs

Package last updated on 10 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts