文档简介:
接口描述
支持对增值税普票、专票、全电发票(新版全国统一电子发票,专票/普票)、卷票、区块链发票的所有字段进行结构化识别,包括发票基本信息、销售方及购买方信息、商品信息、价税信息等,其中五要素字段的识别准确率超过 99.9%; 同时,支持对增值税卷票的 21 个关键字段进行识别,包括发票类型、发票代码、发票号码、机打号码、机器编号、收款人、销售方名称、销售方纳税人识别号、开票日期、购买方名称、购买方纳税人识别号、项目、单价、数量、金额、税额、合计金额(小写)、合计金额(大写)、校验码、省、市,四要素字段的识别准确率可达95%。
在线调试
您可以在 示例代码中心 中调试该接口,可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。
请求说明
请求示例
HTTP 方法:POST
请求URL: https://aip.baidubce.com/rest/2.0/ocr/v1/vat_invoice
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/x-www-form-urlencoded |
Body中放置请求参数,参数详情如下:
请求参数
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
image | 和 url/pdf_file 三选一 | string | - |
图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式 优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效 |
url | 和 image/pdf_file 三选一 | string | - |
图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式 优先级:image > url > pdf_file,当image字段存在时,url字段失效 请注意关闭URL防盗链 |
pdf_file | 和 image/url 三选一 | string | - |
PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px 优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效 |
pdf_file_num | 否 | string | - | 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页 |
type | 否 | string | normal/roll |
进行识别的增值税发票类型,默认为 normal,可缺省 - normal:可识别增值税普票、专票、电子发票 - roll:可识别增值税卷票 |
seal_tag | 否 | string | true/false |
是否开启印章判断功能,并返回印章内容的识别结果 - true:开启 - false:不开启 |
请求代码示例
提示一:使用示例代码前,请记得替换其中的示例Token、图片地址或Base64信息。
提示二:部分语言依赖的类或库,请在代码注释中查看下载地址。
curl -i -k 'https://aip.baidubce.com/rest/2.0/ocr/v1/vat_invoice?access_token=
【调用鉴权接口获取的token】' --data 'image=【图片Base64编码,需UrlEncode】
' -H 'Content-Type:application/x-www-form-urlencoded'
返回说明
返回参数
字段 | 是否必选 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
pdf_file_size | 否 | string | 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | object{} | 识别结果 |
+ ServiceType | 是 | string | 发票消费类型。不同消费类型输出:餐饮、电器设备、通讯、服务、日用品食品、医疗、交通、其他 |
+ InvoiceType | 是 | string | 发票种类。不同类型发票输出:普通发票、专用发票、电子普通发票、电子专用发票、通行费电子普票、区块链发票、通用机打电子发票、电子发票(专用发票)、电子发票(普通发票) |
+ InvoiceTypeOrg | 是 | string | 发票名称 |
+ InvoiceCode | 是 | string | 发票代码 |
+ InvoiceNum | 是 | string | 发票号码 |
+ InvoiceCodeConfirm | 是 | string | 发票代码的辅助校验码,一般业务情景可忽略 |
+ InvoiceNumConfirm | 是 | string | 发票号码的辅助校验码,一般业务情景可忽略 |
+ InvoiceTag | 是 | string | 增值税发票左上角标志。 包含:通行费、销项负数、代开、收购、成品油、其他 |
+ MachineNum | 是 | string | 机打号码。仅增值税卷票含有此参数 |
+ MachineCode | 是 | string | 机器编号。仅增值税卷票含有此参数 |
+ CheckCode | 是 | string | 校验码。增值税专票无此参数 |
+ InvoiceDate | 是 | string | 开票日期 |
+ PurchaserName | 是 | string | 购方名称 |
+ PurchaserRegisterNum | 是 | string | 购方纳税人识别号 |
+ PurchaserAddress | 是 | string | 购方地址及电话 |
+ PurchaserBank | 是 | string | 购方开户行及账号 |
+ Password | 是 | string | 密码区 |
+ Province | 是 | string | 省 |
+ City | 是 | string | 市 |
+ SheetNum | 是 | string | 联次信息。专票第一联到第三联分别输出:第一联:记账联、第二联:抵扣联、第三联:发票联;普通发票第一联到第二联分别输出:第一联:记账联、第二联:发票联 |
+ Agent | 是 | string | 是否代开 |
+ CommodityName | 是 | array[] | 货物名称 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityType | 是 | array[] | 规格型号 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityUnit | 是 | array[] | 单位 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityNum | 是 | array[] | 数量 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityPrice | 是 | array[] | 单价 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityAmount | 是 | array[] | 金额 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityTaxRate | 是 | array[] | 税率 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityTax | 是 | array[] | 税额 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityPlateNum | 是 | array[] | 车牌号。仅通行费增值税电子普通发票含有此参数 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityVehicleType | 是 | array[] | 类型。仅通行费增值税电子普通发票含有此参数 |
++ row | 是 | uint32 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityStartDate | 是 | array[] | 通行日期起。仅通行费增值税电子普通发票含有此参数 |
++ row | 是 | uint33 | 行号 |
++ word | 是 | string | 内容 |
+ CommodityEndDate | 是 | array[] | 通行日期止。仅通行费增值税电子普通发票含有此参数 |
++ row | 是 | uint33 | 行号 |
++ word | 是 | string | 内容 |
+ OnlinePay | 是 | String | 电子支付标识。仅区块链发票含有此参数 |
+ SellerName | 是 | string | 销售方名称 |
+ SellerRegisterNum | 是 | string | 销售方纳税人识别号 |
+ SellerAddress | 是 | string | 销售方地址及电话 |
+ SellerBank | 是 | string | 销售方开户行及账号 |
+ TotalAmount | 是 | uint32 | 合计金额 |
+ TotalTax | 是 | uint32 | 合计税额 |
+ AmountInWords | 是 | string | 价税合计(大写) |
+ AmountInFiguers | 是 | uint32 | 价税合计(小写) |
+ Payee | 是 | string | 收款人 |
+ Checker | 是 | string | 复核 |
+ NoteDrawer | 是 | string | 开票人 |
+ Remarks | 是 | string | 备注 |
+ company_seal | 否 | string | 判断是否存在印章。返回“0或1”,1代表存在印章,0代表不存在印章,当 seal_tag=true 时返回该字段 |
+ seal_info | 否 | string | 印章识别结果内容。当 seal_tag=true 时返回该字段 |
返回示例
{ "log_id": "5425496231209218858", "words_result_num": 35, "words_result": { "ServiceType": "其他", "
InvoiceNum": "14641426", "InvoiceNumConfirm": "14641426", "SellerName": "上海易火广告传媒有限公司",
"CommodityTaxRate": [ { "word": "6%", "row": "1" } ], "SellerBank": "中国银行南翔支行446863841354",
"Checker": ":沈园园", "TotalAmount": "94339.62", "CommodityAmount": [ { "word": "94339.62", "row":
"1" } ], "InvoiceDate": "2016年06月02日", "CommodityTax": [ { "word": "5660.38", "row": "1" } ],
"PurchaserName": "百度时代网络技术(北京)有限公司", "CommodityNum": [ { "word": "", "row": "1" } ],
"Province": "上海", "City": "", "SheetNum": "第三联", "Agent": "否", "PurchaserBank":
"招商银行北京分行大屯路支行8661820285100030", "Remarks": "告传", "Password": "074/45781873408>
/6>8>65*887676033/51+9/32--852>1+29641-5>6687/*-34716905113*4242>",
"SellerAddress": ":嘉定区胜辛南路500号15幢1161室55033753", "PurchaserAddress": "
北京市海淀区东北旺西路8号中关村软件园17号楼二属A2010-59108001", "InvoiceCode": "3100153130",
"InvoiceCodeConfirm": "3100153130", "CommodityUnit": [ { "word": "", "row": "1" } ], "Payee":
":徐蓉", "PurchaserRegisterNum": "110108787751579", "CommodityPrice": [ { "word": "", "row": "1" }
], "NoteDrawer": "沈园园", "AmountInWords": "壹拾万圆整", "AmountInFiguers": "100000.00", "TotalTax":
"5660.38", "InvoiceType": "专用发票", "SellerRegisterNum": "913101140659591751", "CommodityName":
[ { "word": "信息服务费", "row": "1" } ], "CommodityType": [ { "word": "", "row": "1" } ],
"CommodityPlateNum": [], "CommodityVehicleType": [], "CommodityStartDate": [], "CommodityEndDate":
[], "OnlinePay": "", } }