淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
statement_bill_query	StatementBillQuery	可选			对账单号
└ statement_bill_code String 可选 HDB 对账单号

名称	类型	示例值	描述
result	CommonResult	{}	接口结果
└ code String PARAM_INVALID 错误码 data StatementBillDto 账单信息创建的互动实例 └ settlement_company_code String FIN_001 结算主体编码 └ operate_type_desc String 经销标准经营属性描述 └ operate_type String DISTRIBUTE 经营属性 └ business_partner_name String 测试供应商供应商名称 └ business_partner_code String S001 供应商编码 └ merchant_code String MAOCHAO 商家编码 └ statement_bill_code String HDB201907102019071012345 对账单号 └ settlement_company_name String xx公司结算主体名称 └ bill_day String 2020-01-01 00:00:00 账单日 └ bill_status String 103 订单状态 └ bill_status_desc String 已付款订单状态描述 └ settlement_total_amount String 100.00 应结算总金额 └ invoice_total_amount String 100.00 应开票总金额 └ settle_perid_desc String 货到结算周期描述 └ currency String CNY 币种 └ success Boolean true 服务标识 └ message String 缺少参数或参数错误错误信息 └ biz_exception Boolean true 服务标识

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TmallTxcsFinanceBillQueryRequest req = new TmallTxcsFinanceBillQueryRequest();
TmallTxcsFinanceBillQueryRequest.StatementBillQuery obj1 = new TmallTxcsFinanceBillQueryRequest.StatementBillQuery();
obj1.setStatementBillCode("HDB");
req.setStatementBillQuery(obj1);
TmallTxcsFinanceBillQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TmallTxcsFinanceBillQueryRequest req = new TmallTxcsFinanceBillQueryRequest();
TmallTxcsFinanceBillQueryRequest.StatementBillQueryDomain obj1 = new TmallTxcsFinanceBillQueryRequest.StatementBillQueryDomain();
obj1.StatementBillCode = "HDB";
req.StatementBillQuery_ = obj1;
TmallTxcsFinanceBillQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TmallTxcsFinanceBillQueryRequest;
$statement_bill_query = new StatementBillQuery;
$statement_bill_query->statement_bill_code="HDB";
$req->setStatementBillQuery(json_encode($statement_bill_query));
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=tmall.txcs.finance.bill.query' \
-d 'partner_id=apidoc' \
-d 'session=01d8d390-e6cd-4787-81dd-a099c1307c64' \
-d 'sign=184DEA281F1552659FB67ABA5FAD64B6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-03+01%3A59%3A12' \
-d 'v=2.0' \
-d 'statement_bill_query=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.TmallTxcsFinanceBillQueryRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.statement_bill_query=""
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"tmall.txcs.finance.bill.query");
add_param(pRequest,"statement_bill_query","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('tmall.txcs.finance.bill.query', {
	'statement_bill_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tmall_txcs_finance_bill_query_response>
    <result>
        <code>PARAM_INVALID</code>
        <data>
            <settlement_company_code>FIN_001</settlement_company_code>
            <operate_type_desc>经销标准</operate_type_desc>
            <operate_type>DISTRIBUTE</operate_type>
            <business_partner_name>测试供应商</business_partner_name>
            <business_partner_code>S001</business_partner_code>
            <merchant_code>MAOCHAO</merchant_code>
            <statement_bill_code>HDB201907102019071012345</statement_bill_code>
            <settlement_company_name>xx公司</settlement_company_name>
            <bill_day>2020-01-01 00:00:00</bill_day>
            <bill_status>103</bill_status>
            <bill_status_desc>已付款</bill_status_desc>
            <settlement_total_amount>100.00</settlement_total_amount>
            <invoice_total_amount>100.00</invoice_total_amount>
            <settle_perid_desc>货到</settle_perid_desc>
            <currency>CNY</currency>
        </data>
        <success>true</success>
        <message>缺少参数或参数错误</message>
        <biz_exception>true</biz_exception>
    </result>
</tmall_txcs_finance_bill_query_response>

{
    "tmall_txcs_finance_bill_query_response":{
        "result":{
            "code":"PARAM_INVALID",
            "data":{
                "settlement_company_code":"FIN_001",
                "operate_type_desc":"经销标准",
                "operate_type":"DISTRIBUTE",
                "business_partner_name":"测试供应商",
                "business_partner_code":"S001",
                "merchant_code":"MAOCHAO",
                "statement_bill_code":"HDB201907102019071012345",
                "settlement_company_name":"xx公司",
                "bill_day":"2020-01-01 00:00:00",
                "bill_status":"103",
                "bill_status_desc":"已付款",
                "settlement_total_amount":"100.00",
                "invoice_total_amount":"100.00",
                "settle_perid_desc":"货到",
                "currency":"CNY"
            },
            "success":true,
            "message":"缺少参数或参数错误",
            "biz_exception":true
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

天猫超市前台API

tmall.txcs.finance.bill.query (天猫超市外部商家财务账单信息查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ