https://github.com/koblers/paperless-to-lexoffice
A simple Docker/Python script that syncs paperless documents with lexoffice based on paperless-ngx tags
https://github.com/koblers/paperless-to-lexoffice
lexoffice paperless paperless-ngx pdf python sync upload
Last synced: about 2 months ago
JSON representation
A simple Docker/Python script that syncs paperless documents with lexoffice based on paperless-ngx tags
- Host: GitHub
- URL: https://github.com/koblers/paperless-to-lexoffice
- Owner: KoblerS
- License: mit
- Created: 2025-08-20T20:09:24.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-08-22T08:17:53.000Z (about 2 months ago)
- Last Synced: 2025-08-30T20:49:32.283Z (about 2 months ago)
- Topics: lexoffice, paperless, paperless-ngx, pdf, python, sync, upload
- Language: Python
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# paperless-to-lexoffice
A synchronization tool that allows you to automatically sync selected documents from **paperless-ngx** into **lexoffice**.
The sync is **unidirectional** (paperless-ngx ➝ lexoffice).
---
## 🚀 Features
- Sync documents from paperless-ngx to lexoffice automatically.
- Tag-based workflow:
- Documents in the **inbox tag** are monitored.
- Adding the **lexoffice tag** triggers synchronization.
- Add voucher preview URL as custom field.
- Runs in Docker for easy setup.
---
## 📋 Prerequisites
Before running this service, prepare the following:
- A running **paperless-ngx** instance.
- A **paperless-ngx API token** (the user must have the rights to view documents and edit tags).
- A **lexoffice username and password** (API usage is included in all lexoffice plans ✅).
- Two tags in paperless-ngx:
- **Inbox Tag** → marks incoming documents.
- **Lexoffice Tag** → marks documents that should be synced, this tag will be removed afterwards to sign successful sync.
---
## ⚙️ Installation
1. Clone the repository and navigate into it.
2. Go to the `docker` directory.
3. Copy and edit the `docker-compose.env` file:
- Add your tokens, URLs, and tag IDs.
4. Start the container:
```bash
docker-compose up -d
## 🔧 Environment Variables
You can configure the service with the following environment variables in `docker/docker-compose.env`:
### Polling
```ini
POLLING_INTERVAL=60
```
Interval in seconds to check for new documents.
### Paperless-ngx settings
```ini
PAPERLESS_TOKEN="TOKEN" # Your paperless-ngx API token
PAPERLESS_URL="http://192.168.0.5:8000" # URL of your paperless-ngx instance
INBOX_TAG_ID=1 # This is the id to your inbox Tag, this tag stays persistent
LEXOFFICE_TAG_ID=42 # This is the id to your lexoffice Tag, this tag will be removed after successful sync
```
### Lexoffice settings
```ini
LEXOFFICE_USERNAME="adalovelace" # Your lexoffice username
LEXOFFICE_PASSWORD="ilovecookies" # Your lexoffice password
```
## ⚠️ Limitations
- This tool is still in an early development stage.
- It has mainly been tested in personal document management setups.
- Feedback, bug reports, and contributions are very welcome!
## 📄 Example docker-compose.yml
```yaml
version: "3.8"
services:
paperless-to-lexoffice:
image: ghcr.io/koblers/paperless-to-lexoffice:latest
env_file:
- docker-compose.env
restart: unless-stopped
```
## 🎛️ Available parameters
These are the available parameters set as environment variables:
| Parameter | Description | Default | Required |
| ----------------------------- | --------------------------------------------------------------------------------------------------------- | ------- | -------- |
| `PAPERLESS_TOKEN` | Enter your paperless-ngx token here | | x |
| `PAPERLESS_URL` | Change this to your paperless-ngx server URL | | x |
| `INBOX_TAG_ID` | Change this to your inbox Tag ID, this is the tag that should be persistent | | x |
| `LEXOFFICE_TAG_ID` | Change this to your lexoffice Tag ID, this is the tag that gets removed after successfull synchronisation | | x |
| `LEXOFFICE_USERNAME` | Enter your lexoffice username here | | x |
| `LEXOFFICE_PASSWORD` | Enter your lexoffice password here | | x |
| `POLLING_INTERVAL` | How often should the sync job check for new documents (in seconds) | `60` | o |
| `CUSTOM_FIELD_ID_PREVIEW_URL` | Specifies the custom field id to set the voucher preview URL | | o |
| `DEFAULT_TIMEOUT` | Timeout until when requestss to APIs will timeout (in seconds) | `10` | o |