HC小区接口文档

API接口文档:创建房屋费用


一、接口名称

创建房屋费用

二、接口描述

该接口用于为指定房屋创建费用记录,支持普通费用和租金递增模式。

三、接口路径

http://{ip}:{port}/app/fee.saveRoomCreateFee (Java110Cmd服务编码)

四、请求方法

POST

五、请求头

5.1 公共请求头

参数名称 必填 类型 描述
Authorization String 用户认证Token(Base token)
app-id String 应用ID(系统分配)
transaction-id String 请求流水号(唯一)
sign String 签名
req-time String 请求时间(YYYYMMDDhhmmss)

六、请求参数

6.1 请求体参数(JSON格式)

参数名称 必填 类型 描述 示例值
communityId String 小区ID "123456789"
locationObjId String 收费对象ID(房屋ID) "room1001"
configId String 收费项目配置ID "fee_config_001"
storeId String 商户ID "store_001"
startTime String 计费起始时间(格式:yyyy-MM-dd HH:mm:ss 或 yyyy-MM-dd) "2023-01-01 00:00:00"
endTime String 计费结束时间(格式同上,若未包含时间则自动补全为23:59:59) "2023-12-31"
rateCycle 条件 String 递增周期(仅当费用类型为租金递增时必填) "12"(单位:月)
rate 条件 String 递增率(仅当费用类型为租金递增时必填) "0.05"(5%)
rateStartTime 条件 String 递增开始时间(格式同上,仅当费用类型为租金递增时必填) "2023-06-01"

七、返回值

7.1 响应格式(JSON)

参数名称 类型 描述
code String 返回码(0成功,其他失败)
msg String 返回信息
data Object 返回数据(包含以下字段)
├─ totalRoom Integer 总处理房屋数(固定为1)
├─ successRoom Integer 成功房屋数(固定为1)
├─ errorRoom Integer 失败房屋数(固定为0)

八、示例请求

POST /fee.saveRoomCreateFee
Headers: 
{
  "Authorization": "Bearer xxxxx",
  "app-id": "micro-community",
  "transaction-id": "100000000020230101120000000001",
  "sign": "xxxxx",
  "req-time": "20230101120000"
}
Body:
{
  "communityId": "123456789",
  "locationObjId": "room1001",
  "configId": "fee_config_001",
  "storeId": "store_001",
  "startTime": "2023-01-01",
  "endTime": "2023-12-31",
  "rateCycle": "12",
  "rate": "0.05",
  "rateStartTime": "2023-06-01"
}

九、示例响应

{
  "code": "0",
  "msg": "成功",
  "data": {
    "totalRoom": 1,
    "successRoom": 1,
    "errorRoom": 0
  }
}

十、业务逻辑说明

  1. 参数校验

    • 校验必填字段(如小区ID、房屋ID等)。
    • 若费用类型为租金递增(COMPUTING_FORMULA_RANT_RATE),校验递增相关参数。
  2. 费用生成

    • 生成唯一批次号(batchId)。
    • 查询房屋和业主信息,关联费用记录。
    • 若启用账单模式(billModal=Y),直接返回成功。
  3. 数据存储

    • 保存费用主表(PayFeePo)和属性表(FeeAttrPo)。
    • 异步生成月费用数据和欠费记录。
  4. 特殊处理

    • 租金递增模式下,存储递增周期、递增率和开始时间。

十一、注意事项

  1. 时间格式支持 yyyy-MM-ddyyyy-MM-dd HH:mm:ss
  2. 租金递增参数仅在费用配置为 COMPUTING_FORMULA_RANT_RATE 时生效。
  3. 接口通过Java110Cmd框架调用,实际路径为服务编码(fee.saveRoomCreateFee)。