请先查看接入指引了解具体接入方式,再参考此文档完成接入。
名称 | 内容 |
---|---|
请求方式 | POST |
Content-Type | application/x-www-form-urlencoded (传入参数不包含类型File) |
是否需要鉴权 | 是 |
图片要求 | 1. 图片格式:JPG、JPEG、PNG、BMP等常见格式,建议使用JPG格式。 2. 图片像素尺寸:最小 256 x 256 像素,最大 2048 x 2048 像素。为了保证文字识别效果,推荐图片中增值税发票最短边长不低于256像素。 3. 图片文件大小:最大 4 MB。增值税发票主体尽量占据图片主要区域,不支持黑白图片。 4. 注意图片质量:保证增值税发票图片足够清晰,不应该有因为压缩导致的噪声,避免对增值税发票正反面的遮挡、不当的光照(强光、暗光、逆光)等,否则会降低结果准确度。 5. 图片需要有版权,有肖像权,没有法律或者政策风险的。相关风险请注意评估。 6.增值税发票图片不可以是复印件、翻拍件、PS件等。 |
Query参数:
参数 | 可选/必选 | 类型 | 说明 |
---|---|---|---|
Action | 必选 | String | 接口名,取值:OcrVatInvoice |
Version | 必选 | String | 版本号,取值:2020-08-26 |
Body参数:
参数 | 可选/必选 | 类型 | 说明 |
---|---|---|---|
image_base64 | 必选 | String | 增值税图片文件,base64编码 |
请参考通用返回字段及错误码
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
license_main | main_info | 主页面信息 | 字段说明见下方 |
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
invoice_code | String | 发票代码 | 主页信息 |
invoice_name | String | 发票名称 | 主页信息 |
machine_num | String | 机器编号 | 主页信息 |
check_code | String | 校验码 | 主页信息 |
sheet_name | String | 发票联次 | 主页信息 |
invoice_no | String | 发票号码 | 主页信息 |
typed_invoice_code | String | 机打发票代码 | 主页信息 |
typed_invoice_no | String | 机打发票号码 | 主页信息 |
invoice_date | String | 开票日期 | 主页信息 |
buyer_name | String | 购买方名称 | 主页信息 |
buyer_taxpayer_no | String | 购买方纳税人识别号 | 主页信息 |
buyer_address_phone | String | 购买方地址&电话 | 主页信息 |
buyer_account | String | 购买方开户行&账号 | 主页信息 |
buyer_taxpayer_no | String | 购买方名称 | 主页信息 |
entry_{条目编号}_{明细字段} | String | 应税条目 | 字段说明见下方 |
total_price | String | 金额 | 主页信息 |
total_tax | String | 税额 | 主页信息 |
big_total_price_and_tax | String | 大写金额(价税合计) | 主页信息 |
total_price_and_tax | String | 小写金额(价税合计) | 主页信息 |
seller_name | String | 销售方 | 主页信息 |
seller_taxpayer_no | String | 销售方识别号 | 主页信息 |
seller_address_phone | String | 销售方地址&电话 | 主页信息 |
seller_account | String | 销售方开户行&账号 | 主页信息 |
beizhu | String | 备注 | 主页信息 |
payee | String | 收款人 | 主页信息 |
reviewer | String | 复核 | 主页信息 |
drawer | String | 开票人 | 主页信息 |
is_sealed | String | 是否加盖章 | 主页信息 |
seller_name_in_seal | String | 盖章公司名称 | 主页信息 |
seller_taxpayer_no_in_seal | String | 盖章公司纳税人识别号 | 主页信息 |
is_secret_out_bound | String | 密码区是否出界 | 主页信息 |
invoice_special_seal | String | 发票专用章 | 主页信息 |
sub_type | String | 增值税发票类别 | 主页信息 |
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
entry_name | String | 货物或应税劳务、服务名称 | 主页信息 |
xinghao | String | 型号 | 主页信息 |
unit | String | 单位 | 主页信息 |
quantity | String | 数量 | 主页信息 |
unit_price | String | 单价(不含税) | 主页信息 |
price_amount | String | 金额 | 主页信息 |
tax_rate | String | 税率 | 主页信息 |
tax_amount | String | 税额 | 主页信息 |
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
ele_vat | String | 增值税电子普通发票 | 主页信息 |
ele_special_vat | String | 增值税电子专票 | 主页信息 |
print_vat | String | 增值税纸质普票 | 主页信息 |
special_vat | String | 增值税纸质专票 | 主页信息 |
other_vat | String | 地方区块链发票 | 主页信息 |
unknown_vat | String | 未知票 | 主页信息 |
HttpCode | 错误码 | 错误消息 | 描述 |
---|---|---|---|
200 | 10000 | "Success" | 请求成功 |
400 | 50204 | "Parse Request Parameters Error" | 缺少参数 |
401 | 50205 | "Image Size Exceeds Maximum Limit: please compress the image" | 图片大小超过上限 |
400 | 50207 | "Image Decode Error: image format unsupported" | 图片解码错误,文件内容为空或格式错误 |
400 | 50208 | "Invalid Input Image: No object detected in input image, bad input image" | 输入图片没有检测到内容 |
401 | 50400 | 见下方鉴权错误信息 | 鉴权失败 |
404 | 50402 | "Request URL Error" | 无效的请求路径 |
500 | 50500 | "Internal Error: please contact with bytedance engineering team" | 内部错误,需要联系开发人员 |
{ "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_0.entry_name":"*运输服务*客运服务费", "entry_0.xinghao":"无", "entry_0.unit":"次", "entry_0.quantity":"1", "entry_0.unit_prict":"73.92", "entry_0.price_amount":"73.92", "entry_0.tax_rate":"免税", "entry_0.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" }