服务端 API 文档

文档捉虫大赛火热进行中,好礼多多> HOT

1. 接口描述

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

本接口支持OFD格式的增值税电子普通发票和增值税电子专用发票的识别,返回发票代码、发票号码、开票日期、验证码、机器编号、密码区,购买方和销售方信息,包括名称、纳税人识别号、地址电话、开户行及账号,以及价税合计、开票人、收款人、复核人、税额、不含税金额等字段信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:VerifyOfdVatInvoiceOCR。
Version String 公共参数,本接口取值:2018-11-19。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai, na-toronto 。
OfdFileUrl String OFD文件的 Url 地址。
OfdFileBase64 String OFD文件的 Base64 值。
OfdFileUrl 和 OfdFileBase64 必传其一,若两者都传,只解析OfdFileBase64。

3. 输出参数

参数名称 类型 描述
Type String 发票类型
026:增值税电子普通发票
028:增值税电子专用发票
010:电子发票(普通发票)
020:电子发票(增值税专用发票)
InvoiceCode String 发票代码
InvoiceNumber String 发票号码
IssueDate String 开票日期
InvoiceCheckCode String 验证码
MachineNumber String 机器编号
TaxControlCode String 密码区
Buyer VatInvoiceUserInfo 购买方
Seller VatInvoiceUserInfo 销售方
TaxInclusiveTotalAmount String 价税合计
InvoiceClerk String 开票人
Payee String 收款人
Checker String 复核人
TaxTotalAmount String 税额
TaxExclusiveTotalAmount String 不含税金额
Note String 备注
GoodsInfos Array of VatInvoiceGoodsInfo 货物或服务清单
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 OFD发票识别示例代码

ofd发票识别

输入示例

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

输出示例

{
    "Response": {
        "Buyer": {
            "AddrTel": "北京海淀区西钓鱼台嘉园北门13392342520",
            "FinancialAccount": "北京农商行32445333322211",
            "Name": "科游迈利有限公司",
            "TaxId": "9150010807MGZHI002"
        },
        "Checker": "张嘉诺",
        "GoodsInfos": [
            {
                "Amount": "-100.00",
                "Item": "*餐饮服务*餐费",
                "MeasurementDimension": "次",
                "Price": "25",
                "Quantity": "-4",
                "Specification": "",
                "TaxAmount": "-6.00",
                "TaxScheme": "6%"
            },
            {
                "Amount": "-100.00",
                "Item": "*餐饮服务*餐费",
                "MeasurementDimension": "次",
                "Price": "25",
                "Quantity": "-4",
                "Specification": "",
                "TaxAmount": "-6.00",
                "TaxScheme": "6%"
            },
            {
                "Amount": "-100.00",
                "Item": "*餐饮服务*餐费",
                "MeasurementDimension": "次",
                "Price": "25",
                "Quantity": "-4",
                "Specification": "",
                "TaxAmount": "-6.00",
                "TaxScheme": "6%"
            }
        ],
        "InvoiceCheckCode": "17803957977493679699",
        "InvoiceClerk": "任盈盈",
        "InvoiceCode": "050001700111",
        "InvoiceNumber": "62346438",
        "IssueDate": "2020年06月18日",
        "MachineNumber": "016000015903",
        "Note": "对应正数发票代码:050001700111号码:62346436",
        "Payee": "张一诺",
        "RequestId": "7ea56704-eb43-455a-a608-6d79f5e70b37",
        "Seller": {
            "AddrTel": "北京市海淀区颐和园西路一亩园11号",
            "FinancialAccount": "建设银行625555888900998711",
            "Name": "深圳高灯云科技有限公司",
            "TaxId": "91500300MA5FNDGU8Y"
        },
        "TaxControlCode": "002280/993-4692+</-0-5-57+1-61>739+2/07>*5++3-30>+2154-80/*576>3/411+3/3>->*/--++6875624-<41<0>*0<11*/2-1922<7>4",
        "TaxExclusiveTotalAmount": "-300.00",
        "TaxInclusiveTotalAmount": "-318.00",
        "TaxTotalAmount": "-18.00",
        "Type": "026"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DownLoadError 文件下载失败。
FailedOperation.OcrFailed OCR识别失败。
FailedOperation.UnKnowError 未知错误。
FailedOperation.UnOpenError 服务未开通。
InvalidParameterValue.InvalidParameterValueLimit 参数值错误。
LimitExceeded.TooLargeFileError 文件内容太大。
ResourcesSoldOut.ChargeStatusException 计费状态异常。
目录