# Ladaer Backend Documentation

Thư mục này chứa tài liệu chi tiết về các tính năng, API endpoints, và stored procedures của hệ thống Ladaer Backend.

## 📑 Danh Mục Tài Liệu

### 🌐 API Documentation

#### Reports
- **[API_OrderReportByRoute.md](API_OrderReportByRoute.md)** - API báo cáo số lượng đơn và doanh số theo tuyến
  - Endpoint: `POST /api/Report/OrderReportByRoute`
  - Permission: `Report.OrderReportByRoute`
  - Stored Procedure: `sp_GetOrderReportByRoute`

### 💰 Finance & Income Management

- **[Income_Management_System.md](Income_Management_System.md)** - Hệ thống quản lý thu nhập
- **[Income_System_Complete.md](Income_System_Complete.md)** - Tài liệu hoàn chỉnh về hệ thống thu nhập
- **[Income_Progress_Summary.md](Income_Progress_Summary.md)** - Tóm tắt tiến độ phát triển
- **[IncomeExpenseReport_Summary.md](IncomeExpenseReport_Summary.md)** - Báo cáo thu chi
- **[Transaction_ExpenseId_IncomeId_Update.md](Transaction_ExpenseId_IncomeId_Update.md)** - Cập nhật ExpenseId và IncomeId trong Transaction

### 🚚 Operations

#### Driver Reports
- **[Operations/DriverProductivityReportByDate.md](Operations/DriverProductivityReportByDate.md)** - Báo cáo năng suất lái xe theo ngày

### 📦 Orders

- **[Orders/PrepareOrderListFilter.md](Orders/PrepareOrderListFilter.md)** - Chuẩn bị dữ liệu bộ lọc danh sách đơn hàng

### 📊 Data Files

- **2025_Chi tiết thu chi tháng.xlsx** - Dữ liệu chi tiết thu chi

## 🔍 Tìm Kiếm Nhanh

### Theo Chức Năng

| Chức năng | Tài liệu |
|-----------|----------|
| Báo cáo đơn hàng theo tuyến | [API_OrderReportByRoute.md](API_OrderReportByRoute.md) |
| Báo cáo năng suất lái xe | [DriverProductivityReportByDate.md](Operations/DriverProductivityReportByDate.md) |
| Quản lý thu nhập | [Income_Management_System.md](Income_Management_System.md) |
| Báo cáo thu chi | [IncomeExpenseReport_Summary.md](IncomeExpenseReport_Summary.md) |

### Theo API Endpoint

| Endpoint | Tài liệu |
|----------|----------|
| `POST /api/Report/OrderReportByRoute` | [API_OrderReportByRoute.md](API_OrderReportByRoute.md) |

## 📝 Quy Ước Đặt Tên

### API Documentation
- **Format**: `API_{FeatureName}.md`
- **Example**: `API_OrderReportByRoute.md`

### Feature Documentation
- **Format**: `{FeatureName}_{Description}.md`
- **Example**: `Income_Management_System.md`

### Stored Procedure Documentation
- **Location**: `Ladaer.BackEnd/docs/Reports/{Domain}/{ProcedureName}.md`
- **Example**: `docs/Reports/OrderReportByRoute.md`

## 🏗️ Cấu Trúc Tài Liệu API

Mỗi tài liệu API nên bao gồm:

1. **Thông Tin Chung**
   - Endpoint URL
   - HTTP Method
   - Controller & Action
   - Authorization Requirements
   - Permission Required

2. **Mô Tả**
   - Tính năng chính
   - Use cases

3. **Request**
   - Request structure
   - Parameters
   - Examples (nhiều scenarios)

4. **Response**
   - Success response
   - Error responses
   - Field descriptions

5. **Business Logic**
   - Quy tắc nghiệp vụ
   - Tính toán
   - Điều kiện lọc

6. **Testing**
   - cURL examples
   - Postman collection
   - Swagger UI instructions

7. **Performance & Optimization**
   - Database indexes
   - Expected response time

8. **Common Use Cases**

9. **Error Handling**

10. **Related Documentation**

11. **Changelog**

## 🔗 Liên Kết Hữu Ích

### Source Code
- [Controllers](../Controllers/) - API Controllers
- [Services](../Infrastructures/Services/) - Business Logic Services
- [DTOs](../Infrastructures/DTO/) - Data Transfer Objects
- [Scripts](../Scripts/) - SQL Scripts & Stored Procedures

### Related Documentation
- [CLAUDE.md](../../CLAUDE.md) - Development Guide
- [Cursor Rules](.cursor/rules/) - Coding Patterns & Conventions

## 📮 Liên Hệ & Đóng Góp

Nếu bạn muốn:
- ✍️ Thêm tài liệu mới
- 🐛 Báo cáo lỗi trong tài liệu
- 💡 Đề xuất cải tiến

Vui lòng liên hệ team phát triển hoặc tạo pull request.

## 📌 Lưu Ý

- Tài liệu nên được cập nhật đồng thời với code
- Sử dụng tiếng Việt cho business logic
- Sử dụng tiếng Anh cho technical terms
- Bao gồm examples thực tế
- Cập nhật Changelog khi có thay đổi

---

**Last Updated**: 2025-01-06

