Work in Progress
Feature details in this document may change during investigation, discussion, design, and implementation phases.
Reports / Báo cáo
Business analytics and reporting.
Overview
| Attribute | Value |
|---|---|
| Module ID | CORE-12 |
| Phase | Phase 1 (Basic), Phase 3 (Advanced) |
| Priority | HIGH |
| Dependencies | All Core Modules |
The Reports module provides comprehensive business analytics and reporting capabilities. From basic revenue reports to detailed tax declarations, it gives business owners the insights needed to manage effectively and stay compliant with Vietnam tax regulations.
┌─────────────────────────────────────────────────────────────────┐
│ REPORTING SYSTEM │
├─────────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────────────────────────────────────────────┐ │
│ │ DATA SOURCES │ │
│ │ ┌────────┐ ┌────────┐ ┌────────┐ ┌────────┐ │ │
│ │ │ Orders │ │Payment │ │Inventory│ │ Tax │ │ │
│ │ └───┬────┘ └───┬────┘ └───┬────┘ └───┬────┘ │ │
│ └──────┼──────────┼──────────┼──────────┼────────────┘ │
│ └──────────┴──────────┴──────────┘ │
│ │ │
│ ▼ │
│ ┌─────────────────────────────────────────────────────┐ │
│ │ REPORT CATEGORIES │ │
│ │ │ │
│ │ ├── Revenue Reports (P1) │ │
│ │ │ Daily, Weekly, Monthly sales │ │
│ │ │ │ │
│ │ ├── Tax Reports (P1) │ │
│ │ │ Tax summary, Invoice register │ │
│ │ │ │ │
│ │ ├── Inventory Reports (P2) │ │
│ │ │ Stock levels, Movement history │ │
│ │ │ │ │
│ │ └── Analytics (P3) │ │
│ │ Profit, Trends, Performance │ │
│ └─────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────┘User Stories
Phase 1 - Basic Reports
| ID | As a... | I want to... | So that... |
|---|---|---|---|
| US-01 | Business owner | View daily revenue | I know today's sales |
| US-02 | Business owner | View weekly summary | I track weekly performance |
| US-03 | Business owner | View monthly revenue | I see monthly trends |
| US-04 | Business owner | See payment breakdown | I know cash vs QR vs card |
| US-05 | Business owner | View tax collected | I prepare for filing |
| US-06 | Business owner | Export reports | I share with accountant |
| US-07 | Business owner | See top products | I know best sellers |
Phase 2-3 - Advanced Reports
| ID | As a... | I want to... | So that... |
|---|---|---|---|
| US-08 | Business owner | View inventory reports | I track stock levels |
| US-09 | Business owner | See profit margins | I understand profitability |
| US-10 | Business owner | Compare stores | I see store performance |
| US-11 | Business owner | See hourly trends | I know peak times |
| US-12 | Business owner | Track staff performance | I measure productivity |
| US-13 | Business owner | Schedule reports | Reports sent automatically |
Feature Matrix
| Feature | P1 | P2 | P3 | Description |
|---|---|---|---|---|
| Daily revenue | ✓ | Today's sales summary | ||
| Weekly revenue | ✓ | Week-over-week comparison | ||
| Monthly revenue | ✓ | Monthly performance | ||
| Payment breakdown | ✓ | By payment method | ||
| Product sales | ✓ | Sales by product | ||
| Tax summary | ✓ | Tax collected | ||
| Export (PDF/Excel) | ✓ | Download reports | ||
| Inventory reports | ✓ | Stock levels, movement | ||
| Store comparison | ✓ | Multi-store metrics | ||
| Custom date range | ✓ | Flexible reporting | ||
| Profit analysis | ✓ | Margin calculations | ||
| Trend analysis | ✓ | Historical trends | ||
| Staff reports | ✓ | Performance metrics | ||
| Scheduled reports | ✓ | Automatic delivery | ||
| Dashboard widgets | ✓ | Customizable dashboard |
Report Categories
Revenue Reports
| Report | Description | Frequency | Phase |
|---|---|---|---|
| Daily Summary | Today's revenue, orders, average ticket | Daily | P1 |
| Weekly Summary | Week totals, daily breakdown | Weekly | P1 |
| Monthly Summary | Month totals, weekly breakdown | Monthly | P1 |
| Payment Breakdown | Revenue by payment method | All | P1 |
| Hourly Analysis | Sales by hour of day | Daily | P3 |
Product Reports
| Report | Description | Frequency | Phase |
|---|---|---|---|
| Top Products | Best selling items | All | P1 |
| Category Sales | Revenue by category | All | P1 |
| Product Performance | Sales vs previous period | All | P3 |
| Low Performers | Slow moving items | All | P3 |
Tax Reports
| Report | Description | Frequency | Phase |
|---|---|---|---|
| Tax Summary | Tax collected by rate | Monthly | P1 |
| Invoice Register | All invoices issued | On demand | P1 |
| Declaration Data | Tax filing export | Per schedule | P2 |
Inventory Reports (Phase 2)
| Report | Description | Frequency | Phase |
|---|---|---|---|
| Stock Levels | Current quantities | On demand | P2 |
| Stock Movement | In/out transactions | On demand | P2 |
| Low Stock | Below reorder point | Daily | P2 |
| Stock Valuation | Inventory value | On demand | P3 |
Performance Reports (Phase 3)
| Report | Description | Frequency | Phase |
|---|---|---|---|
| Profit & Loss | Revenue minus costs | Monthly | P3 |
| Store Comparison | Multi-store metrics | On demand | P3 |
| Staff Performance | Sales by employee | On demand | P3 |
| Customer Analysis | Purchase patterns | On demand | P3 |
Key Flows
Report Generation Flow
Dashboard Loading Flow
Export Flow
Scheduled Report Flow (Phase 3)
Dashboard Widgets
┌─────────────────────────────────────────────────────────────────┐
│ DASHBOARD LAYOUT │
├─────────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ TODAY'S SUMMARY │ │
│ │ Revenue: 3,500,000 VND Orders: 45 Avg: 77,778 │ │
│ └─────────────────────────────────────────────────────────┘ │
│ │
│ ┌───────────────────────┐ ┌───────────────────────────┐ │
│ │ PAYMENT METHODS │ │ TOP PRODUCTS │ │
│ │ ├── Cash: 40% │ │ 1. Coffee 150 │ │
│ │ ├── QR: 35% │ │ 2. Tea 120 │ │
│ │ └── Card: 25% │ │ 3. Sandwich 80 │ │
│ └───────────────────────┘ └───────────────────────────────┘ │
│ │
│ ┌─────────────────────────────────────────────────────────┐ │
│ │ WEEKLY TREND │ │
│ │ ████ │ │
│ │ ████ ████ │ │
│ │ ████ ████ ████ ████ │ │
│ │ ████ ████ ████ ████ ████ ████ ████ │ │
│ │ Mon Tue Wed Thu Fri Sat Sun │ │
│ └─────────────────────────────────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────┘Business Rules
| Rule ID | Rule | Description |
|---|---|---|
| BR-01 | Real-time updates | Dashboard updates within 30 seconds |
| BR-02 | Date range limit | Max 1 year for detailed reports |
| BR-03 | Data retention | Reports available for 10 years |
| BR-04 | Permission based | Reports visible per user role |
| BR-05 | Store filtering | Multi-store users see combined data |
| BR-06 | Timezone | All times in organization timezone |
| BR-07 | Currency | All amounts in VND |
| BR-08 | Tax included | Revenue includes tax unless specified |
| BR-09 | Export format | PDF for sharing, Excel for analysis |
| BR-10 | Schedule limit | Max 10 scheduled reports per user |
Acceptance Criteria
AC-01: Daily Revenue Report
GIVEN completed orders for today
WHEN user views daily revenue
THEN - Total revenue displayed
- Number of orders shown
- Average ticket calculated
- Payment breakdown shown
- Comparison to yesterdayAC-02: Report Filtering
GIVEN a report with multiple parameters
WHEN user applies filters
THEN - Results update immediately
- Filters are clearly shown
- Clear all option available
- Export includes filtered dataAC-03: Report Export
GIVEN a generated report
WHEN user exports to PDF
THEN - PDF downloads immediately
- Format is professional
- All data included
- Date range shown
- Company info displayedAC-04: Dashboard Performance
GIVEN a user opening dashboard
WHEN dashboard loads
THEN - Key metrics show in < 2 seconds
- Charts render smoothly
- Auto-refresh works
- Mobile view is responsiveAC-05: Tax Report for Filing
GIVEN tax report for a quarter
WHEN user generates declaration data
THEN - Totals match invoice register
- Tax by rate is correct
- Export format matches CQT requirements
- All invoices are includedDependencies
Reports
├── Requires: All Core Modules
├── Required by: None (end module)
└── Integrates: Email service, CQT (tax reports)| Module | Relationship |
|---|---|
| Orders | Sales data source |
| Payment | Payment breakdown |
| Transaction | Financial records |
| Tax & Invoice | Tax reports |
| Inventory | Stock reports |
| Product | Product performance |
Export Formats
┌─────────────────────────────────────────────────────────────────┐
│ EXPORT OPTIONS │
├─────────────────────────────────────────────────────────────────┤
│ │
│ FORMAT USE CASE FEATURES │
│ ───────────────────────────────────────────────────────────── │
│ │ │
│ ├── PDF Official records Formatted, Branded, │
│ │ Sharing Charts included │
│ │ │
│ ├── Excel Analysis Raw data, Pivot-ready, │
│ │ Accounting Multiple sheets │
│ │ │
│ ├── CSV Import/Export Simple format, │
│ │ Integration Universal compatibility │
│ │ │
│ └── JSON API access Machine-readable, │
│ Integration Structured data │
│ │
└─────────────────────────────────────────────────────────────────┘Screenshots
Screenshots
Screenshots will be added after UI implementation.
Related Modules
- Orders - Sales data
- Payment - Payment data
- Transaction - Financial records
- Tax & Invoice - Tax data
- Inventory - Stock data
- Product - Product data