{ "openapi": "3.0.3", "info": { "title": "票据凭证OCR识别", "description": "增值税专票OCR-电子票OCR-普票OCR-区块链发票OCR文字识别等增值税发票图像内容识别，自动识别发票图片中的信息，包括实时联网核验发票真伪并返回全票面信息。广泛应用于企业税务核算及费控报销管理、供应链发票核验、财税代理记账等场景，有效降低人力查验成本，护航企业财务信息安全", "termsOfService": "https://www.showapi.com/helpcenter/view#/4019/2", "version": "1.0.0" }, "servers": [ { "url": "https://route.showapi.com" } ], "paths": { "/2417-8": { "x-pointCode": 8, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "出租车发票识别", "description": "支持全国各大城市出租车票进行结构化识别，包括发票号码、代码、车号、日期、总金额、燃油附加费、叫车服务费、上下车时间等。\n图片要求：小于4M，\n像素要求：短边像素大于256，\n格式支持：PNG、JPG、JPEG、BMP。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "get_on_time": { "type": "string", "description": "上车时间" }, "code": { "type": "string", "description": "发票代号" }, "service_province": { "type": "string", "description": "省" }, "date": { "type": "string", "description": "乘车日期" }, "unit_price": { "type": "string", "description": "每公里单价" }, "distance": { "type": "string", "description": "里程" }, "ret_code": { "type": "number", "description": "0 无异常\n10 参数错误 \n20 文件格式错误 \n30 操作失败,请勿重复提交\n40 文件下载失败\n50 文件内容过大\n60 图片解析失败\n70 OCR识别失败\n80 服务超时\n90 未知错误" }, "num": { "type": "string", "description": "发票号码" }, "service_city": { "type": "string", "description": "市" }, "total_fee": { "type": "string", "description": "总金额" }, "taxi_num": { "type": "string", "description": "车牌号" }, "fuel_surcharge": { "type": "string", "description": "燃油附加费" }, "get_off_time": { "type": "string", "description": "下车时间" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2417_8_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "img_base64": { "type": "string", "minLength": 0, "maxLength": 10000000, "description": "图片base64字符串\n\nimg_base64和img_url 二选一，同时存在以base64为主" }, "img_url": { "type": "string", "description": "图片url\n\nimg_base64和img_url 二选一，同时存在以base64为主" } } } } } } } }, "/2417-7": { "x-pointCode": 7, "x-mode": "mapping", "x-read-timeout": 30, "x-connect-timeout": 30, "post": { "summary": "二手车统一销售发票识别", "description": "支持二手车销售统一发票进行结构化识别，包括：开票日期、发票号码、买方单位、卖方单位等\n图片要求：小于10M，\n重要：图片不能重叠拍出来（不能有重影），否则识别不准\n格式支持：PNG、JPG、JPEG、BMP。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number", "description": "0 无异常(计费，其余不计费)\n10 参数错误 \n20 文件格式错误 \n30 操作失败,请勿重复提交\n40 文件下载失败\n50 文件内容过大\n60 图片解析失败\n70 OCR识别失败\n80 服务超时\n90 未知错误" }, "type_name": { "type": "string", "description": "标题" }, "invoice_copies": { "type": "string", "description": "联次" }, "invoice_date": { "type": "string", "description": "开票日期" }, "invoice_code": { "type": "string", "description": "发票代码" }, "invoice_num": { "type": "string", "description": "发票号码" }, "machine_code": { "type": "string", "description": "机打代码" }, "machine_num": { "type": "string", "description": "机打号码" }, "tax_code": { "type": "string", "description": "税控码" }, "purchaser_name": { "type": "string", "description": "买方单位/个人" }, "purchaser_code": { "type": "string", "description": "买方单位代码/身份证号码" }, "purchaser_addr": { "type": "string", "description": "买方单位/个人地址" }, "purchaser_phone": { "type": "string", "description": "买方电话" }, "seller_name": { "type": "string", "description": "卖方单位/个人" }, "seller_code": { "type": "string", "description": "卖方单位代码/身份证号码" }, "seller_addr": { "type": "string", "description": "卖方单位/个人住址" }, "seller_phone": { "type": "string", "description": "卖方电话" }, "license_plate_number": { "type": "string", "description": "车牌照号" }, "certificate_num": { "type": "string", "description": "登记证号" }, "vehicle_type": { "type": "string", "description": "车辆类型" }, "vin": { "type": "string", "description": "车架号/车辆识别代码" }, "brand_model": { "type": "string", "description": "厂牌型号" }, "transfer_vehicle_administration_name": { "type": "string", "description": "转入地车辆管理所名称" }, "total_amount_words": { "type": "string", "description": "车价合计(大写)" }, "total_amount": { "type": "string", "description": "车价合计(小写)" }, "used_car_market_name": { "type": "string", "description": "二手车市场名称" }, "used_car_market_tax_num": { "type": "string", "description": "二手车市场纳税人识别号" }, "used_car_market_addr": { "type": "string", "description": "二手车市场地址" }, "used_car_market_bank_account": { "type": "string", "description": "二手车市场开户银行及账户" }, "used_car_market_phone": { "type": "string", "description": "二手车市场电话" }, "remark": { "type": "string", "description": "备注" }, "drawer": { "type": "string", "description": "开票人" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2417_7_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "img_base64": { "type": "string", "minLength": 0, "maxLength": 10000000, "description": "图片base64字符串\n\nimg_base64和img_url 二选一，同时存在以base64为主" }, "img_url": { "type": "string", "description": "图片url（长度不超 2048）\n\nimg_base64和img_url 二选一，同时存在以base64为主" } } } } } } } }, "/2417-6": { "x-pointCode": 6, "x-mode": "mapping", "x-read-timeout": 30, "x-connect-timeout": 30, "post": { "summary": "增值税发票识别", "description": "结构化识别增值税普票、专票、电子发票、卷票、区块链发票的所有关键字段，包括发票基本信息、销售方及购买方信息、商品信息、价税信息等。\n图片要求：小于4M，\n像素要求：短边像素大于256，\n格式支持：PNG、JPG、JPEG、BMP。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "machine_num": { "type": "string", "description": "机打号码。仅增值税卷票含有此参数" }, "purchaser_register_num": { "type": "string", "description": "购方纳税人识别号" }, "seller_add": { "type": "string", "description": "销售方地址及电话" }, "type": { "type": "string", "description": "发票种类：普通发票、专用发票、电子普通发票、电子专用发票、通行费电子普票、区块链发票、通用机打电子发票" }, "drawer": { "type": "string", "description": "开票人" }, "pwd_area_text": { "type": "string", "description": "密码区" }, "seller_bank": { "type": "string", "description": "销售方开户行及账号" }, "invoice_code": { "type": "string", "description": "发票代码" }, "city": { "type": "string", "description": "市" }, "ret_code": { "type": "number", "description": "0 无异常\n10 参数错误 \n20 文件格式错误 \n30 操作失败,请勿重复提交\n40 文件下载失败\n50 文件内容过大\n60 图片解析失败\n70 OCR识别失败\n80 服务超时\n90 未知错误" }, "province": { "type": "string", "description": "省" }, "total_tax": { "type": "string", "description": "合计税额" }, "total_amount": { "type": "string", "description": "合计金额" }, "check_code": { "type": "string", "description": "校验码。增值税专票无此参数" }, "amount_in_words": { "type": "string", "description": "价税合计(大写)" }, "payee": { "type": "string", "description": "收款人" }, "invoice_code_confirm": { "type": "string", "description": "发票代码的辅助校验码" }, "invoice_num_confirm": { "type": "string", "description": "发票号码的辅助校验码" }, "purchaser_addr": { "type": "string", "description": "购方地址及电话" }, "checker": { "type": "string", "description": "复核" }, "invoice_num": { "type": "string", "description": "发票号码" }, "Invoice_date": { "type": "string", "description": "开票日期" }, "purchaser_name": { "type": "string", "description": "购方名称" }, "machine_code": { "type": "string", "description": "机器编号。仅增值税卷票含有此参数" }, "purchaser_bank": { "type": "string", "description": "购方开户行及账号" }, "amount_in_figuers": { "type": "string", "description": "价税合计(小写)" }, "items": { "type": "array", "items": { "type": "object", "properties": { "spec": { "type": "string", "description": "规格" }, "unit": { "type": "string", "description": "单位" }, "num": { "type": "string", "description": "数量" }, "item_tax_amount": { "type": "string", "description": "金额" }, "line_no": { "type": "string", "description": "行号" }, "product_name": { "type": "string", "description": "服务/货物名称" }, "item_tax_rate": { "type": "string", "description": "税率" }, "item_tax": { "type": "string", "description": "税额" }, "unit_price": { "type": "string", "description": "单价" } } }, "description": "开票项目" }, "type_name": { "type": "string", "description": "发票名称" }, "seller_reg_num": { "type": "string", "description": "销售方纳税人识别号" }, "seller_name": { "type": "string", "description": "销售方名称" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2417_6_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "img_base64": { "type": "string", "minLength": 0, "maxLength": 10000000, "description": "图片base64字符串\n\nimg_base64和img_url 二选一，同时存在以base64为主" }, "img_url": { "type": "string", "description": "图片url\n\nimg_base64和img_url 二选一，同时存在以base64为主" } } } } } } } }, "/2417-5": { "x-pointCode": 5, "x-mode": "mapping", "x-read-timeout": 5, "x-connect-timeout": 5, "post": { "summary": "火车票识别", "description": "支持对红、蓝火车票进行结构化识别，包括车票号码、始发站、目的站、车次、日期、票价、席别、姓名、座位号、身份证号、时间等。\n图片要求：小于4M，\n像素要求：短边像素大于256，\n格式支持：PNG、JPG、JPEG、BMP。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number", "description": "0 无异常\n10 参数错误 \n20 文件格式错误 \n30 操作失败,请勿重复提交\n40 文件下载失败\n50 文件内容过大\n60 图片解析失败\n70 OCR识别失败\n80 服务超时\n90 未知错误" }, "ticket_num": { "type": "string", "description": "车票号" }, "start_station": { "type": "string", "description": "始发站" }, "train_num": { "type": "string", "description": "车次号" }, "dest_station": { "type": "string", "description": "到达站" }, "time": { "type": "string", "description": "出发时间" }, "ticket_price": { "type": "string", "description": "车票金额" }, "seat_type": { "type": "string", "description": "席别" }, "name": { "type": "string", "description": "乘客姓名" }, "id_num": { "type": "string", "description": "身份证号" }, "seat_num": { "type": "string", "description": "座位号" }, "date": { "type": "string", "description": "出发日期 格式 YYYYMMDD" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2417_5_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "img_base64": { "type": "string", "minLength": 0, "maxLength": 10000000, "description": "图片base64字符串\n\nimg_base64和img_url 二选一，同时存在以base64为主" }, "img_url": { "type": "string", "description": "图片url\n\nimg_base64和img_url 二选一，同时存在以base64为主" } } } } } } } }, "/2417-3": { "x-pointCode": 3, "x-mode": "mapping", "x-read-timeout": 60, "x-connect-timeout": 60, "post": { "summary": "增值税发票验真(base64)", "description": "自动识别发票图片中的信息\n实时联网核验发票真伪并返回全票面信息（核验失败也计费）", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number", "description": "接口调用是否成功,0为成功,其他为失败" }, "remark": { "type": "string", "description": "提示信息\n成功：\n校验成功\n失败：\n查验不成功，请重试。\n查验不一致! \n查无此票! \n超过该张发票当日查验次数(请于次日再次查验)!" }, "itemList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "商品名称" }, "priceAmt": { "type": "string", "description": "金额" }, "taxRate": { "type": "string", "description": "税率" }, "taxAmt": { "type": "string", "description": "税额" }, "priceUnit": { "type": "string", "description": "单价" }, "unit": { "type": "string", "description": "单位" }, "spec": { "type": "string", "description": "规格" }, "amount": { "type": "string", "description": "数量" } } }, "description": "商品信息" }, "invoiceType": { "type": "string", "description": "发票类型：(可能为空)\n增值税专用发票\n增值税普通发票\n增值税专用发票（电子）\n增值税普通发票（电子）\n增值税普通发票（卷式）\n增值税普通发票（通行费）" }, "invoiceCode": { "type": "string", "description": "发票代码" }, "invoiceNo": { "type": "string", "description": "发票号码" }, "invoiceDate": { "type": "string", "description": "开票日期" }, "buyerName": { "type": "string", "description": "购方名称" }, "buyerTaxNo": { "type": "string", "description": "购方税号" }, "buyerContact": { "type": "string", "description": "购方地址电话" }, "buyerBank": { "type": "string", "description": "购方开户行账户" }, "salerName": { "type": "string", "description": "销方名称" }, "salerTaxNo": { "type": "string", "description": "销方税号" }, "salerContact": { "type": "string", "description": "销方地址电话" }, "salerBank": { "type": "string", "description": "销方开户行账户" }, "invoiceAmt": { "type": "string", "description": "合计金额" }, "totalTaxAmt": { "type": "string", "description": "合计税额" }, "totalAmt": { "type": "string", "description": "价税合计" }, "notes": { "type": "string", "description": "发票备注" }, "status": { "type": "string", "description": "发票状态 1、未作废　2、作废 3、红冲" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2417_3_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "imgUrl": { "type": "string", "description": "图片的可访问下载地址,与imgBase64参数二选一" }, "imgBase64": { "type": "string", "minLength": 0, "maxLength": 10000000, "description": "图片的Base64字符串,与imgUrl参数二选一" } } } } } } } }, "/2417-1": { "x-pointCode": 1, "x-mode": "mapping", "x-read-timeout": 60, "x-connect-timeout": 60, "post": { "summary": "增值税发票验真", "description": "快速接入国家税务机关发票查验平台进行发票真伪及字段信息准确性核验，应用于企业税务核算及费控报销管理、供应链发票核验、财税代理记账等场景，有效降低人力查验成本，护航企业财务信息安全", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number", "description": "接口调用是否成功,0为成功,其他为失败" }, "remark": { "type": "string", "description": "提示信息\n成功：\n校验成功\n失败：\n查验不成功，请重试。\n查验不一致! \n查无此票! \n超过该张发票当日查验次数(请于次日再次查验)!" }, "itemList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "商品名称" }, "priceAmt": { "type": "string", "description": "金额" }, "taxRate": { "type": "string", "description": "税率" }, "taxAmt": { "type": "string", "description": "税额" }, "priceUnit": { "type": "string", "description": "单价" }, "unit": { "type": "string", "description": "单位" }, "spec": { "type": "string", "description": "规格" }, "amount": { "type": "string", "description": "数量" } } }, "description": "商品信息" }, "invoiceType": { "type": "string", "description": "发票类型：(可能为空)\n增值税专用发票\n增值税普通发票\n增值税专用发票（电子）\n增值税普通发票（电子）\n增值税普通发票（卷式）\n增值税普通发票（通行费）" }, "invoiceCode": { "type": "string", "description": "发票代码" }, "invoiceNo": { "type": "string", "description": "发票号码" }, "invoiceDate": { "type": "string", "description": "开票日期" }, "buyerName": { "type": "string", "description": "购方名称" }, "buyerTaxNo": { "type": "string", "description": "购方税号" }, "buyerContact": { "type": "string", "description": "购方地址电话" }, "buyerBank": { "type": "string", "description": "购方开户行账户" }, "salerName": { "type": "string", "description": "销方名称" }, "salerTaxNo": { "type": "string", "description": "销方税号" }, "salerContact": { "type": "string", "description": "销方地址电话" }, "salerBank": { "type": "string", "description": "销方开户行账户" }, "invoiceAmt": { "type": "string", "description": "合计金额" }, "totalTaxAmt": { "type": "string", "description": "合计税额" }, "totalAmt": { "type": "string", "description": "价税合计" }, "notes": { "type": "string", "description": "发票备注" }, "machineCode": { "type": "string", "description": "机器编码" }, "verCode": { "type": "string", "description": "校验码" }, "status": { "type": "string", "description": "发票状态 1、未作废　2、作废 3、红冲" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2417_1_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "invoiceCode": { "type": "string", "description": "发票代码【注意：除全电票外，其他必传】" }, "invoiceNo": { "type": "string", "description": "发票号码" }, "invoiceDate": { "type": "string", "description": "开票日期（格式：yyyy-MM-dd）" }, "invoiceAmt": { "type": "string", "description": "不含税金额 ，必须精确到两位小数【注意：除普票外 其他必填。全电票传价税合计，其他发票传不含税金额】" }, "verCode": { "type": "string", "description": "校验码，除专票外，其他必填" } }, "required": [ "invoiceNo", "invoiceDate", "invoiceAmt" ] } } } } } } }, "components": { "securitySchemes": { "AppKeyAuth": { "type": "apiKey", "in": "query", "name": "appKey", "description": "从 ShowAPI 控制台获取的 appKey，管理地址：https://www.showapi.com/console#/myApp" } }, "schemas": { "ShowapiResEnvelope": { "type": "object", "description": "ShowAPI 统一返回包裹（业务数据位于 showapi_res_body）", "properties": { "showapi_res_code": { "type": "integer", "description": "API 返回的状态码" }, "showapi_res_error": { "type": "string", "description": "API 返回的错误信息" }, "showapi_res_id": { "type": "string", "description": "API 请求的唯一标识" }, "showapi_fee_num": { "type": "integer", "description": "API 调用计费次数" } } } } }, "security": [ { "AppKeyAuth": [] } ], "externalDocs": { "url": "https://www.showapi.com/apiGateway/view/2417?tab=book" }, "x-apiCode": "2417", "x-is-own": true, "x-is-op": true }