HC小区接口文档

基础接口

登陆接口 接口签名 员工接口

资产接口

小区接口 物业接口 楼栋接口 单元接口 房屋接口 交房 退房 车位接口 车辆接口

业主接口

业主接口 家庭成员 查询房屋认证 认证审核 账户接口 撤销账户明细

费用接口

费用项接口 创建费 查询费用 缴费接口 结束费用 缴费记录 水电抄表

工单接口

报修接口 投诉接口

查询小区业主账户信息

查询账户
账户预存

1. 接口名称

查询小区业主账户信息

2. 接口描述

该接口用于查询小区业主的账户信息，支持按业主ID、费用ID、小区ID等条件筛选，返回业主的账户余额、交易记录等数据。

3. 接口路径

POST http://{ip}:{port}/app/account.queryCommunityOwnerAccount（Java110Cmd 服务编码）

4. 请求方法

POST

5. 请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证 Token（Base Token，通过登录接口获取）
app-id 是 String 应用 ID（系统 dev 账户分配）
transaction-id 是 String 请求流水号（不能重复，格式：1000000000 + YYYYMMDDhhmmss + 6位序列）
sign 是 String 签名
req-time 是 String 请求时间（格式：YYYYMMDDhhmmss）

6. 请求参数

6.1 请求体参数（JSON）
参数名称 必填 类型 描述 示例
communityId 是 String 小区 ID "123456789"
ownerId 否 String 业主 ID "1001"
feeId 否 String 费用 ID（如果传此参数，会自动关联业主） "fee_001"
link 否 String 业主联系方式 "13800138000"
idCard 否 String 业主身份证号 "110101199001011234"
acctTypes 否 String 账户类型（多个用逗号分隔） "1001,1002"
page 否 Integer 当前页码（默认 1） 1
row 否 Integer 每页记录数（默认 10） 10

7. 返回值

7.1 返回数据结构（JSON）
参数名称 类型 描述
code String 返回码（0 表示成功，其他表示失败）
msg String 返回信息
data Object 返回数据（账户信息列表）
7.2 data 结构示例
{
  "code": "0",
  "msg": "成功",
  "data": [
    {
      "acctId": "acct_001",
      "acctName": "业主账户",
      "acctType": "1001",
      "balance": 1000.00,
      "status": "1",
      "createTime": "2023-01-01 00:00:00"
    }
  ]
}

8. 示例请求

POST /api/account.queryCommunityOwnerAccount
Headers:
{
  "Authorization": "Bearer xxxxxx",
  "app-id": "app_001",
  "transaction-id": "100000000020230101120000000001",
  "sign": "xxxxxx",
  "req-time": "20230101120000"
}
Body:
{
  "communityId": "123456789",
  "ownerId": "1001",
  "acctTypes": "1001,1002",
  "page": 1,
  "row": 10
}

9. 示例响应

{
  "code": "0",
  "msg": "成功",
  "data": [
    {
      "acctId": "acct_001",
      "acctName": "业主账户",
      "acctType": "1001",
      "balance": 1000.00,
      "status": "1",
      "createTime": "2023-01-01 00:00:00"
    }
  ]
}

10. 业务逻辑说明

  1. 参数校验

    • 必须传 communityId（小区 ID）。
    • 如果传 feeId，会自动查询关联的业主信息。
    • 支持分页查询（page 和 row）。

  2. 查询逻辑

    • 如果传 feeId，会先查询费用关联的业主（房屋、车位或合同）。
    • 根据 ownerId 或 feeId 查询业主账户信息。
    • 支持按 acctTypes 筛选账户类型。

  3. 安全性校验

    • 可通过 ownerGetDataCheckImpl.checkOwnerAccount 校验业主账户权限（当前代码中未启用）。

11. 错误码

错误码 描述
1001 小区 ID 不能为空
1002 费用 ID 不存在或关联业主失败
1003 分页参数错误
9999 系统异常

这样生成的 API 文档符合 RESTful 规范，并包含了请求、响应、业务逻辑等完整信息。