invoicer aka InvoiceBot

Creates, stores and sends invoices.

Description

• admin uploads CSV file with invoices to administration Slack channel
• bot reads the file, responds with confirm/cancel buttons and links to download invoice in PDF or Pohoda XML file for every user
• if admin confirms, bot creates PDF invoices according to the input data and stores them on Google drive
  • bot creates folder for every user and (if enabled) folder for every year
• (if enabled) bot sends direct message on Slack to user with a link to PDF invoice on the Google drive
• bot responds to admin with list of users for which generating of invoice failed

Configuration

• bots_config - there can be multiple bots configured to operate in different slack channels. Configuration of bots are separated by ;. Each bot configuration consists of these values separated by ,:
  • channel ID - administration Slack channel ID for the bot (where input CSV files are uploaded)
  • storage root folder - name of Google drive root folder where all invoices will be stored. Can be path with separator /
  • storage user folder - name of Google drive user folder where invoices of specific user are stored. This folder will be shared with the user. The name will be prepended with <storage-root-folder>/<user-name> and (if enabled) subfolders by year containing the invoices. Can be path with separator /
  • admin emails - list of admin emails separated by +. Root folder will be shared with these emails. Optionally can contain also type of account (user, group) and role (reader, writer, owner, commenter). Example: fero@vacuumlabs.com:user:reader+finance@vacuumlabs.com:group:owner. Default type: user, default role: reader. Only one admin can be owner
  • sendOnSlack - 0/1 - send notification to invoice recipient on slack
  • groupByYear - 0/1 - group invoices on gdrive by year
  • companyDrive (optional) - vl, or nothing (defaults to vl). Switches Google service account used. (Not used yet.)
• slack_bot_token - bot user OAuth token from Slack app - menu Install App
• slack_bot_signing_secret - bot signing secret from Slack app - menu Basic Information
• pohoda_import_id - import ID used in generated Pohoda XML file
• host - URL where the app is deployed

Google service account

Google API service account is needed to enable comunication with Google sheets. You need to enable Google Drive API.

Different workspaces (companies) may use different service accounts. Currently, separate env vars may be added for each.

• google_vl_email - email of VL service account
• google_vl_key - base64 encoded private key of VL service account (including the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY-----)

Misc

• NODE_ENV (optional, default - development)
• log_level (optional, default - debug if NODE_ENV is development, error otherwise) - winston level of logs that are written
• PORT - port number where server starts, provided by Heroku automatically

Local server

You'll need to make your server reachable from outside world - you can use ngrok or similar services.

Run ngrok (this actually runs ngrok http 8000):

$ yarn ngrok

After that, copy your ngrok url into the Slack app's Interactivity & Shortcuts and Event Subscriptions configuration as Request URL, e.g. https://cb47f7c1.ngrok.io/actions - don't forget the <url>/actions route or <url>/events respectively.

Run the server:

$ yarn dev

You should be able to create and send invoices through your InvoiceBot instance now.

Production environment

App is deployed to Heroku https://dashboard.heroku.com/apps/vacuumlabs-invoicebot . Every merge to master is automatically deployed to production.

Slack app: InvoiceBot