抖音开放平台Logo
开发者文档
控制台
  • 接入前准备
  • 通用能力
  • 餐饮
  • 大交通
  • 酒旅
  • 综合
  • 到综团购解决方案
  • KA 核销对账(综合定制接口)
  • 综合账单详情查询
  • 综合提现记录查询
  • 到综团购对接方案介绍
  • 综合到店提货解决方案
  • 线索管理解决方案
  • 历史版本文档(不推荐)
  • 使用场景​

    用于生活服务综合行业商家查询账单明细。不同行业返回参数不同,其他行业商家请勿查询此接口。​

    接口说明

    1、账单金额均为绝对值,不显示正负,调用时请注意账单的结算类型 。​

    2、核销后 1 小时内撤销或退款的订单,不会生成账单,无法通过本接口查询。​

    基本信息

    名称描述
    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"
    Query展开全部子属性
    account_id必填String
    示例:7216611034500000001

    获取方式:来客商户根账户ID,响应参数仅返回该商户 ID 的账单信息,不支持树级结构查询(入参总店账户 ID,不会返回分店收款的账户数据) ​

    bill_date必填String
    示例:2022-12-25

    结算日期,格式为"2022-12-25" ​

    cursor必填String
    示例:0

    查询游标,第一页查询传 0,翻页查使用上一次查询返回 cursor ​

    size必填Int64
    示例:50
    页大小,取值范围1~50
    biz_typeEnum
    业务类型 团购 1 买单 2 外卖 3 买单 5 点单
    展开子属性
    root_account_idString
    总户id
    withdraw_idString

    提现单号,可以根据该单号找到对应的分账明细​,如果需要通过提现单号来查询账单,结算日期字段也要传,优先取withdraw_id字段。


    获取方式:调用/goodlife/v1/settle/withdraw/composite_query/,从响应中可获取withdraw_id

    请求示例
    curl --location --request GET '/goodlife/v1/settle/bill/composite_query/?account_id=7113893944009705516&cursor=0&size=50&bill_date=2022-08-21 ' \ --header 'content-type: application/json' \ --header 'access-token: 0801121846735352506a356a6' \

    响应参数

    Body展开全部子属性
    dataStruct
    展开子属性
    extraStruct
    展开子属性
    响应示例
    正常响应示例异常响应示例
    { "data": { "cursor": "1000000000", "has_more": true, "ledger_records": [ { "account_id": "1000000000", "amount": { "actual_insured": 0, "broker_commission": 0, "crafts_man_commission": 0, "goods": 955, "ledger_platform_ticket": 0, "ledger_total": 990, "merchant_ticket": 610, "original": 1600, "pay": 990, "platform_ticket": 0, "talent_commission": 0, "total_agent_merchant": 10, "total_merchant_platform_service": 25, "total_operation_agent": 10 }, "certificate_id": "1000000000", "item_order_id": "1000000000", "ledger_id": "1000000000", "poi_id": "1000000000", "settle_time": 1692115093, "settle_type": 1, "settle_type_desc": "正向账单", "shop_order_id": "1000000000", "verify_id": "1000000000", "verify_poi_account_id": "1000000000", "sku_id": "1000000000", "order_ext_id": "1000000000", "group_ame": "爆品任选券", "code": "1000000000" } ], "description": "success", "error_code": 0 }, "extra": { "description": "success", "error_code": 0, "logid": "1000000000", "now": 1693481191, "sub_description": "", "sub_error_code": 0 } }

    错误码

    HTTP 状态码错误码错误码描述排查建议
    2003000001

    业务异常 ​

    对照接口文档规范参数并重试
    2004000001

    缺少必填参数 ​

    补充参数
    2004000002

    参数非法 ​

    对照接口文档规范参数并重试
    2005000001

    系统异常

    联系抖音处理
    2002100001
    未知错误
    重试接口,重试3次仍报错联系抖音生活服务技术支持
    2002100004
    系统繁忙,此时请开发者稍候再试
    重试接口,重试3次仍报错联系抖音生活服务技术支持
    2002100005
    参数不合法
    更换参数
    2002190002
    access_token无效
    调用接口重新生成access_token
    2002190004
    应用未获得该能力, 请去https://open.douyin.com/申请
    应用申请接口权限
    2002190008
    access_token过期,请刷新或重新授权
    规范token刷新机制,检查是否有测试环境在同步刷新token
    2002119001
    参数不合法
    更换参数
    2002119002
    系统繁忙,请稍候再试
    重试
    2002119003
    请求太过频繁,请稍后再试
    重试
    2002119005
    应用未获商家授权
    联系合作商家在商家后台发起授权,并在服务商后台同意授权
    2005000001
    服务器打瞌睡了,请稍后再试。
    2003000001
    以实际错误信息为准