Skip to content

lippoliv/paperlessngx-to-sevdesk

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PaperlessNGX to sevDesk

Simplify and streamline your document management with the PaperlessNGX to sevDesk application. This lightweight and efficient tool automates the transfer of files from PaperlessNGX to sevDesk, seamlessly integrating your document workflow. This application ensures that your expense documents are accurately recorded and available in sevDesk.

Configuring the application is straightforward using environment variables. The flexibility of the configuration empowers you to customize the application according to your document categorization preferences.

Installation is a breeze with Docker Compose, and the provided example clearly guides you through the setup process. The application's continuous loop ensures that it consistently monitors for new documents, providing a hands-free solution to keep your sevDesk account up-to-date. Take control of your document management, save time, and ensure accuracy with the PaperlessNGX to sevDesk application.

Configuration

The following environment variables are used for configuration

Name Description
RUN_INTERVAL Optional: How often to scan for new files (default: 300)
PAPERLESSNGX_URL Optional: The PaperlessNGX url (e.g. https://paperle.ss)
PAPERLESSNGX_TOKEN Optional: The PaperlessNGX token to be used for fetching new files
PAPERLESSNGX_FILTER_TAG_ID Optional: The PaperlessNGX tag (ID) to filter documents for
PAPERLESSNGX_FILTER_DOCUMENT_TYPE_ID Optional: The PaperlessNGX document type (ID) to filter documents for
PAPERLESSNGX_WEBHOOK_PORT Optional: Port to listen for PaperlessNGX webhooks (disabled if unset)
SEVDESK_TOKEN The sevDesk token to be used for uploading files

You need to either specify PAPERLESSNGX_URL and PAPERLESSNGX_TOKEN or PAPERLESSNGX_WEBHOOK_PORT (see below).

Polling vs. Webhooks

You can either poll for new documents (see RUN_INTERVAL) or you can use PaperlessNGX Webhooks (see PAPERLESSNGX_WEBHOOK_PORT) which is more efficient.

Polling

As long as you don't configure PAPERLESSNGX_WEBHOOK_PORT, the tool will use polling to check for new documents. You can controll the intervall using RUN_INTERVAL.

Webhooks

PaperlessNGX supports webhooks. Once you define PAPERLESSNGX_WEBHOOK_PORT, the tool will be ready to be used with webhooks. You can configure a webhook action like this:

  • Webhook-URL: Configure the endpoint of this tool, e.g. http://my-pc:3000.
  • Webhook payload as JSON: Should be disabled.
  • Include document: Must be enabled.

Important: Whatever document will be sent to this endpoint, will be uploaded to sevDesk.

Installation

You can easily run this as a docker compose project:

services:
  worker:
    image: lippertsweb/paperlessngx-to-sevdesk:latest
    restart: unless-stopped
    environment:
      # You PaperlessNGX url (e.g. "https://paperle.ss" or "http://192.168.0.1:8080")
      PAPERLESSNGX_URL: "..."

      # You can get your PaperlessNGX token by clicking your icon (top-right on the screen) and select "Profile"
      PAPERLESSNGX_TOKEN: "..."

      # Optional: The tag to filter for (can help to seperate private and busines documents)
      # PAPERLESSNGX_FILTER_TAG_ID: 7

      # Optional: The document type id to filter for (probably you just want invoices to be uploaded)
      # PAPERLESSNGX_FILTER_DOCUMENT_TYPE_ID: 1

      # Optional: Port to listen for PaperlessNGX webhooks (disabled if unset)
      # PAPERLESSNGX_WEBHOOK_PORT: 3000

      # You can get token from user management screen (https://my.sevdesk.de/admin/userManagement)
      SEVDESK_TOKEN: "..."

      # Optional: Run all five minutes (5 minutes * 60 seconds = 300 seconds)
      # RUN_INTERVAL: 300

Thanks

Many thanks to the PaperlessNGX team for the hard work and the nice and stable open source project :)

About

Simplify and streamline your document management with the PaperlessNGX to sevDesk application.

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •