You need to enable JavaScript to run this app.
导航
文字识别
  • 文档首页
    • /
  • 文字识别

调用方式

最近更新时间：2023.08.22 18:23:19

首次发布时间：2022.07.21 17:01:20

我的收藏
接口简介

增值税发票文字识别，结构化输出增值税发票上的字段文字信息。

限制条件
名称内容
输入要求1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF、OFD等常见格式，建议使用JPG格式。
2. 图片像素尺寸：最小 256 x 256 像素，最大 2048 x 2048 像素。为了保证文字识别效果，推荐图片中增值税发票最短边长不低于256像素。
3. 文件大小：
a.要求Base64编码和urlencode之后不超过 8 MB。增值税发票主体尽量占据图片主要区域，不支持黑白图片。
b.如果传图片及PDF完整URL，URL对应文件大小建议不要超过8MB。
4. 输入文件过大时，返回的HttpCode如下：400/413/502。
5. 注意图片质量：保证增值税发票图片足够清晰，不应该有因为压缩导致的噪声，避免对增值税发票正反面的遮挡、不当的光照（强光、暗光、逆光）等，否则会降低结果准确度。
6. 图片需要有版权，有肖像权，没有法律或者政策风险的。相关风险请注意评估。
7. 输入多页PDF时，默认只识别第一页。
请求说明

基本信息

名称内容
接口地址https://visual.volcengineapi.com
请求方式POST
Content-Typeapplication/x-www-form-urlencoded (传入参数不包含类型File)
是否需要鉴权是

请求参数

header请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数。

名称类型是否必填描述
X-DateString是使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z

Authorization

String

是

HMAC-SHA256：签名方法
-Credential为签名凭证，其中:
-AccessKeyId为访问密钥ID，可在 访问密钥（Access Key） 获取；
-ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201；
-Region为请求地区，国内一般为为cn-north-1；
-Service为请求的服务，文字识别一般为cv；
-SignedHeaders为参与签名计算的头部信息，content-type 和 host 为必选头部；
-Signature为签名，可在 签名方法 获取。
注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考 快速接入
例如：HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}

X-Security-TokenString否指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

Query请求参数

参数可选/必选类型说明
Action必选String接口名，取值：OcrVatInvoice
Version必选String版本号，取值：2020-08-26

Body参数

参数可选/必选类型说明
image_base64与image_url二选一String图片/PDF文件，base64编码
注意: 只需要传图片/PDF的base64值，类似data:image/png;base64的图片头不要传入
image_url与image_base64二选一String图片/PDF文件的URL链接
注意: 要求image_base64与image_url二选一，如果2个字段都有，优先解析image_base64。
输出说明

通用输出参数

请参考通用返回字段及错误码 |

业务输出参数

data 字段说明

字段类型说明备注
license_mainmain_info主页面信息字段说明见下方

main_info 字段说明

字段类型说明备注
invoice_codeString发票代码主页信息
invoice_nameString发票名称主页信息
machine_numString机器编号主页信息
check_codeString校验码主页信息
sheet_nameString发票联次主页信息
invoice_noString发票号码主页信息
typed_invoice_codeString机打发票代码主页信息
typed_invoice_noString机打发票号码主页信息
invoice_dateString开票日期主页信息
buyer_nameString购买方名称主页信息
buyer_taxpayer_noString购买方纳税人识别号主页信息
buyer_address_phoneString购买方地址&电话主页信息
buyer_accountString购买方开户行&账号主页信息
buyer_taxpayer_noString购买方名称主页信息
entryList of Entry应税条目字段说明见下方
total_priceString金额主页信息
total_taxString税额主页信息
big_total_price_and_taxString大写金额（价税合计）主页信息
total_price_and_taxString小写金额（价税合计）主页信息
seller_nameString销售方主页信息
seller_taxpayer_noString销售方识别号主页信息
seller_address_phoneString销售方地址&电话主页信息
seller_accountString销售方开户行&账号主页信息
beizhuString备注主页信息
payeeString收款人主页信息
reviewerString复核主页信息
drawerString开票人主页信息
is_sealedString是否加盖章主页信息
seller_name_in_sealString盖章公司名称主页信息
seller_taxpayer_no_in_sealString盖章公司纳税人识别号主页信息
is_secret_out_boundString密码区是否出界主页信息
invoice_special_sealString发票专用章主页信息
sub_typeString增值税发票类别主页信息
current_pageint当前页码主页信息
total_page_numberint总页码主页信息

Entry 明细字段说明

字段类型说明备注
entry_nameString货物或应税劳务、服务名称主页信息
xinghaoString型号主页信息
unitString单位主页信息
quantityString数量主页信息
unit_priceString单价(不含税)主页信息
price_amountString金额主页信息
tax_rateString税率主页信息
tax_amountString税额主页信息

sub_type 发票类别字段说明

字段类型说明备注
ele_vatString增值税电子普通发票主页信息
ele_special_vatString增值税电子专票主页信息
print_vatString增值税纸质普票主页信息
special_vatString增值税纸质专票主页信息
other_vatString其他电子发票主页信息
quandian_special_vatString电子发票（增值税专用发票）主页信息
quandian_vatString电子发票（普通发票）主页信息
unknown_vatString未知票主页信息

输出示例

主页面图片返回值示例

{
    "code":10000,
    "data":{
        "license_main":{
        	"invoice_code":"011002000611",
            "machine_num":"499098491560",
            "invoice_name":"XX增值税电子普通发票",
            "check_code":"16649652847559064366",
            "invoice_no":"10178760",
            "invoice_date":"2020年12月14日",
            "buyer_name":"北京字跳网络技术有限公司",
            "buyer_taxpayer_no":"91110108MA01F2L25J",
            "entry": [{
            "entry_name":"*运输服务*客运服务费",
            "xinghao":"无",
            "unit":"次",
            "quantity":"1",
            "unit_prict":"73.92",
            "price_amount":"73.92",
            "tax_rate":"免税",
            "tax_amount":"***",
            }],
            "total_price":"73.92",
            "total_tax":"***",
            "big_total_price_and_tax":"柒拾叁圆玖角贰分",
            "total_price_and_tax":"73.92",
            "seller_name":"北京滴滴出行科技有限公司",
            "seller_taxpayer_no":"91110108MA01G0FB09",
            "seller_address_phone":"北京市海淀区东北旺西路8号院34号楼二层208号010-62682929",
            "seller_account":"招商银行股份有限公司北京东三环支行110936504210806",
            "payee":"张雪丽",
            "reviewer":"蔡静",
            "drawer":"杜洪亮",
            "is_sealed":"true",
            "seller_name_in_seal":"北京滴滴出行科技有限公司",
            "seller_taxpayer_no_in_seal":"91110108MA01G0FB09",
            "invoice_special_seal":"发票专用章",
            "sub_type":"ele_vat"，
        }
    },
    "message":"Success",
    "request_id":"68874173305533255721603601810",
    "status":10000,
    "time_elapsed":"310.037276ms"
}
错误码

通用错误码

请参考通用返回字段及错误码

业务错误码

HttpCode错误码错误消息描述
20010000"Success"请求成功
40050204"Parse Request Parameters Error"缺少参数
40050205"Image Size Exceeds Maximum Limit: please compress the image"输入文件过大
40050206"Invalid Input Image: image is empty"输入图片为空
40050207"Image Decode Error: image format unsupported"图片解码错误
40050217"Process PDF File Error."处理PDF文件错误
40050208"Invalid Input Image: No object detected in input image, bad input image"输入图片没有检测到内容
40150400见下方鉴权错误信息鉴权失败
40450402"Request URL Error"无效的请求路径
50050500"Internal Error: please contact with bytedance engineering team"内部错误，需要联系开发人员