额度流水¶
功能说明¶
- 包含所有员工额度流水,可以具体指定单个员工和单个额度资产账户,也可以查询全部员工;
- 流水记录包含了:1 消费,2 退款,6 发放,7 回收
接口地址¶
- 测试环境: https://openapi.guanaitong.tech/assets/limit/employee/record
- 生产环境: https://openapi.guanaitong.com/assets/limit/employee/record
HTTP请求方式¶
- Method: POST/GET
- Content-Type: application/x-www-form-urlencoded
参数说明¶
- 公有参数
发送请求是必须传入公共参数,详见公共参数
- 私有参数
| 参数名称 | 是否必须 | 参数类型 | 长度限制 | 描述 |
|---|---|---|---|---|
| userid | 否 | string | [1,100] | 员工第三方唯一标识,不会变更 |
| corp_code | 否 | string | [1,20] | 工号,用于历史对接不存在userid的情况,如果和userid同时传递,按照userid优先匹配 |
| account_openid | 否 | string | [1,50] | 如需指定账户查询,先通过员工资产账户查询获取account_openid |
| third_type | 否 | int | [1-5] | 1:企业微信, 2:钉钉,3:飞书,4, 定制, 5:标准对接,非必填默认5 |
| record_type | 否 | int | [0-2] | 流水类型:0.所有类型流水(1-11),1.交易类(1,2),2.发放回收类(6,7) |
| enterprise_code | 否 | string | [1,20] | 企业编号(集团和运营商必填,企业不填) |
| time_start | 否 | string | 19 | 流水时间范围,格式yyyy-MM-dd HH:mm:ss |
| time_end | 否 | string | 19 | 流水时间范围,格式yyyy-MM-dd HH:mm:ss |
| page_index | 否 | int | 开始页数,默认1 | |
| page_size | 否 | int | 显示行数,默认20,最大支持100条 |
请求示例¶
POST /assets/limit/employee/record HTTP/1.1
Host: openapi.guanaitong.tech
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache
# 查询该企业下所有额度的消费类流水record_type=1
access_token=f0920144cc3722e91adcb64a143385f0×tamp=1648789814&sign=17261c284c404aa6f5a6fe1b6ef01207b8dd2502&record_type=1
返回参数说明¶
| 参数名称 | 描述 |
|---|---|
| code | 返回码。详见错误返回码。 |
| msg | 如果错误,返回错误信息。 |
| data | 如果没有错误,返回业务数据 |
| data.total_count | 总数 |
| data.has_next | 是否有下一页 |
| data.data_list | 结果集 |
| data_list.serial_id | 流水Id(唯一) |
| data_list.time | 流水发生时间 |
| data_list.amount | 流水金额,入账是正数,出账是负数 |
| data_list.balance | 员工剩余金额 |
| data_list.fee_amount | 服务费 (支付和退款时存在服务费) |
| data_list.fee_charge_party | 服务费承担方 1员工 2企业 |
| data_list.outer_trade_no | 外部流水号(不唯一,支付和退款时同笔交易一致) |
| data_list.trade_no | 交易流水号(唯一) |
| data_list.userid | 员工唯一标识 |
| data_list.name | 员工姓名 |
| data_list.account_name | 发生流水的账户名称 |
| data_list.trade_type | 流水类型 (中文交易类型,如:发放、消费) |
| data_list.remark | 流水备注 |
正确返回示例¶
{
"code": 0,
"msg": "OK",
"data": {
"total_count": 4,
"data_list": [
{
"serial_id":"48990",
"time": "2022-03-30 17:00:00",
"amount": -100,
"fee_amount": -3,
"fee_charge_party": 1,
"balance": 0,
"outer_trade_no": "202203301700000001",
"trade_no": "202203301700000001",
"userid": "123456789",
"name": "张三",
"account_name": "关爱额度",
"trade_type": "消费",
"remark": "消费备注"
},
{
"serial_id":"68990",
"time": "2022-03-30 17:01:00",
"amount": 100,
"fee_amount": 3,
"fee_charge_party": 1,
"balance": 100,
"outer_trade_no": "202203301700000001",
"trade_no": "202203301700000002",
"userid": "123456789",
"name": "张三",
"account_name": "关爱额度",
"trade_type": "退款",
"remark": "退款备注"
},
{
"serial_id":"68994",
"time": "2022-03-30 17:06:00",
"amount": 100,
"balance": 200,
"outer_trade_no": "202203301700000987",
"trade_no": "",
"userid": "123456789",
"name": "张三",
"account_name": "关爱额度",
"trade_type": "发放",
"remark": "发放原因备注"
},
{
"serial_id":"49660",
"time": "2022-04-30 00:00:00",
"amount": -100,
"balance": 100,
"outer_trade_no": "202204301700000987",
"trade_no": "",
"userid": "123456789",
"name": "张三",
"account_name": "关爱额度",
"trade_type": "回收",
"remark": "关爱额度定期回收"
},
],
"has_next": false
}
}