Backend Documentation

This folder contains developer-facing documentation for the Nest.js backend of the mithras-crm monorepo.

All files here follow the conventions defined in docs/technical-documentation-standard.md.

Core Entities

• client.md — Client lifecycle, CRUD, SharePoint folders, meetings
• lead.md — Lead management, follow-up, conversion to clients
• company.md — Insurance partners, employers, contact persons
• user.md — User profiles, roles, authentication entry points

Client Sub-Modules

• client-agenda.md — Agenda items, birthday reminders, calendar integration
• client-tasks.md — Tasks with status, priority, email notifications
• client-notes.md — Text notes per client
• client-invoices.md — Invoice creation, PDF generation, payment reminders
• client-contact-person.md — Contact persons with SharePoint folder creation
• client-health-insurances-kvg.md — Client KVG records with PDF export
• client-health-insurances-vvg.md — Client VVG records with PDF export
• client-collective-life.md — Client collective life records with PDF export
• client-pension-funds.md — Client pension fund records
• client-investments.md — Client investments with file uploads

Insurance Products

• health-insurances-kvg.md — KVG (mandatory) product definitions
• health-insurances-vvg.md — VVG (supplementary) product definitions
• health-insurance-region.md — Regional data for premium calculations
• collective-life.md — Collective life product definitions
• pension-fund.md — Pension fund product definitions
• partner-products.md — Vorsorge products with commission tracking
• product-property.md — Property insurance (household, liability, legal protection)

Investments & Finance

• investments.md — Investment product definitions
• retirement-investment.md — Retirement pillar (3a/3b) investments
• property-assets.md — Property asset records for insurance
• commission.md — Commission data with file uploads

Tax

• tax-data.md — Tax records, uploads, consultations
• tax-uploads.md — Tax upload tracking
• late-tax-uploads.md — Late tax document management

Integrations

• sharepoint.md — File and folder management in SharePoint
• microsoft-graph.md — Microsoft 365 calendar and meeting integration

Cross-Cutting Concerns

• auth.md — Auth0 JWT authentication, guards, CASL role-based permissions
• configuration.md — Environment variables, config definitions, PrismaService
• audit.md — Change history tracking
• excel-export.md — Excel export for various entities
• latest-news.md — News items with attachments
• status.md — Health checks, version info
• view.md — Saved filters and views

How to use

• When you change or add a backend feature module, update or create the corresponding file in this folder.
• Prefer small, focused docs with links to other files over large, monolithic documents.
• Use Mermaid diagrams for key flows and interactions where they improve clarity.