综合账单详情查询
使用场景
用于生活服务综合行业商家查询账单明细。不同行业返回参数不同,其他行业商家请勿查询此接口。
接口说明
1、账单金额均为绝对值,不显示正负,调用时请注意账单的结算类型 。
2、核销和撤销均会产生账单数据,多次核销和撤销则会产生多条数据。
使用限制
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
展开子属性
响应示例
正常响应示例异常响应示例
{ "extra": { "error_code": 0, "description": "", "sub_error_code": 0, "sub_description": "", "logid": "20251203134752EB8636914EACBC047E61", "now": 1764740875 }, "data": { "cursor": "5csTVmJYjE", "ledger_records": [ { "product_sub_type": "krvcuB7WM0", "settle_account_poi_id": "5VG7ZZciDD", "order_tag": "pFuRfbvpRO", "fund_amount_type": 1805419848625715700, "flow_id": "xDZL4mJsCM", "verify_id": "JDuEVrSNCj", "verify_serial_num": 7372972978357998000, "amount": { "JVoqKhStpv": 7436063033209141000 }, "shop_order_id": "bjka0QrsTZ", "product_type": "IjhQMlgqub", "ledger_id": "w3X5HhEGGL", "outer_verify_coupon_number": "9cXBWEpGhR", "book_number": "T0KeTQZOeE", "bill_fund_id": "no3KzVr21u", "certificate_id": "6Jwx9VM4LC", "bill_trade_type": 1, "gov_company_name": "BB36RG0QAH", "settle_type": 2931092669920781000, "item_order_id": "NxE9u2UizY", "sku_id": "bQnIccFDIx", "settle_sub_type": 2622816110903240700, "settle_time": 6337582405543912000, "fund_amount": 5505974527464717000, "poi_id": "emxpri9QPW", "associated_shop_order_id": "oLlDC253O3", "code": "O1MZ4XXAFU", "biz_type": 1, "verify_out_order_id": "gEIvqlPrja", "account_id": "2a73Q4SRWl", "settle_type_desc": "mALVU5yYZP", "outer_verify_order_number": "q9swbFQYH4", "order_ext_id": "gAxpC9lIyS", "verify_poi_account_id": "P9sr9gkA1R", "group_name": "so54XlQpih" } ], "has_more": false, "error_code": 0, "description": "" } }
错误码
| 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 | 3000001 | 以实际错误信息为准 | |
| 200 | 5000001 | 服务器打瞌睡了,请稍后再试。 |
