「OpenAPI」餐饮账单详情查询
接口说明
1、账单金额均为绝对值,不显示正负,调用时请注意账单的结算类型。
2、核销和撤销均会产生账单数据,多次核销和撤销则会产生多条数据。
使用限制
若查询的订单中包含“权益子品”类商品(例如0元兑换的权益商品),则响应参数的amount结构体不会返回 goods字段。这类商品因实际支付金额为0,系统在账单中不记录其商品明细金额信息。
SLA:支持的最大QPS:50;基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | https://open.douyin.com/goodlife/v1/settle/bill/catering_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
商户id(分账收款的商户)
bill_date必填String
核销日期 格式为"2006-01-02"
cursor必填String
查询游标
size必填Int64
页大小,取值范围1~50
biz_typeEnum
业务类型,团购-1, 外卖-2,买单-3, 点单-5
展开子属性
root_account_idString
总户id
withdraw_idString
提现单,优先级大于日期&游标
请求示例
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": { "cursor": "sGgBpKKpsA", "has_more": false, "ledger_records": [ { "account_id": "Dl2iEQ7URn", "amount": { "6RMrud6Zkq": 2917378475801588700 }, "associated_shop_order_id": "rc4dgreYCW", "bill_fund_id": "hZmQSJknU5", "biz_type": 1, "certificate_id": "eYRZixHidn", "code": "JEuobqrOx5", "flow_id": "S3fv8LPHU9", "fund_amount": 4660482248139694000, "fund_amount_type": 458046054602938940, "group_name": "tWEBVygGaA", "item_order_id": "JcKhmT8KJb", "ledger_id": "Jaw11qhTMj", "order_ext_id": "CQLKzJmtdc", "outer_verify_coupon_number": "w9qw7bTX2x", "outer_verify_order_number": "RFcWHAwFxg", "poi_id": "YO22zUP9JA", "product_sub_type": "n045BJX1ZK", "product_type": "H1xbLsfHDG", "settle_account_poi_id": "oA6zp2PbsR", "settle_sub_type": 6194428333546756000, "settle_time": 9084800008699437000, "settle_type": 9210694060051027000, "settle_type_desc": "rLi75AZP8e", "settlement_time": 6590593967779898000, "shop_order_id": "EnM0X8hzNd", "sku_id": "PvLBQGjhUn", "verify_id": "WtKUoJQqjM", "verify_out_order_id": "BqLNuou5QV", "verify_poi_account_id": "r51j4CzOkf", "verify_serial_num": 8799810586161325000 } ] }, "extra": { "description": "bY4DSUKGoJ", "error_code": 8523332240583162000, "logid": "A5PSwWbNBQ", "now": 2809592206887211500, "sub_description": "sgeMI4XSXg", "sub_error_code": 7185715780113839000 } }
错误码
| HTTP 状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 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 | 根据实际业务错误返回 | 联系抖音处理 |
| 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查看货款账户资金明细,根据收入和支出匹配货款到账情况 |
