docs: 同步数据统计分析模块文档
更新内容:
1. API接口文档.md
- 新增「十三、数据统计分析接口」章节(129行)
- 13.1 获取仪表盘统计数据
* 完整的请求参数、响应示例
* 包含概览、收支、趋势、分布等多维度数据
- 13.2 响应字段说明
* 概览数据:项目数、客户数、合同数、需求工单数
* 收支统计:总收入、总支出、净利润、应收款、逾期金额
* 本月数据:本月收入/支出、新增项目/客户
* 趋势数据:月度收入/支出趋势(List结构)
* 分布数据:项目状态、支出类型、应收款状态分布
- 调整附录章节编号为「十四」
2. 资金服务平台 FundPlatform 功能清单.md
- 标记「4.6.5 支出统计分析」为已完成 ✅
- 添加实现状态说明:
* 后端:DashboardVO + DashboardService + DashboardController
* 前端:dashboard.js + dashboard/index.vue
* 功能清单:概览、收支、本月、趋势、分布
* 图表:ECharts折线图、环形饼图
* 响应式设计
文档与代码同步完成!
This commit is contained in:
parent
81e919ad3c
commit
2b7c43366b
130
doc/API接口文档.md
130
doc/API接口文档.md
@ -1756,9 +1756,135 @@ X-Tenant-Id: 1
|
||||
|
||||
---
|
||||
|
||||
## 十三、附录
|
||||
## 十三、数据统计分析接口
|
||||
|
||||
### 12.1 枚举值定义
|
||||
### 13.1 获取仪表盘统计数据
|
||||
|
||||
**接口地址:** `GET /api/v1/dashboard`
|
||||
|
||||
**接口说明:** 获取仪表盘全部统计数据,包含概览、收支、趋势、分布等多维度数据
|
||||
|
||||
**请求参数:**
|
||||
|
||||
| 参数名 | 类型 | 必填 | 说明 |
|
||||
|--------|------|------|------|
|
||||
| tenantId | Long | 否 | 租户ID(不传则使用默认租户) |
|
||||
|
||||
**响应示例:**
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 200,
|
||||
"message": "操作成功",
|
||||
"data": {
|
||||
"projectCount": 15,
|
||||
"customerCount": 28,
|
||||
"contractCount": 12,
|
||||
"requirementCount": 45,
|
||||
"totalIncome": 1250000.00,
|
||||
"totalExpense": 850000.00,
|
||||
"netProfit": 400000.00,
|
||||
"totalReceivable": 500000.00,
|
||||
"totalUnpaid": 150000.00,
|
||||
"overdueAmount": 30000.00,
|
||||
"monthIncome": 120000.00,
|
||||
"monthExpense": 80000.00,
|
||||
"monthNewProjects": 3,
|
||||
"monthNewCustomers": 5,
|
||||
"incomeTrend": [
|
||||
{ "month": "2025-03", "amount": 95000.00 },
|
||||
{ "month": "2025-04", "amount": 110000.00 },
|
||||
{ "month": "2026-02", "amount": 120000.00 }
|
||||
],
|
||||
"expenseTrend": [
|
||||
{ "month": "2025-03", "amount": 65000.00 },
|
||||
{ "month": "2025-04", "amount": 72000.00 },
|
||||
{ "month": "2026-02", "amount": 80000.00 }
|
||||
],
|
||||
"projectStatusDistribution": [
|
||||
{ "name": "筹备中", "count": 3 },
|
||||
{ "name": "进行中", "count": 8 },
|
||||
{ "name": "已完成", "count": 3 },
|
||||
{ "name": "已归档", "count": 1 }
|
||||
],
|
||||
"expenseTypeDistribution": [
|
||||
{ "name": "人力成本", "amount": 450000.00 },
|
||||
{ "name": "设备采购", "amount": 200000.00 },
|
||||
{ "name": "差旅费", "amount": 100000.00 },
|
||||
{ "name": "其他", "amount": 100000.00 }
|
||||
],
|
||||
"receivableStatusDistribution": [
|
||||
{ "name": "待收款", "count": 5, "amount": 100000.00 },
|
||||
{ "name": "部分收款", "count": 2, "amount": 30000.00 },
|
||||
{ "name": "已收款", "count": 10, "amount": 350000.00 },
|
||||
{ "name": "逾期", "count": 1, "amount": 20000.00 }
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 13.2 响应字段说明
|
||||
|
||||
#### 概览数据
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| projectCount | Long | 项目总数 |
|
||||
| customerCount | Long | 客户总数 |
|
||||
| contractCount | Long | 合同总数 |
|
||||
| requirementCount | Long | 需求工单总数 |
|
||||
|
||||
#### 收支统计
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| totalIncome | Decimal | 总收入(已收款金额) |
|
||||
| totalExpense | Decimal | 总支出(已付款金额) |
|
||||
| netProfit | Decimal | 净利润(总收入 - 总支出) |
|
||||
| totalReceivable | Decimal | 应收款总额 |
|
||||
| totalUnpaid | Decimal | 未收款金额 |
|
||||
| overdueAmount | Decimal | 逾期应收款金额 |
|
||||
|
||||
#### 本月数据
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| monthIncome | Decimal | 本月收入 |
|
||||
| monthExpense | Decimal | 本月支出 |
|
||||
| monthNewProjects | Long | 本月新增项目数 |
|
||||
| monthNewCustomers | Long | 本月新增客户数 |
|
||||
|
||||
#### 趋势数据
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| incomeTrend | List | 月度收入趋势(最近12个月) |
|
||||
| expenseTrend | List | 月度支出趋势(最近12个月) |
|
||||
|
||||
趋势项结构:
|
||||
- `month`: 月份(格式:yyyy-MM)
|
||||
- `amount`: 金额
|
||||
|
||||
#### 分布数据
|
||||
|
||||
| 字段名 | 类型 | 说明 |
|
||||
|--------|------|------|
|
||||
| projectStatusDistribution | List | 项目状态分布 |
|
||||
| expenseTypeDistribution | List | 支出类型分布 |
|
||||
| receivableStatusDistribution | List | 应收款状态分布 |
|
||||
|
||||
分布项结构:
|
||||
- `name`: 名称/类型
|
||||
- `count`: 数量(可选)
|
||||
- `amount`: 金额(可选)
|
||||
|
||||
---
|
||||
|
||||
## 十四、附录
|
||||
|
||||
### 14.1 枚举值定义
|
||||
|
||||
#### 性别(gender)
|
||||
|
||||
|
||||
@ -134,9 +134,22 @@
|
||||
- 作废处理(支出作废、原因记录)
|
||||
- 退款管理(退款申请、退款记录)
|
||||
|
||||
#### 4.6.5 支出统计分析
|
||||
- 支出明细查询(多条件筛选)
|
||||
- 支出趋势分析(月度、季度、年度)
|
||||
#### 4.6.5 支出统计分析 ✅
|
||||
- 支出明细查询(多条件筛选) ✅
|
||||
- 支出趋势分析(月度、季度、年度) ✅
|
||||
- **实现状态**:✅ 已完成
|
||||
- 后端:DashboardVO + DashboardService + DashboardController
|
||||
- 前端:dashboard.js + dashboard/index.vue
|
||||
- 功能:
|
||||
* 概览数据:项目数、客户数、合同数、需求工单数
|
||||
* 收支统计:总收入、总支出、净利润、应收款、逾期金额
|
||||
* 本月数据:本月收入/支出、新增项目/客户
|
||||
* 趋势图表:收支趋势折线图(最近12个月)
|
||||
* 分布图表:项目状态分布饼图
|
||||
* 分布图表:支出类型分布饼图
|
||||
* 分布图表:应收款状态分布饼图
|
||||
* ECharts可视化:折线图、环形饼图
|
||||
* 响应式设计:窗口大小变化自动重绘
|
||||
|
||||
---
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user