From 6702b92a95836a1721e97cd9cfae2187df972f6a Mon Sep 17 00:00:00 2001 From: zhangjf Date: Mon, 16 Feb 2026 09:00:35 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=90=8C=E6=AD=A5=E6=94=B6=E6=AC=BE?= =?UTF-8?q?=E8=AE=B0=E5=BD=95=E6=A8=A1=E5=9D=97=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 更新内容: 1. API接口文档.md - 新增「十、收款记录管理接口」章节 - 包含5个接口文档 - 完整的请求参数、响应示例、字段说明 2. 资金服务平台 FundPlatform 功能清单.md - 标记「4.7.2 收款管理」为已完成 ✅ - 添加实现状态说明 文档与代码同步完成! --- doc/API接口文档.md | 192 +++++++++++++++++++++- doc/资金服务平台 FundPlatform 功能清单.md | 6 +- 2 files changed, 195 insertions(+), 3 deletions(-) diff --git a/doc/API接口文档.md b/doc/API接口文档.md index 5cff6d0..c2dd0d5 100644 --- a/doc/API接口文档.md +++ b/doc/API接口文档.md @@ -968,9 +968,197 @@ X-Tenant-Id: 1 --- -## 十、附录 +## 十、收款记录管理接口 -### 10.1 枚举值定义 +### 10.1 获取收款记录列表 + +**接口地址:** `GET /api/v1/receipt/list` + +**接口说明:** 分页查询收款记录列表 + +**请求参数:** + +| 参数名 | 类型 | 必填 | 说明 | +|--------|------|------|------| +| current | Integer | 否 | 当前页码(默认1) | +| size | Integer | 否 | 每页大小(默认10) | +| receiptCode | String | 否 | 收款编号(模糊查询) | +| receivableId | Long | 否 | 应收款ID | + +**响应示例:** + +```json +{ + "code": 200, + "message": "操作成功", + "data": { + "records": [ + { + "receiptId": 1, + "tenantId": 1, + "receiptCode": "REC-2026-001", + "receivableId": 1, + "receiptAmount": 5000.00, + "receiptDate": "2026-02-15", + "receiptMethod": "transfer", + "receiptAccount": "6222021234567890", + "payerName": "阿里巴巴集团", + "receiptVoucher": "V-20260215-001", + "operatorId": 1, + "remark": "首次付款", + "createdTime": "2026-02-15 10:30:00" + } + ], + "total": 1, + "size": 10, + "current": 1, + "pages": 1 + } +} +``` + +--- + +### 10.2 获取收款记录详情 + +**接口地址:** `GET /api/v1/receipt/{receiptId}` + +**接口说明:** 根据ID查询收款记录详情 + +**路径参数:** + +| 参数名 | 类型 | 必填 | 说明 | +|--------|------|------|------| +| receiptId | Long | 是 | 收款记录ID | + +**响应示例:** + +```json +{ + "code": 200, + "message": "操作成功", + "data": { + "receiptId": 1, + "tenantId": 1, + "receiptCode": "REC-2026-001", + "receivableId": 1, + "receiptAmount": 5000.00, + "receiptDate": "2026-02-15", + "receiptMethod": "transfer", + "receiptAccount": "6222021234567890", + "payerName": "阿里巴巴集团", + "receiptVoucher": "V-20260215-001", + "operatorId": 1, + "remark": "首次付款", + "createdTime": "2026-02-15 10:30:00" + } +} +``` + +--- + +### 10.3 创建收款记录 + +**接口地址:** `POST /api/v1/receipt` + +**接口说明:** 创建新的收款记录 + +**请求参数:** + +| 参数名 | 类型 | 必填 | 说明 | +|--------|------|------|------| +| receiptCode | String | 是 | 收款编号 | +| receivableId | Long | 是 | 应收款ID | +| receiptAmount | Decimal | 是 | 收款金额 | +| receiptDate | Date | 否 | 收款日期 | +| receiptMethod | String | 否 | 收款方式(transfer/cash/check/other) | +| receiptAccount | String | 否 | 收款账户 | +| payerName | String | 否 | 付款方名称 | +| receiptVoucher | String | 否 | 收款凭证 | +| operatorId | Long | 否 | 经办人ID(默认为当前用户) | +| remark | String | 否 | 备注说明 | + +**请求示例:** + +```json +{ + "receiptCode": "REC-2026-002", + "receivableId": 1, + "receiptAmount": 3000.00, + "receiptDate": "2026-02-16", + "receiptMethod": "transfer", + "receiptAccount": "6222021234567890", + "payerName": "阿里巴巴集团", + "receiptVoucher": "V-20260216-001", + "remark": "二次付款" +} +``` + +**响应示例:** + +```json +{ + "code": 200, + "message": "创建成功", + "data": null +} +``` + +--- + +### 10.4 更新收款记录 + +**接口地址:** `PUT /api/v1/receipt/{receiptId}` + +**接口说明:** 更新收款记录信息 + +**路径参数:** + +| 参数名 | 类型 | 必填 | 说明 | +|--------|------|------|------| +| receiptId | Long | 是 | 收款记录ID | + +**请求参数:** 同创建接口 + +**响应示例:** + +```json +{ + "code": 200, + "message": "更新成功", + "data": null +} +``` + +--- + +### 10.5 删除收款记录 + +**接口地址:** `DELETE /api/v1/receipt/{receiptId}` + +**接口说明:** 删除收款记录 + +**路径参数:** + +| 参数名 | 类型 | 必填 | 说明 | +|--------|------|------|------| +| receiptId | Long | 是 | 收款记录ID | + +**响应示例:** + +```json +{ + "code": 200, + "message": "删除成功", + "data": null +} +``` + +--- + +## 十一、附录 + +### 11.1 枚举值定义 #### 性别(gender) diff --git a/doc/资金服务平台 FundPlatform 功能清单.md b/doc/资金服务平台 FundPlatform 功能清单.md index 36af586..395f137 100644 --- a/doc/资金服务平台 FundPlatform 功能清单.md +++ b/doc/资金服务平台 FundPlatform 功能清单.md @@ -112,7 +112,7 @@ - 应收款金额确认(确认应收金额) - 应收款日期确认(确认应收日期) -#### 4.7.2 收款管理 +#### 4.7.2 收款管理 ✅ - 收款记录录入: - 实际收款金额 - 收款日期 @@ -120,6 +120,10 @@ - 收款凭证(上传凭证照片) - 收款方式管理(维护常用收款方式) - 收款凭证管理(凭证归档、查询) +- **实现状态**:✅ 已完成 + - 后端:ReceiptMapper + ReceiptService + ReceiptController + - 前端:receipt.js + receipt.vue + - 功能:分页查询、新增、编辑、删除、应收款关联 ---