查询企业账户余额
接口路径
http
GET /api/open/enterprise/:id/balance余额计算说明
各金额(人民币)计算方式:
充值余额(¥) = balance ÷ quota_per_unit × usd_exchange_rate
代金券余额(¥) = voucher_quota ÷ quota_per_unit × usd_exchange_rate
历史消耗(¥) = used_quota ÷ quota_per_unit × usd_exchange_rate
累计充值(¥) = top_up_quota ÷ quota_per_unit × usd_exchange_rate其中 quota_per_unit、usd_exchange_rate、quota_display_type 来自 查询系统状态(GET /api/open/status)。
若 quota_display_type = USD(美元),则去掉 × usd_exchange_rate。
请求参数
| 字段 | 类型 | 是否必传 | 说明 | 限制条件 | 备注 |
|---|---|---|---|---|---|
| id | int | 是 | 企业 ID | 路径参数 | 示例: 1001 |
请求示例
JSON
GET 'https://neolink.com/backend/api/open/enterprise/1001/balance'返回信息
| 字段 | 类型 | 是否必传 | 说明 | 备注 |
|---|---|---|---|---|
| success | bool | 是 | 请求是否成功 | 固定值 |
| message | string | 是 | 错误提示信息(成功时为空) | 固定值 |
| data | object | 是 | 企业账户余额信息对象 | 详见下表 |
返回数据字段说明
| 字段 | 类型 | 是否必传 | 说明 | 备注 |
|---|---|---|---|---|
| balance | int64 | 是 | 企业账户当前可用余额 | 单位为配额积分;包含已充值和代金券额度 |
| used_quota | int64 | 是 | 企业累计消耗配额 | 自企业创建以来的总消耗 |
| top_up_quota | int64 | 是 | 企业累计充值总额 | 通过支付充值的总金额转换后的配额 |
| voucher_quota | int64 | 是 | 企业使用的代金券总额 | 通过兑换码、促销等方式获得的配额 |
返回示例
JSON
成功响应
{
"success": true,
"message": "",
"data": {
"balance": 9000000,
"used_quota": 1200000,
"top_up_quota": 10000000,
"voucher_quota": 800000
}
}
错误响应
{
"success": false,
"message": "权限不足,无法查看该企业的余额"
}
{
"success": false,
"message": "企业不存在或已被删除"
}
{
"success": false,
"message": "企业已禁用,不能进行此操作"
}