API接口文档：查询费用明细
一、接口名称
查询费用明细接口
二、接口描述
该接口用于查询指定社区的费用明细历史记录，包括费用详情、账户明细和折扣信息。
三、接口路径
http://{ip}:{port}/app/fee.queryFeeDetail (Java110Cmd服务编码)
四、请求方法
GET
五、请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 用户认证token |
| app-id | 是 | String | 应用ID |
| transaction-id | 是 | String | 请求流水号 |
| sign | 是 | String | 签名 |
| req-time | 是 | String | 请求时间(YYYYMMDDhhmmss) |
六、请求参数
6.1 请求体参数(JSON格式)
| 参数名称 | 必填 | 类型 | 描述 | 示例 |
|---|---|---|---|---|
| communityId | 是 | String | 社区ID | "123456789" |
| startTime | 否 | String | 开始时间(YYYY-MM-DD) | "2023-01-01" |
| endTime | 否 | String | 结束时间(YYYY-MM-DD) | "2023-12-31" |
| row | 否 | Integer | 每页记录数 | 10 |
| page | 否 | Integer | 当前页码 | 1 |
七、返回值
7.1 响应格式(JSON)
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | String | 返回码(0表示成功) |
| msg | String | 返回信息 |
| data | Object | 返回数据 |
7.2 data对象结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| total | Integer | 总记录数 |
| records | Integer | 总页数 |
| feeDetails | Array | 费用明细列表 |
7.3 feeDetails数组元素结构
| 参数名称 | 类型 | 描述 |
|---|---|---|
| detailId | String | 明细ID |
| state | String | 状态(1100:已退费,1200:退费失败,1300:退费单) |
| cycles | String | 周期 |
| receivableAmount | String | 应收金额 |
| receivedAmount | String | 实收金额 |
| createTime | String | 创建时间 |
| feeAccountDetailDtoList | Array | 账户明细列表 |
| payFeeDetailDiscountDtoList | Array | 折扣信息列表 |
八、示例请求
http://{ip}:{port}/app/fee.queryFeeDetail?communityId=123123&page=1&row=10
九、示例响应
{
"code": "0",
"msg": "成功",
"data": {
"total": 5,
"records": 1,
"feeDetails": [
{
"detailId": "1001",
"state": "1100",
"cycles": "2023-01",
"receivableAmount": "100.00",
"receivedAmount": "90.00",
"createTime": "2023-01-15 10:30:45",
"feeAccountDetailDtoList": [
{
"accountId": "ACC001",
"amount": "90.00"
}
],
"payFeeDetailDiscountDtoList": [
{
"discountId": "D001",
"discountAmount": "10.00"
}
]
}
]
}
}
十、业务逻辑说明
参数处理：
- 自动补全时间参数（开始时间补00:00:00，结束时间补23:59:59）
- 处理退费相关状态的金额显示（去除负号）
数据查询：
- 查询费用明细总数和列表
- 查询关联的账户明细
- 查询关联的折扣信息
数据转换：
- 将DTO对象转换为VO对象
- 格式化时间显示
分页处理：
- 计算总页数
十一、状态码说明
| 状态码 | 描述 |
|---|---|
| 0 | 成功 |
| 其他 | 失败，具体错误信息见msg字段 |
十二、注意事项
- communityId为必填参数
- 时间参数格式必须为YYYY-MM-DD
- 退费相关状态的金额会自动去除负号显示