抖音开放平台Logo
控制台

餐饮账单详情查询

更新时间 2024-10-28 04:02:25
收藏
我的收藏
用于生活服务餐饮行业商家查询账单明细。不同行业返回参数不同,其他行业商家请勿查询此接口。​

使用限制​

无。​

接口说明​

1、账单金额均为绝对值,不显示正负,调用时请注意账单的结算类型。​
2、核销后 1 小时内撤销或退款的订单,不会生成账单,无法通过本接口查询。​

基本信息​

HTTP URL
HTTP Method
GET​
申请权限
商家账单明细​
权限要求
    需要申请权限,路径:抖音开放平台-开发者平台/服务商平台>控制台>应用详情>解决方案 ​
    需要商家授权,路径:抖音来客>店铺管理>服务应用授权​

请求头​

参数
描述
必须
Content-Type​
application/json​
是​
access-token​
根据这个地址获取的 token​
是​

请求参数​

参数名称
参数类型
参数描述
必需
root_account_id​
string ​
品牌商户 ID,响应参数返回该品牌下所有门店的账单信息​
当没有 account_id 时,该值必传​
account_id ​
string ​
商户 ID,响应参数仅返回该商户 ID 的账单信息,不支持树级结构查询(入参总店账户 ID,不会返回分店收款的账户数据) ​
当没有 root_account_id 时,该值必传​
cursor​
string​
查询游标,第一页查询传 0,翻页查使用上一次查询返回 cursor​
是​
size​
int32​
页大小,取值范围 1~50​
是​
bill_date​
string​
结算日期,格式为"2022-12-25"​
是​
withdraw_id​
string​
提现单号,可以根据该单号找到对应的分账明细​
如果需要通过提现单号来查询账单,结算日期字段也要传,优先取withdraw_id字段生效​

请求示例​

Bash
复制
https://open.douyin.com/goodlife/v1/settle/bill/catering_query/?account_id=7113893944009705516&cursor=0&size=50&bill_date=2022-08-21

响应参数​

参数名称
参数类型
参数描述
cursor​
string​
若有下页,通过此 cursor 查询下一页​
has_more​
bool​
是否有下一页​
biz_type​
int​
业务类型。1:团购 3:买单 5:点单​
ledger_records​
ledger_id​
string​
账单 ID​
account_id​
string​
商家账户 ID。请注意辨别总店/分店收款,如该订单收款方式=总店收款,则此处展示总店账户 ID,不展示分店账户 ID​
shop_order_id​
string​
shop 维度订单 ID​
item_order_id​
string​
item 维度订单 ID​
settle_type​
int​
结算类型。枚举值包括:1-正向账单,2-退款单,3-退款手续费 4-商家欠款欠收,5-机构/达人发票逾期补偿​
settle_type_desc​
string​
结算类型描述。根据结算类型,返回枚举值的中文含义,例如:退款单​
settle_sub_type​
int64​
子结算类型:21-商责赔付冻结,22-商责赔付解冻,23-商责赔付扣款,24-商责赔付索赔​
25-商责扣罚冻结,26-商责扣罚解冻,27-商责扣罚扣款,28-商责扣罚索赔​
30-以赔代退冻结,31-以赔代退解冻,32-以赔代退扣罚,33-以赔代退索赔​
settle_time​
int64​
结算时间。正向账单返回核销完成时间;退款单,退款手续费返回账单创建时间。精确到秒 ​
amount​
pay​
int64​
用户实付金额。包含支付渠道优惠的金额。单位:分。示例:用户使用抖音支付,银行卡扣款 99.4 元,抖音支付优惠 0.6 元,此处返回用户实付金额=100 元​
deduction_discount​
int64​
团购券抵扣金额 ,该部分金额无需参与结算。代金券团购券单独结算。单位“分”​
merchant_ticket​
int64​
商家优惠补贴(该部分金额无需参与与结算)。单位:分​
platform_ticket ​
int64​
抖音平台补贴。单位:分​
24.3.31 后不给 isv 技术服务商展示
ledger_platform_ticket​
int64​
实际参与结算的平台优惠券金额。单位:分​
24.3.31 后不给 isv 技术服务商展示
original​
int64​
交易金额、订单实收。等于抖音平台补贴+用户实付金额+商家优惠金额,单位:分​
ledger_total​
int64​
应结算金额。等于用户实付金额+实际参与结算的平台优惠券金额,单位:分​
total_commission​
int64​
佣金汇总金额,包含平台佣金和所有达人服务费佣金金额。单位:分​
24.2.29 新上线
actual_insured​
int64​
实付保险费用。由保司收取,单位:分​
total_agent_merchant​
int64​
服务商分佣总金额。单位:分​
24.3.31 后不给 isv 技术服务商展示
total_merchant_platform_service​
int64​
软件服务费。已包含支付手续费,单位:分​
24.3.31 后不给 isv 技术服务商展示
total_operation_agent​
int64​
代运营服务商总佣金。非合并计算时等于服务商佣金;需要合并计算时等于服务商佣金+达人佣金。单位:分​
24.3.31 后不给 isv 技术服务商展示
talent_commission​
int64​
达人佣金。包含星图达人、税筹达人、机构达人和非机构达人,单位:分​
24.3.31 后不给 isv 技术服务商展示
broker_commission​
int64​
撮合经纪服务费。单位:分​
24.3.31 后不给 isv 技术服务商展示
clerk_commission​
int64​
店员佣金。单位:分​
24.3.31 后不给 isv 技术服务商展示
mall_store_goods​
int64​
店员佣金。单位:分​
商场店铺分佣​
goods​
int64​
商家实际结算金额(原名“商家货款”,来客导出数据中名称=提现金额)。单位:分​
certificate_id​
string​
券 ID。券的唯一标识​
verify_id​
string​
核销 ID​
poi_id​
string​
核销门店 poi ID。不等同于账户 ID​
verify_poi_account_id​
string​
核销门店的账户 ID。不等同于收款账户 ID​
sku_id​
string​
商品 ID​
order_ext_id​
string​
外部订单 ID,不存在时不返回​
fund_amount_type​
int64​
1 入账 2 出账​
fund_amount​
int64​
款项金额​
group_name​
string​
商品名称,不存在时不返回​
code​
string​
券码,用户实际核销时使用的券码​

响应示例​

正常示例​

JSON
复制
{
"data": {
"cursor": "1000000000",
"has_more": true,
"ledger_records": [
{
"account_id": "1000000000",
"amount": {
"actual_insured": 0,
"broker_commission": 0,
"clerk_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_name": "爆品任选券",
"code": "1000000000"
}
]
},
"extra": {
"description": "success",
"error_code": 0,
"logid": "1000000000",
"now": 1693481191,
"sub_description": "",
"sub_error_code": 0
}
}

异常示例​

Django
复制
{
"data":{
"error_code":2190002,
"description":"access_token无效"
},
"extra":{
"error_code":2190002,
"description":"access_token无效",
"sub_error_code":0,
"sub_description":"access_token无效",
"logid":"1000000000",
"now":1717037904659
}
}

错误码​

HTTP 状态码
错误码
描述
排查建议
200​
3000001​
业务异常​
对照接口文档规范参数并重试​
200​
4000001​
缺少必填参数​
补充参数​
200​
4000002​
参数非法​
对照接口文档规范参数并重试​
200​
5000001​
系统异常​
联系抖音处理​
200​
6000001​
非自动提现​
手动提现记录无法查询对应账单,请您至 【财务首页】-【交易账户详情】https://life.douyin.com/p/finance/v2/transaction/account?groupid=1751624323825741&life_account_id=7174636309414152206查看货款账户资金明细,根据收入和支出匹配货款到账情况
200​
6000002​
无账单明细​
商家账单已经被手动提现,请您至 【财务首页】-【交易账户详情】https://life.douyin.com/p/finance/v2/transaction/account?groupid=1751624323825741&life_account_id=7174636309414152206查看货款账户资金明细,根据收入和支出匹配货款到账情况