企业管理 API

提供企业基本信息查询和账户流水查询的功能

企业管理

用于查询企业相关的基本信息和账户活动记录。

重要提示: 调用本分类下所有接口时,请务必在 HTTP 请求 Header 中携带有效的 appId, accessToken, userId (操作人ID), 和 source (来源标识) 作为通用认证参数。关于 source 参数的详细说明和取值,请参考快速开始章节。文档中的请求示例将仅展示放入 Body 中的业务参数。

POST /corp/baseInfo 企业基本信息查询

查询当前AccessToken关联企业的详细基本信息,包括名称、法人、认证状态、账户余额等。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring您的应用ID
accessTokenstring获取到的有效访问令牌
userIdinteger (int64)执行此操作的用户ID (操作人)

请求参数 (Body)

此接口请求 Body 为空。

请求示例

CURL
curl -X POST 'https://your-api-host.com/corp/baseInfo' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-d '{}'
									

响应

成功响应 (200 OK)
错误响应
{
  "code": "200",
  "msg": "成功",
  "data": {
    "corpCode": "CORP001",
    "corpName": "示例有限公司",
    "legalRepName": "张三",
    "legalRepIdentNo": "110101********001X",
    "identStatus": "identified",
    "corpLevel": 10,
    "levelExpireTime": "2025-12-31T23:59:59.000+0800",
    "maxAmount": 1000000,
    "accountBalance": 985,
    "payeeBalance": 50,
    "userNum": 50,
    "legalDate": "2020-01-15T00:00:00.000+0800",
    "adminInfo": {
      "userId": 20001,
      "userName": "张三管理员",
      "mobile": "13900139000",
      "userStatus": 0,
      "realName": "张三",
      "realNameStatus": 1
    }
  }
}
									
{
  "code": "401",
  "msg": "Invalid Access Token",
  "data": null
}
									

成功响应参数 (data 字段内 - 企业查询结果)

参数名类型描述
corpCodestring企业编码
corpNamestring企业名称
legalRepNamestring企业法定代表人名称
legalRepIdentNostring企业法定代表人证件号 (脱敏)
identStatusstring认证状态: identified (已认证), unidentified (未认证), invalid (认证已失效)
corpLevelinteger (int32)企业等级 (0:普通, 10-12:VIP1-3)
levelExpireTimestring (date-time)等级到期时间
maxAmountinteger (int32)黑金收款单笔限额最大金额
accountBalanceinteger (int32)合同份数余额
payeeBalanceinteger (int32)收款合同份数余额
userNuminteger (int32)企业员工数
legalDatestring (date-time)企业注册时间
adminInfoobject企业管理员信息 (用户状态实体类)
  adminInfo.userIdinteger (int64)管理员用户id
  adminInfo.userNamestring管理员用户名称
  adminInfo.mobilestring管理员手机号
  adminInfo.userStatusinteger (int32)管理员用户状态 (0: 有效, 1: 无效)
  adminInfo.realNamestring管理员真实姓名
  adminInfo.realNameStatusinteger (int32)管理员实名状态 (0: 未实名, 1: 已实名)
POST /corp/queryAccountHistoryList 查询企业账户流水记录

根据筛选条件查询企业账户(合同份数)的变动流水记录,支持分页。

请求 Header (通用认证参数)

参数名类型必填描述
appIdstring您的应用ID
accessTokenstring获取到的有效访问令牌
userIdinteger (int64)执行此操作的用户ID (操作人)

请求参数 (Body - GetAccountHistoryQueryReq)

参数名 类型 必填 描述
listPageNo integer (int32) 当前页码,从1开始,默认1
listPageSize integer (int32) 每页数量,默认10或20
signFlowCode string 合同流程编码 (筛选条件)
signFlowName string 合同流程名称 (筛选条件)
initPsnName string 发起人名称 (筛选条件)
recordType string 流水类型 (筛选条件): newUserPresent, signContract, signCancel, orderBuy, adminRecharge, adminContract, orderExpire, crmOrderPresent, crmOrderBuy, reverseReturn 等
orderCode string 套餐编码 (筛选条件)
beginTime string (date-time) 开始时间 (YYYY-MM-DD HH:mm:ss) (筛选条件)
endTime string (date-time) 结束时间 (YYYY-MM-DD HH:mm:ss) (筛选条件)

请求示例

CURL
curl -X POST 'https://your-api-host.com/corp/queryAccountHistoryList' \
-H 'Content-Type: application/json' \
-H 'appId: YOUR_APP_ID' \
-H 'accessToken: YOUR_ACCESS_TOKEN' \
-H 'userId: YOUR_USER_ID' \
-d '{
  "listPageNo": 1,
  "listPageSize": 10,
  "recordType": "signContract",
  "beginTime": "2024-01-01 00:00:00"
}'
									

响应

成功响应 (200 OK)
错误响应
{
  "code": "200",
  "msg": "成功",
  "listPageNo": 1,
  "countInPage": 1,
  "listPageCount": 1,
  "totalCount": 1,
  "data": [
    {
      "id": 12345,
      "corpCode": "CORP001",
      "corpName": "示例有限公司",
      "recordType": "signContract",
      "recordName": "签合同扣减",
      "count": -1,
      "accountBalance": 985,
      "signFlowId": 5001,
      "signFlowCode": "FLOW20240115001",
      "signFlowName": "销售合同审批流程",
      "initPsnName": "李四",
      "orderCode": null,
      "remark": "签署了销售合同",
      "createTime": "2024-01-15T10:30:00.000+0800"
    }
  ]
}
									

注意: 分页信息 listPageNo, countInPage, listPageCount, totalCount 包含在响应的最外层。

{
  "code": "1002",
  "msg": "Invalid parameter: recordType",
  "data": null
}
									

成功响应参数 (data 字段内数组元素的结构 - GetAccountHistoryListRes)

参数名类型描述
idinteger (int64)流水ID
corpCodestring企业编码
corpNamestring企业名称
recordTypestring流水类型代码 (参考请求参数中的描述)
recordNamestring流水类型名称
countinteger (int32)变动数量 (负数为扣减)
accountBalanceinteger (int32)变动后账户剩余合同份数
signFlowIdinteger (int64)关联的合同流程ID
signFlowCodestring关联的合同流程编码
signFlowNamestring关联的合同流程名称
initPsnNamestring发起人名称
orderCodestring关联的套餐编码 (若适用)
remarkstring备注信息
createTimestring (date-time)流水记录创建时间