支持对增值税卷票所有关键字段的自动定位与识别。
| 名称 | 内容 |
|---|---|
| 输入要求 | 1. 文件格式：支持JPG、JPEG、PNG、BMP、PDF等常见格式，建议使用JPG格式。 2. 文件大小： a.要求Base64编码和urlencode之后不超过 8 MB。 b.如果传图片及PDF完整URL，URL对应文件大小建议不要超过8MB。 3. 输入文件过大时，返回的HttpCode如下：400/413/502。 4. 输入多页PDF时，默认只识别第一页。 |
| 名称 | 内容 |
|---|---|
| 接口地址 | https://visual.volcengineapi.com |
| 请求方式 | POST |
| Content-Type | application/x-www-form-urlencoded |
| 是否需要鉴权 | 是 |
以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见 公共参数。
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| X-Date | String | 是 | 使用UTC时间，精确到秒。请使用格式：YYYYMMDD'T'HHMMSS'Z' ，例如：20201103T104027Z |
Authorization | String | 是 | HMAC-SHA256：签名方法 |
| X-Security-Token | String | 否 | 指安全令牌服务（Security Token Service，STS） 颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。 |
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| Action | 必选 | String | 接口名，取值：OcrRollInvoice |
| Version | 必选 | String | 版本号，取值：2021-08-23 |
| 参数 | 可选/必选 | 类型 | 说明 |
|---|---|---|---|
| image_base64 | 与image_url二选一 | String | 图片文件，base64编码 注意: 只需要传图片的base64值，类似data:image/png;base64的图片头不要传入 |
| image_url | 与image_base64二选一 | String | 图片/PDF文件的URL链接 注意: 要求image_base64与image_url二选一，如果2个字段都有，优先解析image_base64。 |
请参考通用返回字段及错误码 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| license_main | main_info | 主页面信息 | 字段说明见下方 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| seller_name | String | 销售方名称 | 主页信息 |
| buyer_name | String | 购买方名称 | 主页信息 |
| entry | List of Entry | 发票条目 | 字段说明见下方 |
| invoice_header | String | 发票名称 | 主页信息 |
| invoice_coupon | String | 发票联 | 主页信息 |
| invoice_code | String | 发票代码 | 主页信息 |
| invoice_number | String | 发票号码 | 主页信息 |
| machine_code | String | 机器编号 | 主页信息 |
| typed_invoice_no | String | 机打号码 | 主页信息 |
| seller_taxpayer_no | String | 销售方纳税人识别号 | 主页信息 |
| invoice_date | String | 开票日期 | 主页信息 |
| payee | String | 收款员 | 主页信息 |
| buyer_taxpayer_no | String | 购买方纳税人识别号 | 主页信息 |
| lowercase_total_amount | String | 合计金额（小写） | 主页信息 |
| capital_total_amount | String | 合计金额（大写） | 主页信息 |
| check_code | String | 校验码 | 主页信息 |
| seller_name_in_seal | String | 印章中销售方名称 | 主页信息 |
| seller_taxpayer_no_in_seal | String | 印章中销售方纳税人识别号 | 主页信息 |
| 字段 | 类型 | 说明 | 备注 |
|---|---|---|---|
| entry_name | String | 项目 | 主页信息 |
| quantity | String | 数量 | 主页信息 |
| price_amount | String | 金额 | 主页信息 |
| unit_price | String | 单价 | 主页信息 |
{ "code":10000, "data":{ "license_main":{ "seller_name":"中国石化销售有限公司滨江石油分公司", "buyer_name":"滨江明日头条科技有限公司", "entry": [{ "entry_name":"*预付卡销售*加油充值款", "quantity":"1.00", "price_amount":"500.00", "unit_price":"500.00", }], "invoice_header":"滨江增值税普通发票", "invoice_coupon":"发票联", "invoice_code":"031001750107", "invoice_number":"03574125", "machine_code":"661712116595", "typed_invoice_no":"03574125", "seller_taxpayer_no":"91310000834486035U", "invoice_date":"2019年1月14日", "payee":"高红英", "buyer_taxpayer_no":"91310104MA1FR7C72G", "lowercase_total_amount":"¥500.00", "capital_total_amount":"伍佰元整", "check_code":"70497 71434 15541 89588" } }, "message":"Success", "request_id":"68885192694164377721603858375", "status":10000, "time_elapsed":"418.017944ms" }
请参考通用返回字段及错误码
| HttpCode | 错误码 | 错误消息 | 描述 |
|---|---|---|---|
| 200 | 10000 | "Success" | 请求成功 |
| 400 | 50204 | "Parse Request Parameters Error" | 缺少参数 |
| 400 | 50205 | "Image Size Exceeds Maximum Limit: please compress the image" | 输入文件过大 |
| 400 | 50206 | "Invalid Input Image: image is empty" | 输入图片为空 |
| 400 | 50207 | "Image Decode Error: image format unsupported" | 图片解码错误 |
| 400 | 50217 | "Process PDF File Error." | 处理PDF文件错误 |
| 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" | 内部错误，需要联系开发人员 |
| HttpCode | 错误码 | 错误消息 | 描述 |
|---|---|---|---|
| 401 | 50400 | "Access Denied: api forbidden" | api_key缺失或者错误 |
| 401 | 50400 | "Access Denied: bad timestamp. Make sure your clock is correct" | timestamp错误 |
| 401 | 50400 | "Access Denied: timestamp is an invalid integer" | timestamp缺失或格式错误 |
| 401 | 50400 | "Access Denied: nonce is not a 32-bit signed integer" | nonce缺失或格式错误 |
| 401 | 50400 | "Access Denied: bad signature" | sign缺失或格式错误 |