淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
invoice_details	ProxyInvoiceDetailDo []	可选		最大列表长度：999	商品明细信息
└ goods_total_price_tax String 可选 100.00 价税合计 └ goods_total_tax String 可选 0.99 税额 └ goods_total_price String 可选 99.01 金额，不含税 └ goods_price String 可选 99.01 商品单价，不含税 └ goods_tax_rate String 可选 0.01 税率 └ goods_specification String 可选 ggxx 规格型号 └ goods_unit String 可选 dw 计量单位 └ goods_quantity String 可选 1.00 商品数量 └ goods_code String 可选 1000012310001 税收分类编码 └ goods_personal_code String 可选 1000000001 用户商品编码 └ goods_name String 可选项目名称商品名称 └ goods_line_no String 可选 1 明细行号
invoice_amount	String	可选	200.00		价税合计
invoice_total_price	String	可选	198.02		合计金额，不含税
invoice_total_tax	String	可选	1.98		合计税额
invoice_date	String	可选	2020-06-04 12:31:57		开票日期
invoice_no	String	可选	01211686		发票号码
invoice_code	String	可选	043001900411		发票代码
remark	String	可选	代开企业税号:销售方社会信用代码;代开企业名称:销售方企业名称;测试备注		发票备注，发票备注区内容
device_no	String	可选	12334566		税控设备编号
anti_fake_code	String	可选	lglsslfghwosgewoghowehg		校验码
ciphertext	String	可选	sfewfgewgewgew		税控码，对应发票的密码区
qr_code	String	可选	xxxx,xxx,xxx,xxx,xxx,xxx		二维码，打印在发票页面上的二维码
invoice_file_data	byte[]	可选	xxxxxxxxx		发票文件内容
file_data_type	String	可选	pdf		文件类型（pdf，ofd）
agent_bank_account	String	可选	1234567812345678		代开方银行账号， agentIsuse=0时有效，代开税务机关信息
agent_bank	String	可选	中国工商银行		代开方开户行， agentIsuse=0时有效，代开税务机关信息
agent_phone	String	可选	18604563452		代开方电话， agentIsuse=0时有效，代开税务机关信息
agent_address	String	可选	浙江省杭州市西湖区紫荆花路88号		代开方地址， agentIsuse=0时有效，代开税务机关信息
agent_name	String	可选	税务111所		代开企业名称，agentIsuse=0时有效，代开税务机关信息
agent_tax_no	String	可选	0923092023092309		代开方纳税号，agentIsuse=0时有效，代开税务机关信息
agent_isuse	Number	必须	0		代开发票标志， 0：代开，1:自开
biz_error_msg	String	可选	成功		错误信息
biz_error_code	String	可选	B0000		错误码
create_result	String	必须	success		开票结果"success"或者"fail"
serial_no	String	必须	202006031415590001		业务请求流水号
req_index	String	必须	sflshgl_12324a23342		开票请求的唯一索引
payee_register_no	String	可选	3435353535		销方税号
inv_download_url	String	可选	http://oss12345		发票下载地址

名称	类型	示例值	描述
result	ServiceResult		alinkappserver系统返回的通用结果类
└ result_msg String 成功请求返回信息 └ result_code String SUCCESS 请求响应码 └ success Boolean true 请求结果，true表示成功，false表示失败

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaEinvoiceProxyPartnerReturnRequest req = new AlibabaEinvoiceProxyPartnerReturnRequest();
List<AlibabaEinvoiceProxyPartnerReturnRequest.ProxyInvoiceDetailDo> list2 = new ArrayList<AlibabaEinvoiceProxyPartnerReturnRequest.ProxyInvoiceDetailDo>();
AlibabaEinvoiceProxyPartnerReturnRequest.ProxyInvoiceDetailDo obj3 = new AlibabaEinvoiceProxyPartnerReturnRequest.ProxyInvoiceDetailDo();
list2.add(obj3);
obj3.setGoodsTotalPriceTax("100.00");
obj3.setGoodsTotalTax("0.99");
obj3.setGoodsTotalPrice("99.01");
obj3.setGoodsPrice("99.01");
obj3.setGoodsTaxRate("0.01");
obj3.setGoodsSpecification("ggxx");
obj3.setGoodsUnit("dw");
obj3.setGoodsQuantity("1.00");
obj3.setGoodsCode("1000012310001");
obj3.setGoodsPersonalCode("1000000001");
obj3.setGoodsName("项目名称");
obj3.setGoodsLineNo("1");
req.setInvoiceDetails(list2);
req.setInvoiceAmount("200.00");
req.setInvoiceTotalPrice("198.02");
req.setInvoiceTotalTax("1.98");
req.setInvoiceDate("2020-06-04 12:31:57");
req.setInvoiceNo("01211686");
req.setInvoiceCode("043001900411");
req.setRemark("代开企业税号:销售方社会信用代码;代开企业名称:销售方企业名称;测试备注");
req.setDeviceNo("12334566");
req.setAntiFakeCode("lglsslfghwosgewoghowehg");
req.setCiphertext("sfewfgewgewgew");
req.setQrCode("xxxx,xxx,xxx,xxx,xxx,xxx");
req.setInvoiceFileData(new FileItem("/tmp/file.txt"));
req.setFileDataType("pdf");
req.setAgentBankAccount("1234567812345678");
req.setAgentBank("中国工商银行");
req.setAgentPhone("18604563452");
req.setAgentAddress("浙江省杭州市西湖区紫荆花路88号");
req.setAgentName("税务111所");
req.setAgentTaxNo("0923092023092309");
req.setAgentIsuse(0L);
req.setBizErrorMsg("成功");
req.setBizErrorCode("B0000");
req.setCreateResult("success");
req.setSerialNo("202006031415590001");
req.setReqIndex("sflshgl_12324a23342");
req.setPayeeRegisterNo("3435353535");
req.setInvDownloadUrl("http://oss12345");
AlibabaEinvoiceProxyPartnerReturnResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaEinvoiceProxyPartnerReturnRequest req = new AlibabaEinvoiceProxyPartnerReturnRequest();
List<AlibabaEinvoiceProxyPartnerReturnRequest.ProxyInvoiceDetailDoDomain> list2 = new List<AlibabaEinvoiceProxyPartnerReturnRequest.ProxyInvoiceDetailDoDomain>();
AlibabaEinvoiceProxyPartnerReturnRequest.ProxyInvoiceDetailDoDomain obj3 = new AlibabaEinvoiceProxyPartnerReturnRequest.ProxyInvoiceDetailDoDomain();
list2.Add(obj3);
obj3.GoodsTotalPriceTax = "100.00";
obj3.GoodsTotalTax = "0.99";
obj3.GoodsTotalPrice = "99.01";
obj3.GoodsPrice = "99.01";
obj3.GoodsTaxRate = "0.01";
obj3.GoodsSpecification = "ggxx";
obj3.GoodsUnit = "dw";
obj3.GoodsQuantity = "1.00";
obj3.GoodsCode = "1000012310001";
obj3.GoodsPersonalCode = "1000000001";
obj3.GoodsName = "项目名称";
obj3.GoodsLineNo = "1";
req.InvoiceDetails_ = list2;
req.InvoiceAmount = "200.00";
req.InvoiceTotalPrice = "198.02";
req.InvoiceTotalTax = "1.98";
req.InvoiceDate = "2020-06-04 12:31:57";
req.InvoiceNo = "01211686";
req.InvoiceCode = "043001900411";
req.Remark = "代开企业税号:销售方社会信用代码;代开企业名称:销售方企业名称;测试备注";
req.DeviceNo = "12334566";
req.AntiFakeCode = "lglsslfghwosgewoghowehg";
req.Ciphertext = "sfewfgewgewgew";
req.QrCode = "xxxx,xxx,xxx,xxx,xxx,xxx";
req.InvoiceFileData = new FileItem("/tmp/file.txt");
req.FileDataType = "pdf";
req.AgentBankAccount = "1234567812345678";
req.AgentBank = "中国工商银行";
req.AgentPhone = "18604563452";
req.AgentAddress = "浙江省杭州市西湖区紫荆花路88号";
req.AgentName = "税务111所";
req.AgentTaxNo = "0923092023092309";
req.AgentIsuse = 0L;
req.BizErrorMsg = "成功";
req.BizErrorCode = "B0000";
req.CreateResult = "success";
req.SerialNo = "202006031415590001";
req.ReqIndex = "sflshgl_12324a23342";
req.PayeeRegisterNo = "3435353535";
req.InvDownloadUrl = "http://oss12345";
AlibabaEinvoiceProxyPartnerReturnResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaEinvoiceProxyPartnerReturnRequest;
$invoice_details = new ProxyInvoiceDetailDo;
$invoice_details->goods_total_price_tax="100.00";
$invoice_details->goods_total_tax="0.99";
$invoice_details->goods_total_price="99.01";
$invoice_details->goods_price="99.01";
$invoice_details->goods_tax_rate="0.01";
$invoice_details->goods_specification="ggxx";
$invoice_details->goods_unit="dw";
$invoice_details->goods_quantity="1.00";
$invoice_details->goods_code="1000012310001";
$invoice_details->goods_personal_code="1000000001";
$invoice_details->goods_name="项目名称";
$invoice_details->goods_line_no="1";
$req->setInvoiceDetails(json_encode($invoice_details));
$req->setInvoiceAmount("200.00");
$req->setInvoiceTotalPrice("198.02");
$req->setInvoiceTotalTax("1.98");
$req->setInvoiceDate("2020-06-04 12:31:57");
$req->setInvoiceNo("01211686");
$req->setInvoiceCode("043001900411");
$req->setRemark("代开企业税号:销售方社会信用代码;代开企业名称:销售方企业名称;测试备注");
$req->setDeviceNo("12334566");
$req->setAntiFakeCode("lglsslfghwosgewoghowehg");
$req->setCiphertext("sfewfgewgewgew");
$req->setQrCode("xxxx,xxx,xxx,xxx,xxx,xxx");
//附件上传的机制参见PHP CURL文档，在文件路径前加@符号即可
$req->setInvoiceFileData(@fileLocation);
$req->setFileDataType("pdf");
$req->setAgentBankAccount("1234567812345678");
$req->setAgentBank("中国工商银行");
$req->setAgentPhone("18604563452");
$req->setAgentAddress("浙江省杭州市西湖区紫荆花路88号");
$req->setAgentName("税务111所");
$req->setAgentTaxNo("0923092023092309");
$req->setAgentIsuse("0");
$req->setBizErrorMsg("成功");
$req->setBizErrorCode("B0000");
$req->setCreateResult("success");
$req->setSerialNo("202006031415590001");
$req->setReqIndex("sflshgl_12324a23342");
$req->setPayeeRegisterNo("3435353535");
$req->setInvDownloadUrl("http://oss12345");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:multipart/form-data;charset=utf-8' \
-F 'app_key=12129701' \
-F 'format=json' \
-F 'method=alibaba.einvoice.proxy.partner.return' \
-F 'partner_id=apidoc' \
-F 'sign=6FB21DDBE474F173E1B55352F1FC79FD' \
-F 'sign_method=hmac' \
-F 'timestamp=2025-04-29+16%3A40%3A35' \
-F 'v=2.0' \
-F 'agent_address=%E6%B5%99%E6%B1%9F%E7%9C%81%E6%9D%AD%E5%B7%9E%E5%B8%82%E8%A5%BF%E6%B9%96%E5%8C%BA%E7%B4%AB%E8%8D%86%E8%8A%B1%E8%B7%AF88%E5%8F%B7' \
-F 'agent_bank=%E4%B8%AD%E5%9B%BD%E5%B7%A5%E5%95%86%E9%93%B6%E8%A1%8C' \
-F 'agent_bank_account=1234567812345678' \
-F 'agent_isuse=0' \
-F 'agent_name=%E7%A8%8E%E5%8A%A1111%E6%89%80' \
-F 'agent_phone=18604563452' \
-F 'agent_tax_no=0923092023092309' \
-F 'anti_fake_code=lglsslfghwosgewoghowehg' \
-F 'biz_error_code=B0000' \
-F 'biz_error_msg=%E6%88%90%E5%8A%9F' \
-F 'ciphertext=sfewfgewgewgew' \
-F 'create_result=success' \
-F 'device_no=12334566' \
-F 'file_data_type=pdf' \
-F 'inv_download_url=http%3A%2F%2Foss12345' \
-F 'invoice_amount=200.00' \
-F 'invoice_code=043001900411' \
-F 'invoice_date=2020-06-04+12%3A31%3A57' \
-F 'invoice_details=null' \
-F 'invoice_no=01211686' \
-F 'invoice_total_price=198.02' \
-F 'invoice_total_tax=1.98' \
-F 'payee_register_no=3435353535' \
-F 'qr_code=xxxx%2Cxxx%2Cxxx%2Cxxx%2Cxxx%2Cxxx' \
-F 'remark=%E4%BB%A3%E5%BC%80%E4%BC%81%E4%B8%9A%E7%A8%8E%E5%8F%B7%3A%E9%94%80%E5%94%AE%E6%96%B9%E7%A4%BE%E4%BC%9A%E4%BF%A1%E7%94%A8%E4%BB%A3%E7%A0%81%3B%E4%BB%A3%E5%BC%80%E4%BC%81%E4%B8%9A%E5%90%8D%E7%A7%B0%3A%E9%94%80%E5%94%AE%E6%96%B9%E4%BC%81%E4%B8%9A%E5%90%8D%E7%A7%B0%3B%E6%B5%8B%E8%AF%95%E5%A4%87%E6%B3%A8' \
-F 'req_index=sflshgl_12324a23342' \
-F 'serial_no=202006031415590001' \
-F 'invoice_file_data=@/tmp/file.txt'

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

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

req.invoice_details=""
req.invoice_amount="200.00"
req.invoice_total_price="198.02"
req.invoice_total_tax="1.98"
req.invoice_date="2020-06-04 12:31:57"
req.invoice_no="01211686"
req.invoice_code="043001900411"
req.remark="代开企业税号:销售方社会信用代码;代开企业名称:销售方企业名称;测试备注"
req.device_no="12334566"
req.anti_fake_code="lglsslfghwosgewoghowehg"
req.ciphertext="sfewfgewgewgew"
req.qr_code="xxxx,xxx,xxx,xxx,xxx,xxx"
req.invoice_file_data=top.api.FileItem('abc.jpg',open('abc.jpg','rb'))
req.file_data_type="pdf"
req.agent_bank_account="1234567812345678"
req.agent_bank="中国工商银行"
req.agent_phone="18604563452"
req.agent_address="浙江省杭州市西湖区紫荆花路88号"
req.agent_name="税务111所"
req.agent_tax_no="0923092023092309"
req.agent_isuse=0
req.biz_error_msg="成功"
req.biz_error_code="B0000"
req.create_result="success"
req.serial_no="202006031415590001"
req.req_index="sflshgl_12324a23342"
req.payee_register_no="3435353535"
req.inv_download_url="http://oss12345"
try:
	resp= req.getResponse()
	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,"alibaba.einvoice.proxy.partner.return");
add_param(pRequest,"invoice_details","数据结构JSON示例");
add_param(pRequest,"invoice_amount","200.00");
add_param(pRequest,"invoice_total_price","198.02");
add_param(pRequest,"invoice_total_tax","1.98");
add_param(pRequest,"invoice_date","2020-06-04 12:31:57");
add_param(pRequest,"invoice_no","01211686");
add_param(pRequest,"invoice_code","043001900411");
add_param(pRequest,"remark","代开企业税号:销售方社会信用代码;代开企业名称:销售方企业名称;测试备注");
add_param(pRequest,"device_no","12334566");
add_param(pRequest,"anti_fake_code","lglsslfghwosgewoghowehg");
add_param(pRequest,"ciphertext","sfewfgewgewgew");
add_param(pRequest,"qr_code","xxxx,xxx,xxx,xxx,xxx,xxx");
add_file_param(pRequest,"invoice_file_data","文件内容");
add_param(pRequest,"file_data_type","pdf");
add_param(pRequest,"agent_bank_account","1234567812345678");
add_param(pRequest,"agent_bank","中国工商银行");
add_param(pRequest,"agent_phone","18604563452");
add_param(pRequest,"agent_address","浙江省杭州市西湖区紫荆花路88号");
add_param(pRequest,"agent_name","税务111所");
add_param(pRequest,"agent_tax_no","0923092023092309");
add_param(pRequest,"agent_isuse","0");
add_param(pRequest,"biz_error_msg","成功");
add_param(pRequest,"biz_error_code","B0000");
add_param(pRequest,"create_result","success");
add_param(pRequest,"serial_no","202006031415590001");
add_param(pRequest,"req_index","sflshgl_12324a23342");
add_param(pRequest,"payee_register_no","3435353535");
add_param(pRequest,"inv_download_url","http://oss12345");
pResponse = top_execute(pClient,pRequest,NULL);
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('alibaba.einvoice.proxy.partner.return', {
	'invoice_details':'数据结构JSON示例',
	'invoice_amount':'200.00',
	'invoice_total_price':'198.02',
	'invoice_total_tax':'1.98',
	'invoice_date':'2020-06-04 12:31:57',
	'invoice_no':'01211686',
	'invoice_code':'043001900411',
	'remark':'代开企业税号:销售方社会信用代码;代开企业名称:销售方企业名称;测试备注',
	'device_no':'12334566',
	'anti_fake_code':'lglsslfghwosgewoghowehg',
	'ciphertext':'sfewfgewgewgew',
	'qr_code':'xxxx,xxx,xxx,xxx,xxx,xxx',
	'invoice_file_data':'文件内容',
	'file_data_type':'pdf',
	'agent_bank_account':'1234567812345678',
	'agent_bank':'中国工商银行',
	'agent_phone':'18604563452',
	'agent_address':'浙江省杭州市西湖区紫荆花路88号',
	'agent_name':'税务111所',
	'agent_tax_no':'0923092023092309',
	'agent_isuse':'0',
	'biz_error_msg':'成功',
	'biz_error_code':'B0000',
	'create_result':'success',
	'serial_no':'202006031415590001',
	'req_index':'sflshgl_12324a23342',
	'payee_register_no':'3435353535',
	'inv_download_url':'http://oss12345'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_einvoice_proxy_partner_return_response>
    <result>
        <result_msg>成功</result_msg>
        <result_code>SUCCESS</result_code>
        <success>true</success>
    </result>
</alibaba_einvoice_proxy_partner_return_response>

{
    "alibaba_einvoice_proxy_partner_return_response":{
        "result":{
            "result_msg":"成功",
            "result_code":"SUCCESS",
            "success":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下载

开放平台

电子发票

alibaba.einvoice.proxy.partner.return (代开开票结果回传)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ