服务端 API 文档

增值税发票识别

最近更新时间:2020-09-16 08:05:01

1. 接口描述

接口请求域名: ocr.tencentcloudapi.com 。

本接口支持增值税专用发票、增值税普通发票、增值税电子发票全字段的内容检测和识别,包括发票代码、发票号码、打印发票代码、打印发票号码、开票日期、合计金额、校验码、税率、合计税额、价税合计、购买方识别号、复核、销售方识别号、开票人、密码区1、密码区2、密码区3、密码区4、发票名称、购买方名称、销售方名称、服务名称、备注、规格型号、数量、单价、金额、税额、收款人等字段。

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:VatInvoiceOCR。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto
ImageBase64 String 图片/PDF的 Base64 值。
支持的文件格式:PNG、JPG、JPEG、PDF,暂不支持 GIF 格式。
支持的图片/PDF大小:所下载文件经Base64编码后不超过 3M。文件下载时间不超过 3 秒。
输入参数 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
ImageUrl String 图片/PDF的 Url 地址。
支持的文件格式:PNG、JPG、JPEG、PDF,暂不支持 GIF 格式。
支持的图片/PDF大小:所下载文件经 Base64 编码后不超过 3M。文件下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
IsPdf Boolean 是否开启PDF识别,默认值为false,开启后可同时支持图片和PDF的识别。
PdfPageNumber Integer 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。

3. 输出参数

参数名称 类型 描述
VatInvoiceInfos Array of TextVatInvoice 检测到的文本信息,具体内容请点击左侧链接。
Items Array of VatInvoiceItem 明细条目。VatInvoiceInfos中关于明细项的具体条目。
PdfPageSize Integer 图片为PDF时,返回PDF的总页数,默认为0
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 增值税发票识别示例代码

输入示例

https://ocr.tencentcloudapi.com/?Action=VatInvoiceOCR
&ImageUrl=https://xx/a.jpg
&<公共请求参数>

输出示例

{
  "Response": {
    "VatInvoiceInfos": [
      {
        "Name": "价税合计(大写)",
        "Value": "捌拾玖圆玖角整"
      },
      {
        "Name": "发票代码",
        "Value": "012001100311"
      },
      {
        "Name": "发票号码",
        "Value": "No63591128"
      },
      {
        "Name": "发票名称",
        "Value": "天津增值税电子普通发票"
      },
      {
        "Name": "发票消费类型",
        "Value": "服务"
      },
      {
        "Name": "合计税额",
        "Value": "¥2.62"
      },
      {
        "Name": "合计金额",
        "Value": "¥87.28"
      },
      {
        "Name": "复核",
        "Value": "静静"
      },
      {
        "Name": "密码区1",
        "Value": "033-<<>7>616<-4+*-+4/5230604"
      },
      {
        "Name": "密码区2",
        "Value": "*/78+740454724/0<34*9/>61856"
      },
      {
        "Name": "密码区3",
        "Value": "29/-0651-2*91440-47386<535<5"
      },
      {
        "Name": "密码区4",
        "Value": "92<<9-9+-601452319091>67>--7"
      },
      {
        "Name": "小写金额",
        "Value": "¥89.90"
      },
      {
        "Name": "开票人",
        "Value": "丽丽"
      },
      {
        "Name": "开票日期",
        "Value": "2019年06月16日"
      },
      {
        "Name": "收款人",
        "Value": "张强"
      },
      {
        "Name": "是否有公司印章",
        "Value": "0"
      },
      {
        "Name": "机器编号",
        "Value": "499099606262"
      },
      {
        "Name": "校验码",
        "Value": "04656054380312409795"
      },
      {
        "Name": "省",
        "Value": "天津市"
      },
      {
        "Name": "购买方名称",
        "Value": "腾讯优图有限公司"
      },
      {
        "Name": "购买方识别号",
        "Value": "91440300MA55UJ6L44"
      },
      {
        "Name": "销售方名称",
        "Value": "深圳腾讯游戏有限公司"
      },
      {
        "Name": "销售方地址、电话",
        "Value": "天津经济技术开发区南港工业区综合服务区办公楼"
      },
      {
        "Name": "销售方开户行及账号",
        "Value": "招商银行股份有限公司天津自由贸易试验区分行122905939910401"
      },
      {
        "Name": "销售方识别号",
        "Value": "911201103409033300"
      },
      {
        "Name": "规格型号",
        "Value": "无"
      },
      {
        "Name": "单位",
        "Value": "次"
      },
      {
        "Name": "数量",
        "Value": "1"
      },
      {
        "Name": "单价",
        "Value": "87.28"
      },
      {
        "Name": "金额",
        "Value": "87.28"
      },
      {
        "Name": "税率",
        "Value": "3%"
      },
      {
        "Name": "税额",
        "Value": "2.62"
      },
      {
        "Name": "货物或应税劳务、服务名称",
        "Value": "客运服务费"
      },
      {
        "Name": "购买方地址、电话",
        "Value": ""
      },
      {
        "Name": "购买方开户行及账号",
        "Value": ""
      },
      {
        "Name": "备注",
        "Value": ""
      },
      {
        "Name": "联次",
        "Value": ""
      },
      {
        "Name": "是否代开",
        "Value": ""
      },
      {
        "Name": "成品油标志",
        "Value": ""
      },
      {
        "Name": "市",
        "Value": ""
      },
      {
        "Name": "服务类型",
        "Value": ""
      },
      {
        "Name": "通行费标志",
        "Value": ""
      },
      {
        "Name": "车船税",
        "Value": ""
      }
    ],
    "Items": [
      {
        "LineNo": "1",
        "Name": "",
        "Spec": "无",
        "Unit": "次",
        "Quantity": "1",
        "UnitPrice": "87.28",
        "AmountWithoutTax": "87.28",
        "TaxRate": "3%",
        "TaxAmount": "2.62"
      },
      {
        "LineNo": "2",
        "Name": "客运服务费",
        "Spec": "",
        "Unit": "",
        "Quantity": "",
        "UnitPrice": "",
        "AmountWithoutTax": "",
        "TaxRate": "",
        "TaxAmount": ""
      }
    ],
    "RequestId": "195835ab-c218-44af-bdd8-7d6c3104f924"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.EmptyImageError 图片内容为空。
FailedOperation.ImageBlur 图片模糊。
FailedOperation.ImageDecodeFailed 图片解码失败。
FailedOperation.ImageNoText 图片中未检测到文本。
FailedOperation.ImageSizeTooLarge 图片尺寸过大,请参考输出参数中关于图片大小限制的说明。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameter.EngineImageDecodeFailed 图片解码失败。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
目录