费用配置管理API文档
1. 保存费用配置接口
1.1 接口描述
该接口用于创建新的费用配置项，包括费用类型、计费规则、缴费周期等信息。
1.2 接口路径
POST http://{ip}:{port}/app/feeConfig/saveFeeConfig
1.3 请求方法
POST
1.4 请求头
| 参数名称 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Authorization | 是 | String | 用户认证token（Base token） |
| app-id | 是 | String | 应用ID（系统dev账户分配） |
| transaction-id | 是 | String | 请求流水号（1000000000+YYYYMMDDhhmmss+6位序列） |
| sign | 是 | String | 签名 |
| req-time | 是 | String | 请求时间（YYYYMMDDhhmmss） |
1.5 请求参数（JSON Body）
| 参数名称 | 必填 | 类型 | 描述 | 示例 |
|---|---|---|---|---|
| feeTypeCd | 是 | String | 费用类型编码 | "1001" |
| feeName | 是 | String | 收费项目名称 | "物业费" |
| feeFlag | 是 | String | 费用标识 | "Y" |
| startTime | 是 | String | 计费起始时间（YYYY-MM-DD） | "2023-01-01" |
| endTime | 是 | String | 计费终止时间（YYYY-MM-DD） | "2023-12-31" |
| computingFormula | 是 | String | 计算公式 | "面积*单价" |
| squarePrice | 是 | BigDecimal | 计费单价 | 2.5 |
| additionalAmount | 是 | BigDecimal | 附加费用 | 100.00 |
| communityId | 是 | String | 小区ID | "123456" |
| billType | 是 | String | 出账类型 | "MONTHLY" |
| paymentCd | 是 | String | 付费类型 | "PREPAID" |
| paymentCycle | 是 | String | 缴费周期 | "MONTH" |
| state | 是 | String | 状态（"ENABLED"/"DISABLED"） | "ENABLED" |
1.6 返回值
| 参数名称 | 类型 | 描述 |
|---|---|---|
| code | String | 返回码（0=成功，非0=失败） |
| msg | String | 返回信息 |
| data | Object | 返回数据（通常为空） |
1.7 示例请求
POST /feeConfig/saveFeeConfig
Headers:
{
"Authorization": "Bearer xxxxxx",
"app-id": "micro-community",
"transaction-id": "100000000020231201143000000001",
"sign": "xxxxxx",
"req-time": "20231201143000"
}
Body:
{
"feeTypeCd": "1001",
"feeName": "物业费",
"feeFlag": "Y",
"startTime": "2023-01-01",
"endTime": "2023-12-31",
"computingFormula": "面积*单价",
"squarePrice": 2.5,
"additionalAmount": 100.00,
"communityId": "123456",
"billType": "MONTHLY",
"paymentCd": "PREPAID",
"paymentCycle": "MONTH",
"state": "ENABLED"
}
1.8 示例响应
{
"code": "0",
"msg": "成功",
"data": null
}
1.9 错误码
| 错误码 | 描述 |
|---|---|
| 1001 | 费用名称已存在 |
| 1002 | 必填参数缺失 |
| 1003 | 保存费用项失败 |
1.10 业务逻辑说明
- 参数校验：检查必填字段是否完整，并校验
feeName是否已存在。 - 生成唯一ID：自动生成
configId作为费用配置的唯一标识。 - 数据存储：调用
IPayFeeConfigV1InnerServiceSMO保存费用配置信息。 - 事务管理：使用
@Java110Transactional确保数据一致性。
2. 相关DTO类说明
2.1 FeeConfigDto
用于查询费用配置信息。
| 字段 | 类型 | 描述 |
|---|---|---|
| feeName | String | 费用名称 |
| communityId | String | 小区ID |
| isDefault | String | 是否默认（"T"/"F"） |
2.2 PayFeeConfigPo
用于存储费用配置信息。
| 字段 | 类型 | 描述 |
|---|---|---|
| configId | String | 配置ID |
| feeTypeCd | String | 费用类型编码 |
| feeName | String | 费用名称 |
| feeFlag | String | 费用标识 |
| startTime | String | 计费起始时间 |
| endTime | String | 计费终止时间 |
| computingFormula | String | 计算公式 |
| squarePrice | BigDecimal | 计费单价 |
| additionalAmount | BigDecimal | 附加费用 |
| communityId | String | 小区ID |
| billType | String | 出账类型 |
| paymentCd | String | 付费类型 |
| paymentCycle | String | 缴费周期 |
| state | String | 状态 |
3. 数据库操作
- 查询：
payFeeConfigV1InnerServiceSMOImpl.queryPayFeeConfigsCount() - 插入：
payFeeConfigV1InnerServiceSMOImpl.savePayFeeConfig()
4. 注意事项
- 唯一性校验：
feeName在同一小区下不能重复。 - 事务管理：保存操作具有事务性，失败时会回滚。
- 时间格式：
startTime和endTime必须为YYYY-MM-DD格式。
以上是完整的API文档，如需进一步优化或补充，请告知！