You need to enable JavaScript to run this app.
导航
接口文档
最近更新时间:2021.12.16 13:58:38首次发布时间:2021.12.16 13:58:38

通用返回字段说明

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

请求API

名称内容
请求方式POST
Content-Typeapplication/x-www-form-urlencoded (传入参数不包含类型File)
是否需要鉴权
图片要求1. 图片格式:JPG、JPEG、PNG、BMP等常见格式,建议使用JPG格式。
2. 图片像素尺寸:为了保证文字识别效果,推荐图片中定额发票最短边长不低于256像素。
3. 图片文件大小:最大 4 MB。定额发票主体尽量占据图片主要区域。
4. 注意图片质量:保证定额发票图片足够清晰,不应该有因为压缩导致的噪声,避免对定额发票正反面的遮挡、不当的光照(强光、暗光、逆光)等,否则会降低结果准确度。
5. 图片需要有版权,有肖像权,没有法律或者政策风险的。相关风险请注意评估。
6.定额发票图片不可以是复印件、翻拍件、PS件等。

输入参数

Query参数:

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

Body参数:

参数可选/必选类型说明
image_base64必选String定额发票票图片文件,base64编码

API返回

通用返回字段说明

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

data 字段说明

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

main_info 字段说明

字段类型说明备注
invoice_headerString发票抬头主页信息
invoice_companyString开票公司主页信息
invoice_couponString发票联次主页信息
invoice_codeString发票代码主页信息
invoice_numberString发票号码主页信息
capitalized_amountString大写金额主页信息
lowercase_amountString小写金额主页信息
is_sealedString是否加盖章主页信息
seller_name_in_sealString盖章公司名称主页信息
seller_taxpayer_no_in_sealString盖章公司纳税人识别号主页信息

错误码

HttpCode错误码错误消息描述
20010000"Success"请求成功
40050204"Parse Request Parameters Error"缺少参数
40150205"Image Size Exceeds Maximum Limit: please compress the image"图片大小超过上限
40050207"Image Decode Error: image format unsupported"图片解码错误,文件内容为空或格式错误
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"内部错误,需要联系开发人员

返回值示例

主页面图片返回值示例

quota_invoice.jpg

{
   "code":10000,
   "data":{
      "invoice_main":{
         "invoice_header":"上海市国家税务局通用定额发票",
         "invoice_coupon":"发票联",
         "invoice_code":"131001727864",
         "invoice_number":"02138301",
         "capitalized_amount":"贰拾元",
         "lowercase_amount":"20元",
         "is_sealed":"True",
         "seller_name_in_seal":"上海华程西南国际旅行社有限公司",
         "seller_taxpayer_no_in_seal":"91310105134638405A"
      }
   },
   "message":"Success",
   "request_id":"68945441736265584781605261157",
   "status":10000,
   "time_elapsed":"293.939879ms"
}