Breezy Platform Module Documentation
This directory contains comprehensive technical documentation for all modules in the Breezy HVAC field service management platform. Each module represents a distinct business capability with its own data model, API endpoints, workflows, and integration points.
Documentation Status
All modules have been thoroughly researched, verified against the codebase, and documented following the MODULE_DOCUMENTATION_STYLE_GUIDE. Documentation includes business context, technical architecture, key workflows, API endpoints, configuration options, and integration points.
Last Updated: 2025-09-11 Total Modules Documented: 30
Modules
| Module | Description | Documentation |
|---|---|---|
| Account Management | Central customer record management with contacts, service locations, and comprehensive service history tracking | Account Management |
| Afterhours AI CSR | Vapi integration for after-hours customer service with fallback "Brandi" assistant behavior | Afterhours AI CSR |
| AI Comms | AI-powered text generation for customer communications with template management and personalization | AI Comms |
| Authentication | Auth0 integration with V1/V2 permission systems, tokenized customer access, and root user privileges | Authentication |
| Breezy Admin | Platform administration tools with impersonation, company provisioning, and dev tools access | Breezy Admin |
| Breezy Engineering | AI Sandbox with 20+ devtools endpoints, database seeding, and production safety gates | Breezy Engineering |
| Business Units | Financial segmentation with P&L tracking and QBO/QBD sync differences | Business Units |
| Checklists and Custom Forms | JSONB checklist storage with breezy-pdf service integration and three-surface deployment | Checklists and Custom Forms |
| Company Profile | Central company settings with billing profile, notification settings, dual logo system, and legal disclaimers | Company Profile |
| Dispatch and Scheduling | Real-time dispatch board with GraphQL subscriptions, capacity blocks, arrival windows, and ScheduleV2Page interface | Dispatch and Scheduling |
| Equipment Tracking | AI label scanner, replacement probability algorithms, HVAC system grouping, and warranty tracking | Equipment Tracking |
| Estimates | Quote management with multiple options, Wisetack financing integration, digital signatures, and invoice conversion | Estimates |
| Field App Visit Experience | PWA mobile interface for technicians with status workflow and automatic timesheet integration | Field App Visit Experience |
| Integrated Calling | Twilio/Vapi call management with recording, transcription, AI summaries, and unified phone widget | Integrated Calling |
| Integrated Lending | Wisetack integration for $500-$25k loans with webhook-driven payments and prequal applications | Integrated Lending |
| Integrated SMS | Two-way Twilio messaging with appointment confirmations, maintenance reminders, and unified channels | Integrated SMS |
| Invoicing | V2 cart-based invoicing system with line items, payment application, templates, and customer portal integration | Invoicing |
| Job Management | Fundamental work unit abstraction for field service operations with pipeline-based workflow management | Job Management |
| Lead Management | Job leads system with 27 canonical sources, AI CSR integration, and phone attribution workflow | Lead Management |
| Maintenance Plans | V1 queryable architecture with recurring billing, covered equipment tracking, and one plan per location constraint | Maintenance Plans |
| Online Booking | Instant booking system with real-time availability, public API, service type configuration, and zip code restrictions | Online Booking |
| Payments | Tilled payment processing with multi-invoice payments, payment methods (CARD/ACH/CASH/CHECK), and customer portal | Payments |
| Payouts | Tilled/Wisetack payout processing with fee handling differences and merchant settlement tracking | Payouts |
| Photo Management | S3 direct upload with client-side optimization, server cropping, and flexible entity linking | Photo Management |
| Pricebook Management | Eight-tier pricing system with USC storage, Flatfile integration, photo support, and recent items tracking | Pricebook Management |
| Quickbooks Desktop Integration | Conductor service with intelligent offline/online routing and comprehensive uptime monitoring | Quickbooks Desktop Integration |
| Quickbooks Online Integration | Cloud-based OAuth integration with comprehensive sync capabilities and dual permission system support | Quickbooks Online Integration |
| Reminders | Account-linked task management with notification infrastructure and weekly digest system | Reminders |
| Reporting | Widget-based dashboard with Metabase integration, embedded reporting, and pulse delivery system | Reporting |
| Reviews Management | Zembra integration for review collection with technician discretion workflow embedded within Reporting module | Reviews Management |
| Sage 100 Integration | Minimal one-way export with CSV format transformation and payment method encoding | Sage 100 Integration |
| Tags | GraphQL-based tagging system with company-isolated namespaces and junction table relationships | Tags |
| Team Management | Dual V1/V2 permission systems with invitation-based provisioning and ALL_ACTIONS super admin override | Team Management |
| Technician Performance | Dual sold/earned revenue attribution system with line-item granularity and 18+ dashboard widgets | Technician Performance |
| Timetracking | Comprehensive time capture with minute-precision rounding, RRULE pay period configuration, and automatic session management | Timetracking |
Documentation Methodology
Each module was documented using a rigorous 6-step process:
- Context Review - Product expert knowledge and module boundaries
- Intern Analysis - Review of AI-generated documentation from multiple sources
- Codebase Research - Deep verification against actual implementation
- Synthesis - Distill accurate information and correct misconceptions
- Documentation - Create comprehensive, production-ready documentation
- Quality Check - Verify all claims against codebase for accuracy
Key Technical Corrections Made
During documentation, several major errors in preliminary research were corrected:
- Technician Performance: Corrected completely wrong table schema claims and verified dedicated tRPC router
- Timetracking: Corrected false claim about missing tRPC router, documented RRULE configuration
- Team Management: Fixed database schema errors and documented dual permission systems
- Reviews Management: Identified it as embedded within Reporting module, not standalone
- Sales Tax: Documented as embedded within Pricebook Management, not separate module
Architecture Patterns
Common patterns across modules:
- Multi-tenant isolation: All modules properly scope data by company_guid
- Permission systems: Dual V1/V2 permission architecture with gradual migration
- Integration points: Comprehensive QuickBooks, Tilled, and external service integrations
- Event-driven workflows: GraphQL subscriptions and real-time updates
- Audit trails: Complete change tracking across financial and operational data
Module Dependencies
The modules form a complex dependency graph with Account Management and Authentication serving as foundational primitives, Job Management as the central operational hub, and various specialized modules providing specific business capabilities.
For detailed technical information about any module, refer to the individual module documentation files.