Files
xk-docs/docs/projects/xk-api/modules/finance.md

220 lines
5.8 KiB
Markdown
Raw Normal View History

2026-07-08 15:04:42 +08:00
# 财务结算模块
## 概述
财务结算模块负责分账、提现、对账、资金流水、月结等财务管理功能。
---
## 分账结算
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `settlement/list` | 结算列表 |
| GET | `settlement/detail` | 结算详情 |
| POST | `settlement/settle` | 执行结算 |
| GET | `settlement/export` | 导出结算单 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `SettlementController` | `app/Http/Controllers/admin/finance/SettlementController.php` | 控制器 |
| `SettlementService` | `app/Service/admin/finance/SettlementService.php` | 业务服务 |
| `LedgerService` | `app/Service/finance/LedgerService.php` | 分账服务 |
### 关联模型
| 模型 | 表名 | 说明 |
|------|------|------|
| `LedgerModel` | `yii_ledger` | 分账记录 |
| `LedgerLogModel` | `yii_ledger_log` | 分账变更日志 |
| `AccountAbleChangeLogModel` | `xk_account_able_change_log` | 可提现金额变更 |
### 分账规则
| 费用类型 | 值 | 说明 |
|----------|-----|------|
| 药品费用 | 1 | 产品订单药品费用 |
| 挂号费用 | 2 | 挂号订单费用 |
| 快递费用 | 3 | 快递费用 |
| 处方费 | 4 | 处方费用 |
| 加工费 | 5 | 代煎/加工费用 |
| 诊疗费 | 6 | 诊疗费用 |
### 分账流程
```mermaid
sequenceDiagram
participant P as 支付回调
participant J as ProductOrderPaidJob
participant L as LedgerService
participant DB as 数据库
P->>J: 支付成功
J->>L: createLedger(order)
L->>L: calculateSplit(order)
L->>DB: INSERT INTO yii_ledger (门店)
L->>DB: INSERT INTO yii_ledger (平台)
L->>DB: INSERT INTO xk_account_able_change_log
```
---
## 提现管理
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `withdrawal-application/list` | 提现申请列表 |
| GET | `withdrawal-application/detail` | 申请详情 |
| POST | `withdrawal-application/audit` | 审核申请 |
| POST | `withdrawal-application/pay` | 打款 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `WithdrawalApplicationController` | `app/Http/Controllers/admin/finance/WithdrawalApplicationController.php` | 控制器 |
| `WithdrawalApplicationService` | `app/Service/admin/finance/WithdrawalApplicationService.php` | 业务服务 |
### 关联模型
| 模型 | 表名 | 说明 |
|------|------|------|
| `CashApplyModel` | `yii_cash_apply` | 提现申请 |
| `CashAccountModel` | `yii_cash_account` | 提现账户 |
### 提现审核流程
```mermaid
stateDiagram-v2
[*] --> 审核中: 提交申请
审核中 --> 已通过: 审核通过
审核中 --> 已拒绝: 审核拒绝
已通过 --> 打款中: 发起打款
打款中 --> 已打款: 打款成功
打款中 --> 打款失败: 打款失败
已拒绝 --> 审核中: 重新申请
```
---
## 对账管理
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `reconciliation/list` | 对账列表 |
| GET | `reconciliation/detail` | 对账详情 |
| GET | `reconciliation/export` | 导出对账单 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `ReconciliationController` | `app/Http/Controllers/admin/finance/ReconciliationController.php` | 控制器 |
| `ReconciliationService` | `app/Service/admin/finance/ReconciliationService.php` | 业务服务 |
### 关联模型
| 模型 | 表名 | 说明 |
|------|------|------|
| `ReconciliationModel` | `yii_reconciliation` | 对账记录 |
---
## 资金流水
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `fund-water/list` | 流水列表 |
| GET | `fund-water/detail` | 流水详情 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `FundWaterController` | `app/Http/Controllers/admin/finance/FundWaterController.php` | 控制器 |
| `FundWaterService` | `app/Service/admin/finance/FundWaterService.php` | 业务服务 |
### 关联模型
| 模型 | 表名 | 说明 |
|------|------|------|
| `FundWaterModel` | `yii_fund_water` | 资金流水 |
---
## 月结管理
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `monthly-payment/list` | 月结列表 |
| GET | `monthly-payment/detail` | 月结详情 |
| POST | `monthly-payment/settle` | 结算 |
| POST | `monthly-payment/cancel` | 取消 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `MonthlyPaymentController` | `app/Http/Controllers/admin/finance/MonthlyPaymentController.php` | 控制器 |
| `MonthlyPaymentService` | `app/Service/admin/finance/MonthlyPaymentService.php` | 业务服务 |
### 关联模型
| 模型 | 表名 | 说明 |
|------|------|------|
| `MonthlyPaymentModel` | `xk_monthly_payment` | 月结账单 |
| `MonthlyPaymentSettlementModel` | `xk_monthly_payment_settlement` | 月结结算记录 |
---
## 代理付款
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `charge-cash-pay-record/list` | 付款记录列表 |
| POST | `charge-cash-pay-record/create` | 创建付款记录 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `ChargeCashPayRecordController` | `app/Http/Controllers/admin/finance/ChargeCashPayRecordController.php` | 控制器 |
| `ChargeCashPayRecordService` | `app/Service/admin/finance/ChargeCashPayRecordService.php` | 业务服务 |
### 关联模型
| 模型 | 表名 | 说明 |
|------|------|------|
| `ChargeCashPayRecordModel` | `yii_charge_cash_pay_record` | 代理付款记录 |
---
## 财务可视化
### 接口
| 方法 | 路径 | 说明 |
|------|------|------|
| GET | `visualization-chart/data` | 图表数据 |
### 关联类
| 类 | 文件 | 说明 |
|----|------|------|
| `VisualizationChartController` | `app/Http/Controllers/admin/finance/VisualizationChartController.php` | 控制器 |
| `VisualizationChartService` | `app/Service/admin/finance/VisualizationChartService.php` | 业务服务 |