📄 Paperless Gateway

Unlock and upload password-protected bank statements to Paperless-ngx

📤 Upload PDF Files

Drag and drop multiple PDF files or click to select

Drop PDF files here or click to browse

Multiple files supported

👥 Manage Clients

Configure clients for automatic owner detection. The match pattern (account number) is searched in PDFs.

Color Name Match Pattern Synced Actions

No clients configured yet. Click "Add Client" to get started.

🔑 Password Manager

Manage your password list for unlocking PDFs (one password per line)

📖 User Guide

Learn how to use the Paperless Gateway Middleware

🚀 Getting Started

This application helps you unlock password-protected bank statement PDFs, automatically rename them with client information and billing period, and upload them directly to your Paperless-ngx instance.

📋 Step 1: Set Up Passwords

  1. Go to the Passwords tab
  2. Add all your bank statement passwords (one per line)
  3. Common formats include: DOB (DDMMYYYY), PAN numbers, custom bank passwords
  4. Click Save Passwords

👥 Step 2: Configure Clients

  1. Go to the Manage Clients tab
  2. Click + Add Client
  3. Enter the client's name (e.g., "Rahul Sharma")
  4. Enter a Match Pattern - this is typically the account number or a unique identifier found in their statements
  5. Choose a tag color for easy identification in Paperless
  6. Click Save Client
💡 Tip: Open a bank statement PDF, find a unique identifier like the last 6 digits of the account number, and use that as the match pattern.

🔄 Step 3: Sync to Paperless

  1. After adding clients, click Sync to Paperless
  2. This creates tags (e.g., "Client: Rahul Sharma") in your Paperless instance
  3. It also creates a "Bank" correspondent for all bank statements
  4. The sync status shows whether each client's tag was created

📤 Step 4: Upload PDFs

  1. Go to the Upload tab
  2. Drag and drop your PDF files (or click to browse)
  3. You can upload multiple files at once
  4. Click Process & Upload Files

⚙️ What Happens During Processing

  1. Unlock: Each PDF is decrypted using your password list
  2. Identify Client: The PDF text is searched for client match patterns
  3. Extract Period: The billing month/year is extracted from the statement
  4. Rename: File is renamed to ClientName_YYYY-MM.pdf
  5. Upload: Sent to Paperless with the client's tag and "Bank" correspondent attached

📁 File Naming Format

Files are automatically renamed using this format:

{ClientName}_{Year}-{Month}.pdf

Example: Rahul_Sharma_2024-03.pdf

❓ Troubleshooting

PDF won't unlock?

Make sure the correct password is in your password list. Try different formats (with/without spaces, uppercase).

Wrong client detected?

Check your match patterns. Make sure they're unique to each client. Use longer patterns if needed.

Upload failed?

Verify your Paperless-ngx instance is accessible and the API token is valid.

Wrong date extracted?

The app looks for statement dates, billing periods, or the latest date in the document. Manual renaming in Paperless may be needed for unusual formats.

🔗 Integration with Paperless-ngx

This app integrates with Paperless-ngx using the following:

  • API Endpoint: /api/documents/post_document/
  • Tags: Created as "Client: {Name}" with your chosen color
  • Correspondent: All uploads use "Bank" as the correspondent
  • Workflows: Documents arrive pre-tagged, triggering your Paperless workflows immediately