查询账单集¶
功能说明¶
客户每天分页定时查询关爱通产生的费控账单集合,包含订单,申请单和审批单详情。
接口地址¶
- 测试环境: https://openapi.guanaitong.tech/enterprise/expense/billAgg/find
- 生产环境: https://openapi.guanaitong.com/enterprise/expense/billAgg/find
HTTP请求方式¶
- Method: POST
- Content-Type: application/x-www-form-urlencoded
参数说明¶
- 公有参数
发送请求是必须传入公共参数,详见公共参数
- 私有参数
| 参数名称 | 是否必须 | 参数类型 | 长度限制 | 描述 |
|---|---|---|---|---|
| enterprise_code | 否 | string | [1,20] | 企业编号(集团和运营商必填,企业不填) |
| outer_trade_no | 否 | string | [1,50] | 交易单号 |
| time_start | 否 | datetime | [19] | 账单开始时间 格式:yyyy-MM-dd HH:mm:ss |
| time_end | 否 | datetime | [19] | 账单结束时间 格式:yyyy-MM-dd HH:mm:ss |
| page_no | 否 | int | 开始页数,默认1 | |
| page_size | 否 | int | 显示行数,默认20,最大支持50条 |
请求示例¶
POST /enterprise/expense/billAgg/find HTTP/1.1
Host: openapi.guanaitong.tech
Content-Type: application/x-www-form-urlencoded
cache-control: no-cache
access_token=fdd9318db2fdf96f152226231d2b8f49&sign=6fc42a2a0fd3f3fb0602da732272bee406bef5e8×tamp=1584590939&time_start=2022-08-01 00:00:00&time_end=2022-08-01 23:59:59
返回参数说明¶
| 参数说明 | 描述 |
|---|---|
| code | 返回码,0代表正确返回 |
| msg | 如果错误,返回错误信息。 |
| data | 如果没有错误,返回业务数据,此处返回Pagination<BillVO> |
BillVO对象¶
| 字段名 | 描述 |
|---|---|
| bill_no | 交易流水号账单编号 |
| userid | 员工账号ID |
| bill_type | 交易类型:1-消费 2-退款; |
| enterprise_pay_amount | 企业支付金额 |
| enterprise_refund_amount | 企业退款金额 |
| fee_amount | 服务费金额 |
| settle_amount | 结算金额 |
| occur_time | 支付或退款发生时间 |
| related_bill_no | 如果是退款单,则返回关联的支付账单号 |
| voucher_status | 凭证上传状态:1-已上传 2-未上传 3-无需上传 |
| order_detail | 订单详情,参考OrderDetailVO |
| request_detail | 申请单详情,参考RequestDetailVO |
| approve_detail | 审批单详情,参考ApproverDetailVO |
OrderDetailVO 订单详情¶
| 字段名 | 描述 |
|---|---|
| consume_type | 消费类型:1-到店,2-外卖; |
| outer_trade_no | 外部交易号 |
| receiver | 收货人信息=>{name:'收货人名称',address:'收货地址'} |
| commodity_list | 商品明细列表=>[{price:'单价',name:'商品名',count:'商品数量'},{...}] |
| shop | 店铺信息=> {city:'店铺城市', name:'店铺名',address:'店铺地址'} |
RequestDetailVO对象¶
| 字段名 | 描述 |
|---|---|
| request_no | 申请单号 |
| expense_item_list | 费用事由列表 ,一级费用事由、二级费用事由 |
| cost_center_code | 成本中心编码 |
| cost_center_name | 成本中心名称 |
| person_count | 人数 |
| person_amount | 人均费用 |
| total_amount | 费用合计 |
| used_amount | 已使用金额 |
| available_amount | 可用金额 |
| effective_start | 生效开始时间 |
| effective_end | 生效结束时间 |
| peer_userid_list | 同行人列表 |
ApproverDetailVO对象¶
| 字段名 | 描述 |
|---|---|
| approve_no | 审批单号 |
| approve_ext_no | 外部审批单号 |
| approve_amount | 审批金额 |
| approve_time | 审批时间 |
| approve_result | 审批结果 1通过 2驳回 |
| approve_item | 审批事由 |
| approve_reason | 审批原因 |
| effective_start | 生效开始时间 |
| effective_end | 生效结束时间 |
正确返回示例¶
{
"code": 0,
"data": {
"dataList": [
{
"bill_no": "2022080132432345",
"userid": "BCG029321",
"bill_type": 1,
"enterprise_pay_amount": 90.00,
"enterprise_refund_amount": null,
"fee_amount": 3.00,
"settle_amount": 93.00,
"occur_time": "2022-08-01 12:03:02",
"related_bill_no": null,
"voucher_status": 1,
"order_detail":{
"outer_trade_no": "34385438543",
"consume_type": 2,
"receiver":{"name":"Jerry O'Reilly","address":"173 Collier Crest North Eunabury, SC 83698-7549"},
"commodity_list":[{"price":10.00,"name":"可口可乐","count":1},{"price":80.00,"name":"双色鱼头","count":1}],
"shop":{"city":"上海","name":"神旺大酒店","address":"647 Mante Island Apt. 328 Schinnerchester, DC 70876"}
},
"request_detail":{
"request_no":"21321321",
"expense_item_list": ["一级事由","二级事由"],
"cost_center_code":"a1234",
"cost_center_name":"成本中心A",
"person_count": 10,
"person_amount": 30.00,
"total_amount": 300.00,
"used_amount": 180.00,
"available_amount": 120.00,
"effective_start": "2022-01-01 00:00:00",
"effective_end": "2022-12-31 23:59:59",
"peer_userid_list":["FS090341-8073672","FS098231-6673984"]
},
"approve_detail":{
"approve_no":"3214324",
"approve_ext_no":"HLY3213214",
"approve_amount":300.00,
"approve_time": "2022-08-01 12:01:12",
"approve_result": 1,
"approve_item": "事由信息",
"approve_reason": "审批原因",
"effective_start": "2022-01-01 00:00:00",
"effective_end": "2022-12-31 23:59:59"
}
},
{
"bill_no": "2022080590938453",
"userid": "BCG028093",
"bill_type": 1,
"enterprise_pay_amount": 180.00,
"enterprise_refund_amount": null,
"fee_amount": 3.00,
"settle_amount": 183.00,
"occur_time": "2022-08-01 12:03:02",
"related_bill_no": null,
"voucher_status": 1,
"order_detail":{
"outer_trade_no": "34385438543",
"consume_type": 2,
"receiver":{"name":"Robb Pfeffer","address":"787 Leilani Canyon South Betty, TN 03242-4912"},
"commodity_list":[{"price":10.00,"name":"可口可乐","count":8},{"price":100.00,"name":"大盘鸡","count":1}],
"shop":{"city":"上海","name":"吉祥小混沌","address":"162 Cole Key Suite 165 Lake Donato, KY 66518-0930"}
},
"request_detail":{
"request_no":"839543543",
"expense_item_list": ["一级事由","二级事由"],
"cost_center_code":"a1234",
"cost_center_name":"成本中心A",
"person_count": 10,
"person_amount": 30.00,
"total_amount": 300.00,
"used_amount": 180.00,
"available_amount": 120.00,
"effective_start": "2022-01-01 00:00:00",
"effective_end": "2022-12-31 23:59:59",
"peer_userid_list":["FS090341-8073672","FS098231-6673984"]
},
"approve_detail":{
"approve_no":"209354384668",
"approve_ext_no":"HLY3219384",
"approve_amount":500.00,
"approve_time": "2022-08-01 12:01:12",
"approve_result": 1,
"approve_item": "事由信息",
"approve_reason": "审批原因",
"effective_start": "2022-01-01 00:00:00",
"effective_end": "2022-12-31 23:59:59"
}
}
],
"hasNext": false,
"totalCount": 2
},
"msg": "OK"
}