README

`roo-invoice-parser`

A parser for food delivery courier invoices.

We are the IWGB

We're a new and dynamic independent trade union. From our roots representing migrant workers, we’ve evolved to taking on the bosses of the so-called gig economy and government regulators, representing under-unionised and under-represented workforces.

iwgb.org.uk · Donate

A project of the IWGB & ITF in co-operation.

Install

In an NPM project

npm i @iwgb/roo-invoice-parser

Globally on your device

npm i -g @iwgb/roo-invoice-parser

Usage

Parsing

Returns data as parsed from the invoice. The invoice hash is calculated from the name on the invoice and the shifts billed.

import { parseInvoice } from 'roo-invoice-parser';

const invoice = await parseInvoice(pdfData, locale, timezone);

console.log(invoice);

[
    {
        "name": "Sample Text",
        "start": "2021-07-13T00:00:00.000+01:00",
        "end": "2021-07-14T23:59:59.999+01:00",
        "shifts": [
            {
                "start": "2021-07-13T19:00:00.000+01:00",
                "end": "2021-07-13T21:09:00.000+01:00",
                "orders": 5,
                "pay": 2243
            }
        ],
        "adjustments": [
            {
                "label": "Tips",
                "amount": 300
            },
            {
                "label": "Transaction fee",
                "amount": -50
            }
        ],
        "error": "",
        "currency": "GBP",
        "locale": "en-GB",
        "hash": "d805386e7dd4b8888a6ed1362a9e05e7976899dd"
    }
]

Timestamps are returned as instances of the Luxon DateTime (the package is a peer dependency). All currency amounts are given in lowest currency denomination: for example, for EUR, all are in cents).

Parameter	Default	Description
`pdfData`	Required	The PDF data, as a raw string or TypedArray
`locale`	Attempts to detect	The market locale of the invoice. The parser only supports certain market locales - see below.
`timezone`	Capital of locale country	The identifier for the timezone that the work was performed in. The parser will interpret timestamps on the PDF as being in this timezone.

Processing

Group invoice data by week and month.

Provide invoice data in the format above, as returned by the parser. Timestamps should be ISO strings, or instances of the Luxon DateTime.

import { processInvoices } from 'roo-invoice-parser';

const data = await processInvoices(invoices);

console.log(data);

[
  {
    "start": "2020-07-01T00:00:00.000+01:00",
    "weeks": [
      {
        "monday": "2020-07-19T00:00:00.000+01:00",
        "shifts": [
          {
            "start": "2020-07-20T15:52:00.000+01:00",
            "end": "2020-07-20T19:02:00.000+01:00",
            "orders": 7,
            "pay": 3321,
            "hours": 3.17
          }
        ],
        "adjustments": [
          {
            "label": "Tips",
            "amount": 400
          }
        ],
        "totals": {
          "hours": 3.17,
          "orders": 7,
          "pay": 3321,
          "adjustments": 400
        }
      }
    ]
  }
]

CLI

rooparse /path/to/pdf/or/folder/of/pdfs -t Australia/Darwin -l en-AU

Flag	Default	Description
`-l --locale`	Attempts to detect	The market locale of the invoice. The parser only supports certain market locales - see below.
`-t --timezone`	Capital of locale country	The identifier for the timezone that the work was performed in. The parser will interpret timestamps on the PDF as being in this timezone.
`-o --output`		If given, writes to the specified file (otherwise, to stdout).
`-w --weeks`		If given, formats the output in weeks (see processing above)

Markets

Currently supported markets:

Australia, en-AU
Belgium, en-BE
France, fr-FR
Ireland, en-IE
Netherlands, en-NL & nl-NL
United Kingdom, en-GB

We're always expanding the markets the parser works in. If you'd like to add support for a new market, raise a PR and we'll get in touch so you can securely provide us with your test data.

Licensing

You're free to use this software for your own non-commercial purposes, as a member of the rider community or otherwise. If you share the work, you must do so in the same manner, give appropriate credit and indicate your changes (if any). For more details, see the license in LICENSE.

This summary is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

If this doesn't suit your requirements, get in touch with us.

Usage no npm install needed!