综合账单详情查询
使用场景
用于生活服务综合行业商家查询账单明细。不同行业返回参数不同,其他行业商家请勿查询此接口。
接口说明
1、账单金额均为绝对值,不显示正负,调用时请注意账单的结算类型 。
2、核销和撤销均会产生账单数据,多次核销和撤销则会产生多条数据。
3、按照实际撤销核销的时间生成逆向账单
使用限制
SLA:支持的最大QPS:50;
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/settle/bill/composite_query/ |
| HTTP Method | GET |
| Scope | life.capacity.billing.detail |
| 权限要求 |
|
请求参数
请求头
access-token必填String
示例:clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-type必填String
固定值"application/json"
Rpc-Transit-Life-AccountString
来客商户根账户ID
Query展开全部子属性
account_id必填String
示例:7216611034500000001
来客商户根账户ID,获取方式:登录来客账号右上角-账户ID,如下图
响应参数仅返回该商户 ID 的账单信息,不支持树级结构查询(如:入参总店账户 ID,不会返回分店收款的账户数据) ,如果需要查询总账户以及门店账户的的全部数据,需要传root_account_id字段,account_id为必填字段,和root_account_id保持一致即可
bill_date必填String
示例:2022-12-25
结算日期,格式为"2022-12-25"
cursor必填String
示例:0
查询游标,第一页查询传 0,翻页查使用上一次查询返回 cursor
size必填Int64
示例:50
页大小,取值范围1~50
biz_typeEnum
业 务类型 团购-1, 买单-3, 点单-5
展开子属性
root_account_idString
总户id
如果传了root_account_id,可以查询到总户以及门店户的所有账单数据,account_id为必填字段,和root_account_id保持一致即可
withdraw_idString
提现单号,可以根据该单号找到对应的分账明细,如果需要通过提现单号来查询账单,结算日期字段也要传,优先取withdraw_id字段。
获取方式:调用综合提现记录查询,从响应中可获取withdraw_id
请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/settle/bill/composite_query/?size=3775734082983261170&bill_date=tmRE8dhJ7v&withdraw_id=iHSc8UpLKv&root_account_id=mup7nlLFpt&biz_type=1&account_id=nxBxxwXV2n&cursor=nBR4PYDWYM' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \
响应参数
Body展开全部子属性
extra必填Struct
扩展信息
展开子属性
dataStruct
data
展开子属性
响应示例
正常响应示例异常响应示例
{ "data": { "cursor": "tdnswIt76z", "has_more": false, "ledger_records": [ { "account_id": "aj5cNeDXJZ", "amount": { "CqS4rpu7NQ": 2867171446496690000 }, "associated_shop_order_id": "l2KxigGjL3", "bill_fund_id": "wcHfwSppg0", "bill_trade_type": 1, "biz_type": 1, "book_number": "Uk7HwDUS2C", "certificate_id": "XPD9yM5Z0w", "code": "jd2TqaKo10", "flow_id": "1FYGAmPrsI", "fund_amount": 315941644319301300, "fund_amount_type": 5243946213279464000, "gov_company_name": "G0t2E6NOo2", "group_name": "GBme8B0FHa", "item_order_id": "hawL0ApHdb", "ledger_id": "1q0GCEWPK0", "order_ext_id": "WEulR8d0Ze", "order_tag": "KZtPncYVf0", "outer_verify_coupon_number": "FQfUN97STM", "outer_verify_order_number": "PJrfzRYQCi", "poi_id": "JtqWvVzIhx", "product_sub_type": "商场权益卡-101 品牌代金券-1101 代金券意向金-1102 商场权益卡(MRC)-1103 先买后约-1301 三方比价-1302 景区日历票-1303 旅行社-1304 日历房-1305 演出票务-1306 餐饮订座-1307 线路预订品-1309 旅行社预售-1201 平台通兑券-1801 商家通兑券-1802 平台通兑品-1803 商家通兑品-1804 预约默认-2201 接待单元默认-2401 会员折扣卡-2601 平台聚合品-2701 商家聚合品-2702 次卡-周期卡-1501 提货券-2801 在线点单商品-2802 储值卡-2901", "product_type": "团购套餐-1 虚拟商品-2 预售券-3 民宿-4 门票-5 外卖-6 旅行跟拍-7 一日游-8 售卖的房子-9 懂车帝-10 代金券-11 预售v2-12 预定-13 配送商品-14 次卡-15 外卖(专项服务商)-16 外卖聚合品(MSPU)-17 通兑权益-18 外卖预售券-19 线索类-20 附属商品-21 预约商品-22 即时零售-23 接待单元-24 线索收集-25 营销资产-26 聚合品-27 零售品-28 储值卡-29", "settle_account_poi_id": "2B8xS71dr4", "settle_sub_type": 98242465814601680, "settle_time": 2132351444263829500, "settle_type": 8360704564721357000, "settle_type_desc": "uyduDybCNl", "settlement_time": 1147643071540344000, "shop_order_id": "fOhEIgmVel", "sku_id": "utN9WNVt0f", "verify_id": "uonLINGmBD", "verify_out_order_id": "1MTwE02fE3", "verify_poi_account_id": "ay6g6U05SJ", "verify_serial_num": 6254072785191953000 } ] }, "extra": { "description": "g5HCslw0AJ", "error_code": 4388237532406111700, "logid": "KSvMo6wLz0", "now": 3992197415672397000, "sub_description": "GVUzdUuiM0", "sub_error_code": 5490552048265026000 } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 3000001 | 业务异常 | 对照接口文档规范参数并重试 |
| 200 | 4000001 | 缺少必填参数 | 补充参数 |
| 200 | 4000002 | 参数非法 | 对照接口文档规范参数并重试 |
| 200 | 5000001 | 系统异常 | 联系抖音处理 |
| 200 | 2100001 | 未知错误 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100004 | 系统繁忙,此时请开发者稍候再试 | 重试接口,重试3次仍报错联系抖音生活服务技术支持 |
| 200 | 2100005 | 参数不合法 | 更换参数 |
| 200 | 2190002 | access_token无效 | 调用接口重新生成access_token |
| 200 | 2190004 | 应用未获得该能力, 请去https://open.douyin.com/申请 | 应用申请接口权限 |
| 200 | 2190008 | access_token过期,请刷新或重新授权 | 规范token刷新机制,检查是否有测试环境在同步刷新token |
| 200 | 2119001 | 参数不合法 | 更换参数 |
| 200 | 2119002 | 系统繁忙,请稍候再试 | 重试 |
| 200 | 2119003 | 请求太过频繁,请稍后再试 | 重试 |
| 200 | 2119005 | 应用未获商家授权 | 联系合作商家在商家后台发起授权,并在服务商后台同意授权 |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 | |
| 200 | 3000001 | 以实际错误信息为准 |
