识别文件中的增值税发票
增值税发票识别接口,支持JPG/JPEG/PNG/PDF/BMP/OFD六种文件类型的一次性的识别。 文件大小需要小于10M。
Tip: 单租户限流:10QPS,同租户下的应用没有限流,共享本租户的 10QPS 限流
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/document_ai/v1/vat_invoice/recognize |
| HTTP Method | POST |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | document_ai:vat_invoice:recognize 增值税发票识别 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 示例值:"multipart/form-data; boundary=---7MA4YWxkTrZu0gW" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
file | file | 是 | 识别的增值税发票文件(支持JPG/JPEG/PNG/PDF/BMP/OFD) 示例值:file binary |
请求体示例
HTTP
---7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file";
Content-Type: application/octet-stream
---7MA4YWxkTrZu0gW响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ vat_invoices | vat_invoice\[\] | 增值税发票信息 |
└ entities | vat_entity\[\] | 识别出的实体列表 |
└ type | string | 识别的实体类型 可选值有: - invoice_name: 发票抬头 - invoice_code: 发票代码 - invoice_no: 发票号码 - invoice_date: 开票日期 - total_price: 合计金额(不含税) - total_tax: 合计税额 - big_total_price_and_tax: 合计总额(大写) - check_code: 校验码 - total_price_and_tax: 合计总额 - buyer_name: 购买方名称 - buyer_taxpayer_no: 购买方纳税人识别号 - buyer_address_phone: 购买方地址&电话所有人 - buyer_account: 购买方开户行&账号 - seller_name: 销售方名称 - seller_taxpayer_no: 销售方纳税人识别号 - seller_address_phone: 销售方地址&电话 - seller_account: 销售方开户行&账号 - payee: 收款人 - invoice_date: 开票日期 - password_area: 密码区 - remarks: 备注 - reviewer: 复核人 - drawer: 开票人 - is_sealed: 是否盖章 - seller_name_in_seal: 印章内销售方名称 - seller_taxpayer_no_in_seal: 印章内销售方纳税人识别号 - invoice_special_seal: 印章名称 - machine_num: 机器编号 |
└ value | string | 识别出字段的文本信息 |
└ items | kv_entity\[\]\[\] | 识别出的票据详细信息 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"vat_invoices": [
{
"entities": [
{
"type": "buyer_name",
"value": "发呆公司",
"items": [
[
{
"type": "entry_name",
"value": "餐饮服务"
}
]
]
}
]
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 2110001 | Param is invalid. | 输入文件错误,参考文档检查输入参数 |
| 400 | 2110002 | No valid entity. | 未检测出增值税发票信息,参考文档检查输入文件是否有效 |
| 500 | 2110010 | Internal error, please try later. | 后端服务异常或网络异常,可重新请求 |
| 400 | 2110003 | You have reached the Intelligent document parsing limit. To continue using this function, please contact sales to purchase more. | 智能文档解析次数已达使用上限,如需继续使用,请联系销售购买 |
