淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
scan_request	InvoiceScanRequest	可选			ocr录入请求体
invoice_scan_share_data XforceInvoiceDto [] 可选发票实体 head InvoiceMainExt 可选发票头 └ auth_apply_user_id String 可选 123456 申请人 └ scan_time String 可选 2019-07-23 10:00:00.123 扫描时间 └ seller_name String 可选销方名称销方名称 └ remark String 可选 1234 备注 └ purchaser_code String 可选 T62 购方编码 └ cipher_text String 可选 11231431dfaf 发票密文（字符200位） └ auth_apply_time Date 可选 2019-07-23 10:00:00 申请时间 └ invoice_type String 可选 s 发票类型 └ issued_tax_no String 可选 91330100799655058B 代开税号 └ invoice_no String 可选 11223344 发票号码 └ file_id String 可选 34db37d4-aa3a-4027-be4f-9f5cad7ceecf 附件的resourceId(上传影响接口返回) └ amount_without_tax String 可选 100.00 不含税金额 └ batch_no String 可选 13241341341 批次号 └ machine_code String 可选 13413451531 机器编号（字符20位） └ scan_user_id String 可选 123456 扫描员工号 └ invoice_code String 可选 1122334455 发票代码 └ two_code_flag String 可选 1 二维码发票标记 └ scan_account String 可选 ASC100011 扫描账号 └ purchaser_name String 可选阿里巴巴（中国）有限公司购方名称 └ tax_rate String 可选 0.01 税率 └ seller_tax_no String 可选 91330100799655058B 销方税号 └ cipher_text_twocode String 可选 adfafadfadfa 二维码密文（字符1000位）二维码发票必填 └ purchaser_tax_no String 可选 91330100799655058B 购方税号 └ verify_no String 可选 24524652524525 校验码 └ paper_drew_date Date 可选 2019-07-23 00:00:00 发票开票日期 └ tax_amount String 可选 123.00 税额 └ waybill_no String 可选 SF1213415414351 快递号 └ doc_no String 可选 KP123456 关联单据号 └ document_type String 可选 10001001 发票类型（支持全票种） └ match_reference_no String 可选 matchReferenceNo 匹配参考单据号 └ manual_tag_list String [] 可选 other 人工标签code ocr_error_list InvoiceOcrErrorDTO [] 可选 ocrError01 OCR扫票错误列表 └ error_code String 可选 ocrErrorCode01 OCR扫票错误code └ error_msg String 可选 ocrErrorMsg01 OCR扫票错误msg detail_list InvoiceDetails [] 可选 1 发票行 └ unit_price String 可选 100.00 单价 └ amount_without_tax String 可选 100.00 不含税金额 └ item_spec String 可选 123 规格型号 └ tax_rate String 可选 0.01 税率 └ quantity String 可选 3 数量 └ cargo_name String 可选鞋子货物或应税劳务名称 └ quantity_unit String 可选元单位 └ tax_amount String 可选 100.00 税额 └ _t Number 可选 1645512400 扫描时间 └ sign String 可选 12124 签名值 └ appcode String 可选 123 应用code

名称	类型	示例值	描述
data	String	000	空值
succeeded	Boolean	true	是否成功
response_code	String	0000	响应码
response_msg	String	success	响应消息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCfoIncomingInvoicePytInvoiceScanRequest req = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest();
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceScanRequest obj1 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceScanRequest();
List<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.XforceInvoiceDto> list3 = new ArrayList<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.XforceInvoiceDto>();
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.XforceInvoiceDto obj4 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.XforceInvoiceDto();
list3.add(obj4);
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceMainExt obj6 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceMainExt();
obj6.setAuthApplyUserId("123456");
obj6.setScanTime("2019-07-23 10:00:00.123");
obj6.setSellerName("销方名称");
obj6.setRemark("1234");
obj6.setPurchaserCode("T62");
obj6.setCipherText("11231431dfaf");
obj6.setAuthApplyTime(StringUtils.parseDateTime("2019-07-23 10:00:00"));
obj6.setInvoiceType("s");
obj6.setIssuedTaxNo("91330100799655058B");
obj6.setInvoiceNo("11223344");
obj6.setFileId("34db37d4-aa3a-4027-be4f-9f5cad7ceecf");
obj6.setAmountWithoutTax("100.00");
obj6.setBatchNo("13241341341");
obj6.setMachineCode("13413451531");
obj6.setScanUserId("123456");
obj6.setInvoiceCode("1122334455");
obj6.setTwoCodeFlag("1");
obj6.setScanAccount("ASC100011");
obj6.setPurchaserName("阿里巴巴（中国）有限公司");
obj6.setTaxRate("0.01");
obj6.setSellerTaxNo("91330100799655058B");
obj6.setCipherTextTwocode("adfafadfadfa");
obj6.setPurchaserTaxNo("91330100799655058B");
obj6.setVerifyNo("24524652524525");
obj6.setPaperDrewDate(StringUtils.parseDateTime("2019-07-23 00:00:00"));
obj6.setTaxAmount("123.00");
obj6.setWaybillNo("SF1213415414351");
obj6.setDocNo("KP123456");
obj6.setDocumentType("10001001");
obj6.setMatchReferenceNo("matchReferenceNo");
obj6.setManualTagList("other");
List<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceOcrErrorDTO> list8 = new ArrayList<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceOcrErrorDTO>();
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceOcrErrorDTO obj9 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceOcrErrorDTO();
list8.add(obj9);
obj9.setErrorCode("ocrErrorCode01");
obj9.setErrorMsg("ocrErrorMsg01");
obj6.setOcrErrorList(list8);
list5.setHead(obj6);
List<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceDetails> list12 = new ArrayList<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceDetails>();
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceDetails obj13 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceDetails();
list12.add(obj13);
obj13.setUnitPrice("100.00");
obj13.setAmountWithoutTax("100.00");
obj13.setItemSpec("123");
obj13.setTaxRate("0.01");
obj13.setQuantity("3");
obj13.setCargoName("鞋子");
obj13.setQuantityUnit("元");
obj13.setTaxAmount("100.00");
list10.setDetailList(list12);
obj1.setInvoiceScanShareData(list3);
obj1.sett(1645512400L);
obj1.setSign("12124");
obj1.setAppcode("123");
req.setScanRequest(obj1);
AlibabaCfoIncomingInvoicePytInvoiceScanResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCfoIncomingInvoicePytInvoiceScanRequest req = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest();
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceScanRequestDomain obj1 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceScanRequestDomain();
List<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.XforceInvoiceDtoDomain> list3 = new List<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.XforceInvoiceDtoDomain>();
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.XforceInvoiceDtoDomain obj4 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.XforceInvoiceDtoDomain();
list3.Add(obj4);
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceMainExtDomain obj5 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceMainExtDomain();
obj5.AuthApplyUserId = "123456";
obj5.ScanTime = "2019-07-23 10:00:00.123";
obj5.SellerName = "销方名称";
obj5.Remark = "1234";
obj5.PurchaserCode = "T62";
obj5.CipherText = "11231431dfaf";
obj5.AuthApplyTime = DateTime.Parse(2019-07-23 10:00:00");
obj5.InvoiceType = "s";
obj5.IssuedTaxNo = "91330100799655058B";
obj5.InvoiceNo = "11223344";
obj5.FileId = "34db37d4-aa3a-4027-be4f-9f5cad7ceecf";
obj5.AmountWithoutTax = "100.00";
obj5.BatchNo = "13241341341";
obj5.MachineCode = "13413451531";
obj5.ScanUserId = "123456";
obj5.InvoiceCode = "1122334455";
obj5.TwoCodeFlag = "1";
obj5.ScanAccount = "ASC100011";
obj5.PurchaserName = "阿里巴巴（中国）有限公司";
obj5.TaxRate = "0.01";
obj5.SellerTaxNo = "91330100799655058B";
obj5.CipherTextTwocode = "adfafadfadfa";
obj5.PurchaserTaxNo = "91330100799655058B";
obj5.VerifyNo = "24524652524525";
obj5.PaperDrewDate = DateTime.Parse(2019-07-23 00:00:00");
obj5.TaxAmount = "123.00";
obj5.WaybillNo = "SF1213415414351";
obj5.DocNo = "KP123456";
obj5.DocumentType = "10001001";
obj5.MatchReferenceNo = "matchReferenceNo";
obj5.ManualTagList = "other";
List<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceOcrErrorDTODomain> list7 = new List<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceOcrErrorDTODomain>();
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceOcrErrorDTODomain obj8 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceOcrErrorDTODomain();
list7.Add(obj8);
obj8.ErrorCode = "ocrErrorCode01";
obj8.ErrorMsg = "ocrErrorMsg01";
obj5.OcrErrorList= list7;
obj4.Head= obj5;
List<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceDetailsDomain> list10 = new List<AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceDetailsDomain>();
AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceDetailsDomain obj11 = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest.InvoiceDetailsDomain();
list10.Add(obj11);
obj11.UnitPrice = "100.00";
obj11.AmountWithoutTax = "100.00";
obj11.ItemSpec = "123";
obj11.TaxRate = "0.01";
obj11.Quantity = "3";
obj11.CargoName = "鞋子";
obj11.QuantityUnit = "元";
obj11.TaxAmount = "100.00";
obj4.DetailList= list10;
obj1.InvoiceScanShareData= list3;
obj1.t = 1645512400L;
obj1.Sign = "12124";
obj1.Appcode = "123";
req.ScanRequest_ = obj1;
AlibabaCfoIncomingInvoicePytInvoiceScanResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCfoIncomingInvoicePytInvoiceScanRequest;
$scan_request = new InvoiceScanRequest;
$invoice_scan_share_data = new XforceInvoiceDto;
$head = new InvoiceMainExt;
$head->auth_apply_user_id="123456";
$head->scan_time="2019-07-23 10:00:00.123";
$head->seller_name="销方名称";
$head->remark="1234";
$head->purchaser_code="T62";
$head->cipher_text="11231431dfaf";
$head->auth_apply_time="2019-07-23 10:00:00";
$head->invoice_type="s";
$head->issued_tax_no="91330100799655058B";
$head->invoice_no="11223344";
$head->file_id="34db37d4-aa3a-4027-be4f-9f5cad7ceecf";
$head->amount_without_tax="100.00";
$head->batch_no="13241341341";
$head->machine_code="13413451531";
$head->scan_user_id="123456";
$head->invoice_code="1122334455";
$head->two_code_flag="1";
$head->scan_account="ASC100011";
$head->purchaser_name="阿里巴巴（中国）有限公司";
$head->tax_rate="0.01";
$head->seller_tax_no="91330100799655058B";
$head->cipher_text_twocode="adfafadfadfa";
$head->purchaser_tax_no="91330100799655058B";
$head->verify_no="24524652524525";
$head->paper_drew_date="2019-07-23 00:00:00";
$head->tax_amount="123.00";
$head->waybill_no="SF1213415414351";
$head->doc_no="KP123456";
$head->document_type="10001001";
$head->match_reference_no="matchReferenceNo";
$head->manual_tag_list="other";
$ocr_error_list = new InvoiceOcrErrorDTO;
$ocr_error_list->error_code="ocrErrorCode01";
$ocr_error_list->error_msg="ocrErrorMsg01";
$head->ocr_error_list = $ocr_error_list;
$invoice_scan_share_data->head = $head;
$detail_list = new InvoiceDetails;
$detail_list->unit_price="100.00";
$detail_list->amount_without_tax="100.00";
$detail_list->item_spec="123";
$detail_list->tax_rate="0.01";
$detail_list->quantity="3";
$detail_list->cargo_name="鞋子";
$detail_list->quantity_unit="元";
$detail_list->tax_amount="100.00";
$invoice_scan_share_data->detail_list = $detail_list;
$scan_request->invoice_scan_share_data = $invoice_scan_share_data;
$scan_request->_t="1645512400";
$scan_request->sign="12124";
$scan_request->appcode="123";
$req->setScanRequest(json_encode($scan_request));
$resp = $c->execute($req);

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=alibaba.cfo.incoming.invoice.pyt.invoice.scan' \
-d 'partner_id=apidoc' \
-d 'sign=2170AE41467D306C020881D96A0A8703' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-23+17%3A38%3A39' \
-d 'v=2.0' \
-d 'scan_request=null'

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

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

req.scan_request="数据结构示例JSON格式"
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.cfo.incoming.invoice.pyt.invoice.scan");
add_param(pRequest,"scan_request","数据结构JSON示例");
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.cfo.incoming.invoice.pyt.invoice.scan', {
	'scan_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_cfo_incoming_invoice_pyt_invoice_scan_response>
    <data>000</data>
    <succeeded>true</succeeded>
    <response_code>0000</response_code>
    <response_msg>success</response_msg>
</alibaba_cfo_incoming_invoice_pyt_invoice_scan_response>

{
    "alibaba_cfo_incoming_invoice_pyt_invoice_scan_response":{
        "data":"000",
        "succeeded":true,
        "response_code":"0000",
        "response_msg":"success"
    }
}

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.cfo.incoming.invoice.pyt.invoice.scan (票易通发票ocr信息同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ