HC小区接口文档

API接口文档:费用配置列表查询

查询费用项
删除费用项
保存费用项
修改费用项

一、接口名称

查询费用配置列表

二、接口描述

查询指定小区的费用配置列表,支持分页查询,并可筛选特定状态或类型的费用配置。

三、接口路径

http://{ip}:{port}/app/feeConfig.listFeeConfigs

四、请求方法

POST

五、请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证Token,通过登录接口获取
app-id 是 String 应用ID,系统dev账户分配
transaction-id 是 String 请求流水号,格式:1000000000+YYYYMMDDhhmmss+6位序列(需保证唯一性)
sign 是 String 签名,按系统规则生成
req-time 是 String 请求时间,格式:YYYYMMDDhhmmss

六、请求参数

6.1 请求体(JSON格式)

参数名称 必填 类型 描述 示例值
communityId 是 String 小区ID "123456789"
page 否 Integer 当前页码(默认1) 1
row 否 Integer 每页记录数(默认10) 10
feeTypeCd 否 String 费用类型编码,可选筛选条件 "1001"
feeName 否 String 费用名称模糊查询 "物业费"
isFlag 否 String 特殊标志(0表示不分页,返回全部数据) "0"

七、返回值

7.1 响应格式(JSON)

参数名称 类型 描述
code String 返回码,0表示成功
msg String 返回信息
data Object 返回数据,结构见下表

data字段结构:

参数名称 类型 描述
total Integer 总记录数
records Integer 总页数
feeConfigs Array 费用配置列表,元素结构见下表

feeConfigs元素结构:

参数名称 类型 描述
configId String 费用配置ID
feeTypeCd String 费用类型编码
feeName String 费用名称
squarePrice String 单价(元/平方米)
additionalAmount String 附加金额
communityId String 所属小区ID

八、示例请求

请求示例(带分页)

{
  "communityId": "123456789",
  "page": 1,
  "row": 10,
  "feeTypeCd": "1001"
}

请求示例(不分页)

{
  "communityId": "123456789",
  "isFlag": "0"
}

九、示例响应

成功响应(分页)

{
  "code": "0",
  "msg": "成功",
  "data": {
    "total": 5,
    "records": 1,
    "feeConfigs": [
      {
        "configId": "1001",
        "feeTypeCd": "1001",
        "feeName": "物业费",
        "squarePrice": "2.50",
        "additionalAmount": "0.00",
        "communityId": "123456789"
      }
    ]
  }
}

成功响应(不分页)

{
  "code": "0",
  "msg": "成功",
  "data": {
    "total": 5,
    "records": 5,
    "feeConfigs": [
      {
        "configId": "1001",
        "feeTypeCd": "1001",
        "feeName": "物业费",
        "squarePrice": "2.50",
        "additionalAmount": "0.00",
        "communityId": "123456789"
      },
      {
        "configId": "1002",
        "feeTypeCd": "1002",
        "feeName": "停车费",
        "squarePrice": "5.00",
        "additionalAmount": "0.00",
        "communityId": "123456789"
      }
    ]
  }
}

错误响应(缺少小区ID)

{
  "code": "1",
  "msg": "未包含小区ID",
  "data": null
}

十、业务逻辑说明

  1. 参数校验:
    • 必填字段 communityId 校验,缺失时返回错误。
    • 分页参数(page、row)默认值为1和10。
  2. 数据查询:
    • 调用 IFeeConfigInnerServiceSMO.queryFeeConfigs 查询数据列表。
    • 调用 IFeeConfigInnerServiceSMO.queryFeeConfigsCount 查询总数。
  3. 数据处理:
    • 金额字段(squarePrice、additionalAmount)去除小数点后无效的0。
  4. 分页逻辑:
    • 当 isFlag=0 时,忽略分页参数,返回全部数据。

十一、注意事项

  • 金额字段为字符串类型,前端需自行转换为数值类型处理。
  • 签名(sign)生成规则需参考系统统一规范。