Skip to content

EPIC-08: Paperless-ngx Document Integration #8

@steilerDev

Description

@steilerDev

Epic: Paperless-ngx Document Integration

Epic ID: EPIC-08
Priority: Must Have
Sprint Suggestion: Sprint 4

Description

Implement the integration with Paperless-ngx for document management. The application does not store documents locally; instead, it references documents stored in a Paperless-ngx instance. This epic covers linking Paperless-ngx documents to work items and household items, fetching and displaying document metadata and thumbnails via the Paperless-ngx API, and leveraging the Paperless-ngx tagging system. The connection configuration (API endpoint, auth token) is set up in EPIC-02.

Requirements Coverage

  • Section 2.2: Document Integration (Paperless-ngx)
    • Link to documents stored in Paperless-ngx
    • Reference Paperless-ngx document IDs
    • Display documents inline via Paperless-ngx API
    • Leverage Paperless-ngx tagging system
    • No local document storage
  • Section 2.1: Work Items - Additional Features
    • Document links (references to Paperless-ngx documents)
  • Section 2.3: Household Items - Document Links (Paperless-ngx)
    • Link to receipts in Paperless-ngx
    • Link to invoices in Paperless-ngx
    • Link to warranty documents in Paperless-ngx
    • Link to product photos and manuals in Paperless-ngx
    • Display linked documents inline
  • Section 3.2 (first): Paperless-ngx Integration
    • Work items and household items reference Paperless-ngx document IDs
    • Fetch document metadata and thumbnails via Paperless-ngx API
    • Use Paperless-ngx's tagging for organization
  • Section 4: User Stories - Work Items
    • Link Paperless-ngx documents to work items to view related receipts and contracts
  • Section 4: User Stories - Budget
    • Link invoices and receipts from Paperless-ngx for proof of payment
  • Section 4: User Stories - Household Items
    • Link purchase receipts and warranties from Paperless-ngx
  • Section 5: Key Decisions
    • Integration with Paperless-ngx (no built-in document storage)

Dependencies

  • EPIC-02: Application Shell & Infrastructure (Paperless-ngx connection config)
  • EPIC-03: Work Items Core CRUD (work items must exist to link documents)
  • EPIC-04: Household Items Management (household items must exist to link documents)
  • EPIC-05: Budget Management (vendor invoices need document links)

Goals

  • Browse and search Paperless-ngx documents from within the application
  • Link Paperless-ngx documents to work items (receipts, contracts, plans)
  • Link Paperless-ngx documents to household items (receipts, invoices, warranties, manuals)
  • Link Paperless-ngx documents to vendor invoices/payments
  • Display document metadata (title, date, tags) inline
  • Display document thumbnails/previews inline via Paperless-ngx API
  • Leverage Paperless-ngx tagging system for document organization
  • Unlink documents from entities

Metadata

Metadata

Assignees

No one assigned

    Labels

    epicEpic - large feature areapriority: must haveMoSCoW: Must Havesprint-4Sprint 4 - Household Items & Integration

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions