宜盟云 接口开放平台
微信客服 400-009-0352
宜盟云 / 接口开放平台

基本介绍

业务介绍#

宜盟云接口开放平台面向企业提供稳定的电子票证基础能力接口，按产品服务分为三组：发票API（增值税/财政票据/区块链发票查验及截图、数电票版式文件下载）、查重系统API（发票查重、发票真伪查验、发票 OCR 识别）、电子收据API（电子收据开具与管理）。

平台按产品服务独立鉴权，所有接口均采用 HTTP 标准协议与 JSON 数据格式，支持 Apifox 在线调试。合作方可根据业务需求选择对应服务接入，获取标准化 API 能力，实现发票管理、查验、收据开具等业务场景的数字化闭环。

产品能力#

平台按服务分组，每个服务有独立的鉴权方式和服务器地址。点击接口名称可查看完整参数说明与请求/响应示例。

产品类型产品名称产品简介
发票APIfpopen.ymion.com获取凭证appkey / appSecrect 换取 access_token
增值税发票查验查验增值税发票（含数电票）真伪及票面信息
财政票据查验查验财政电子票据真伪及票面信息
区块链（深圳）发票查验查验区块链发票真伪
发票查验截图生成增值税发票查验结果截图（Base64）
发票OCR识别OCR 识别发票图片，返回票面信息
版式文件异步下载提交下载任务，成功后向回调地址推送结果
版式文件同步下载同步方式直接获取版式文件，无需回调
原件对象结构下载成功返回的 value 对象结构说明
返回码说明版式文件下载接口的返回码定义
查重系统APIwxinvoicewebapi.ymion.com获取请求 Token提交 unitId / openId 换取调用凭据 token
提交发票向服务器提交发票，若重复返回重复信息
发票查重独立查重接口，不对发票库做操作
发票 OCR 识别对发票图片进行识别，返回格式化对象
发票真伪查验提交查验请求，返回发票真伪与票面信息
电子收据APIsjtapi.ymion.com获取 Tokenappkey / appSecret 换取全局唯一 token
电子收据开具根据场景开具收据，返回 PDF 与二维码
电子收据预览预览收据，返回预览图片地址
收据状态更改对已开具收据进行退款/作废操作
已开收据查询列表分页查询已开具的收据列表
收据详情查询根据收据 ID 查询单张收据详情

联系我们#

宜盟云 · 接口开放平台

对接咨询请通过宜盟云商务渠道联系获取 appkey / appSecrect 等接入凭证。

修改于 2026-09-29
宜盟云 / 接口开放平台 / 对接指引

对接指引

接入前需了解各服务的鉴权方式、环境地址与公共约定。

鉴

接口鉴权

平台按产品服务划分鉴权方式。各服务均使用 token 作为接口调用凭据，在业务请求头中通过 Authorization: "<token>" 携带。

发票查重与真伪查验

调用方需申请 unitId（单位 ID）与 openId（用户 ID），由宜盟云查重工具提供。先调用「获取请求 Token」接口换取 token，再调用其它业务接口。

电子收据

调用方需申请 appkey 与 appSecret 授权凭据，由宜盟云提供。通过「获取 Token」接口换取全局唯一凭据 token。

💡
  • token 全局唯一，为减少获取 token 次数，建议调用方使用缓存服务缓存 token 值，并在过期前（建议 23 小时 50 分钟）重新获取。

发票查验

调用方需申请 appkey 与 appSecrect 授权凭据，由宜盟云提供。通过「获取凭证」接口（/api/oauth/login）换取 access_token，放入业务请求头 Authorization 中。

💡
  • access_token 有效期为 2 小时，建议缓存并在 1 小时 50 分钟时重新获取。
环

环境地址

服务环境服务器地址鉴权方式
发票查重与真伪查验正式https://wxinvoicewebapi.ymion.comunitId / openId
电子收据测试https://testsjtapi.ymion.comappkey / appSecret
电子收据正式https://sjtapi.ymion.comappkey / appSecret
发票查验正式https://fpopen.ymion.comappkey / appSecrect
约

公共约定

请求格式

请求参数为 JSON 格式，请求头须携带 Content-Type: application/json; charset=utf-8（除 OCR 识别使用 multipart/form-data）。

响应结构

统一响应结构为 { code, msg, isSuccess, data }（部分历史接口使用 { Code, Msg, IsSuccess, Data }，大小写略有差异，以各接口说明为准）。isSuccess=true 表示请求处理成功。

修改于 2026-09-29
宜盟云 / 接口开放平台 / 查重系统API

查重系统API

服务地址：https://wxinvoicewebapi.ymion.com　鉴权：unitId / openId　请求头携带 Authorization: token

述

产品概述

发票查重与真伪查验服务面向企业发票管理场景，提供发票查重、提交入库、真伪查验与 OCR 识别四项核心能力。调用方通过 unitId / openId 鉴权获取 token 后，可对增值税发票（含数电票）、财政票据、区块链发票等进行查重和真伪核验。

容

内容说明

内容说明
支持票据类型增值税专票/普票（含电子）、数电票、财政电子票据、区块链电子发票、机动车销售统一发票、二手车销售统一发票、通行费电子普票等
地理范围全国
数据内容查重返回重复状态；真伪查验返回全票面信息
服务方式API 接口
响应时间平均 1-2s，高峰期可能较长
议

使用建议

ℹ️
  • 先调用「获取请求 Token」获取 token，后续接口在请求头 Authorization 中携带。
  • 提交发票时如返回 402 表示发票重复，data 返回已存在的发票对象。
  • 发票查重接口为独立查重，不对发票库做任何操作。
  • 真伪查验最终判断以 Code=0 且 IsSuccess=true 时返回的发票对象票面字段为准。
试

在线调试

发票查重与真伪查验wxinvoicewebapi.ymion.com
5 个接口 · unitId / openId · 请求头携带 token
POST/api/PcLogin/UnitGetToken运行
POST/api/InvoiceList/AddInvoice运行
POST/api/InvoiceList/GetInvoiceByInvoiceNumber运行
POST/api/WxUploadFile/OCRImageToInvoice运行
POST/api/InvoiceList/VerifyInvoiceAuthenticity运行

点击即可免登录在线调试，选环境、填参数、发请求、看响应。

修改于 2026-09-29
宜盟云 / 接口开放平台 / 电子收据API

电子收据API

测试地址：https://testsjtapi.ymion.com　正式地址：https://sjtapi.ymion.com　鉴权：appkey / appSecret　请求头携带 Authorization: token

述

产品概述

电子收据服务提供完整的收据生命周期管理，涵盖收据开具、预览、状态变更（退款/作废）、列表查询与详情查询。调用方通过 appkey / appSecret 鉴权获取 token（有效期 24 小时），在业务请求头中携带 token 调用各接口。

容

内容说明

内容说明
服务方式API 接口
鉴权方式appkey / appSecret → token（24h）
收据格式PDF（有效期 24 小时下载地址）+ 二维码
状态流转已开具(4) → 退款(5) / 作废(7)
邮件通知开具时可指定邮箱自动发送 PDF
议

使用建议

ℹ️
  • token 全局唯一，建议缓存并在到期前 23 小时 50 分钟重新获取。
  • 开具收据需提供 orgId、myTemplateId、mySignaturesId，由宜盟云快收据提供。
  • 预览接口参数与开具接口一致，返回图片地址用于预览不落库。
  • 退款/作废操作需指定 receiptId 和 status（5 退款 / 7 作废）。
试

在线调试

电子收据sjtapi.ymion.com
6 个接口 · appkey / appSecret · token 有效期 24 小时
POST/api/oauth/login运行
POST/api/receipt/add运行
POST/api/receipt/preview_png运行
POST/api/receipt/updateStatus运行
POST/api/receipt/getPageList运行
GET/api/receipt/detail运行

点击即可免登录在线调试，选环境、填参数、发请求、看响应。

修改于 2026-09-29
宜盟云 / 接口开放平台 / 发票API

发票API

服务地址：https://fpopen.ymion.com　鉴权：appkey / appSecrect　请求头携带 Authorization: access_token　token 有效期 2 小时

述

产品概述

发票API服务提供四类核心接口，统一通过 appkey / appSecrect 鉴权获取 access_token（有效期 2 小时），在业务请求头中携带。发票查验：对接国家税务总局发票查验平台，支持增值税发票（含数电票）、财政票据、区块链（深圳）发票的真伪查验。发票查验截图：生成增值税发票查验结果截图并返回 Base64 图片。版式文件下载：下载数电票版式文件，支持异步（回调推送）与同步两种方式。发票OCR识别：通过 OCR 识别技术快速识别发票照片信息，获取发票票面信息。

容

内容说明

内容发票查验发票查验截图版式文件下载发票OCR识别
接口路径invoice/cy（zzsfp / czpjfp / qklfp）invoice/cy/zzsfpjtinvoice/xml（downdzp / getdzp）invoice/ocr/ocrInvoice
覆盖范围增值税（含数电票）、财政票据、区块链（深圳）增值税发票查验结果数电票版式文件（XML/OFD/PDF）发票照片票面信息识别
票据数据增值税：最近 5 年；财政：最近 1 年；区块链：全部———
返回形式真伪判定 + 全票面信息Base64 图片异步回调推送 / 同步直取发票票面信息对象
查验模式CheckMode: 1 旧版 / 2 新版 / 3 自动（仅增值税查验）———
计费规则Code=200 扣费；增值税 006/009、财政 1006/1008 也扣费Code=200 扣费，data 为空不扣费下载成功才计费，失败不计费Code=200 扣费，data 为空不扣费
议

使用建议

ℹ️
  • 数电票（20 位发票号码）fpdm 传空字符串，jym 可不传。
  • CheckMode 建议明确传 2（新版），避免自动模式下未标记新版导致查验失败。
  • 查验失败提示税局异常时建议重试；提示参数不合法/不存在/不一致/超次数时不要重试。
  • 查验截图仅支持增值税发票，data 为空不扣费。
  • 发票OCR识别：imageUrl（发票可访问链接）与 imageData（图片 Base64 字符串）二选一传入，优先传 imageData；Code=200 扣费、data 为空不扣费。
  • 版式文件异步下载需保证回调地址可访问并返回 {"Code":200,"Msg":""}，超 1 小时未收到回调可改调同步接口 getdzp。
  • 建议缓存 access_token，在到期前 1 小时 50 分钟重新获取。
试

在线调试

发票APIfpopen.ymion.com
9 个接口 · 发票查验 / 查验截图 / 版式文件下载 / 发票OCR识别 · appkey / appSecrect · token 有效期 2 小时
POST/api/oauth/login运行
POST/api/invoice/cy/zzsfp运行
POST/api/invoice/cy/czpjfp运行
POST/api/invoice/cy/qklfp运行
POST/api/invoice/cy/zzsfpjt运行
POST/api/invoice/xml/downdzp运行
POST/api/invoice/xml/getdzp运行
POST/api/invoice/ocr/ocrInvoice运行

点击即可免登录在线调试，选环境、填参数、发请求、看响应。

修改于 2026-09-29
查重系统API / 获取请求 Token
POST获取请求 Token
Run in Apifox

用户客户端向查重工具服务器提交计费请求，返回调用凭据 token。

请求地址/api/PcLogin/UnitGetTokenPOST

请求参数

参数名称含义说明
unitId单位 ID由宜盟云查重工具提供，必传
openId用户 ID由宜盟云查重工具提供，必传

响应数据

响应示例{
  "Code": "1",
  "IsSuccess": true,
  "Msg": "",
  "Data": "token值"   // Data 为对象
}
字段说明
Code请求结果。1 成功 / 999 未登录 / 998 无应用 / 997 无应用权限 / 996 未设置单位
Msg提示信息
Data对象格式，此处返回 token 字符串
查重系统API / 提交发票
POST提交发票
Run in Apifox

用于向服务器提交发票；若发票重复，将返回重复信息。

请求地址/api/InvoiceList/AddInvoicePOST · JSON

请求头 Authorization: "access_token"，请求体类型 application/json; charset=utf-8。

请求参数对象定义

参数名称含义说明
invoiceCode发票号码
invoiceNum发票代码
invoiceType发票类型Int，indexID 值，见下方「发票类型取值」
invoiceDate开票日期日期格式 yyyy-MM-dd
invoiceValCode验证码
invoiceMoney发票金额（不含税）数值型，两位小数
invoiceMoneyRate价税合计数值型，两位小数
invoiceCompany销方名称
SellerCreditCode销方税号
buyCompany购方名称
BuyCreditCode购方税号
openId录入人 openID
unitID单位 ID
rateNum税率数值型，存储 value，显示用 name，见下方「税率取值」
rateMoney税率金额数值型，两位小数
reimbursePerson报销人
reimburseCert报销凭证
belongCompanyName发票所属单位
invoiceUseType发票用途
reimburseDate报销日期
valTrueID验真 ID验真表中的 ID

发票类型取值（indexID / indexShow）

indexIDindexShowindexIDindexShow
0增值税电子普通发票1区块链电子发票
11增值税电子专用发票4财政电子票据
14电子发票（普通发票）12通用（电子）发票
15电子发票（增值税专用发票）8定额发票
16电子发票（铁路电子客票）9通用机打发票
18电子发票（航空运输电子客票行程单）7货运运输业增值税专用发票
2增值税专用发票6机动车销售统一发票
3增值税普通发票17二手车销售统一发票
13增值税电子普通发票（通行费）10其他发票
5增值税卷式普通发票

税率取值（value / name）

valuenamevaluename
00%1414%
11%1515%
1.51.5%1717%
33%-2免税
55%-3不征税
66%-4-（无）
99%-5差额征税
1010%1313%

响应数据

响应示例{
  "Code": "1",          // 1 表示请求成功
  "IsSuccess": true,
  "Msg": "",
  "Data": {}
}
字段说明
Msg402 发票重复，当前发票库中存在此发票，data 返回存在的发票对象；405 录入张数有限制；200 提交成功或提交的发票审核成功（开启员工预填写才有审核功能），data 返回发票 ID（字符串格式）。若 IsSuccess 为 false，此字段显示错误信息。
Data根据状态不同，返回对象内容不同
查重系统API / 发票查重
POST发票查重
Run in Apifox

独立发票查重接口，不对发票库数据做任何操作。

请求地址/api/InvoiceList/GetInvoiceByInvoiceNumberPOST · JSON

请求头 Authorization: "access_token"，请求体类型 application/json; charset=utf-8。

请求参数

参数名称含义说明
InvoiceCode发票号码必传
InvoiceNum发票代码必传；数电票没有代码，传空字符串即可

响应数据

响应示例{
  "Code": "1",
  "IsSuccess": true,
  "Msg": "",
  "Data": {}   // Data 为对象
}
字段说明
Code请求结果。0 成功 / 999 未登录 / 998 无应用 / 997 无应用权限 / 996 未设置单位
Msg提示信息
Data返回 null，表示当前发票库中没有此发票；若返回一个发票对象，则表示是重复发票，发票库中已有此发票
查重系统API / 发票 OCR 识别
POST发票 OCR 识别
Run in Apifox

完成对发票图片的识别，返回发票格式化对象。

请求地址/api/WxUploadFile/OCRImageToInvoicePOST · FormData

请求头 Authorization: "access_token"，请求体为 multipart/form-data 表单数据。

请求参数

参数名称含义说明
file发票图片multipart/form-data 类型传一张发票图片，使用 form-data（表单数据）作为请求体类型

响应数据

响应示例{
  "Code": "1",
  "IsSuccess": true,
  "Msg": "",
  "Data": {
    "InvoiceType": "发票类型",
    "InvoiceTypeName": "发票类型名称",
    "InvoiceCode": "发票代码",
    "InvoiceNum": "发票号码",
    "InvoiceTime": "开票时间",
    "VerifyCode": "校验码",
    "BTaxFee": 0,        // 税前金额 decimal
    "ATaxFee": 0,        // 税后金额 decimal
    "TaxFee": 0,         // 税额 decimal
    "RateNum": 0,        // 税率 decimal
    "SellerName": "销售方名称",
    "SellerCreditCode": "销售方纳税人识别号/统一信用代码",
    "SellerAddrTel": "销售方地址电话",
    "SellerFinancialAccount": "销售方开户行及账号",
    "BuyName": "购买方名称",
    "BuyCreditCode": "购买方纳税人识别号/统一信用代码",
    "BuyerAddrTel": "购买方地址电话",
    "BuyerFinancialAccount": "购买方开户行及账号",
    "Payee": "收款人",
    "Checker": "审核人",
    "InvoiceClerk": "开票人",
    "bz": "备注",
    "fpxflx": "发票消费类型",
    "GoodsDetails": [{
      "GoodsName": "商品名称",
      "GoodsSpec": "规格",
      "GoodsUnit": "单位",
      "GoodsPrice": "单价",
      "GoodsNum": "数量",
      "GoodsAmount": "金额",
      "GoodsRate": "税率",
      "GoodsRateAmount": "税额"
    }]
  }
}
字段说明
Code请求结果。0 失败 / 1 成功 / 999 未登录 / 998 无应用 / 997 无应用权限 / 996 未设置单位
Msg提示信息
Data若 data 为 null，说明图片可能不是发票或识别失败；否则返回发票对象
查重系统API / 发票真伪查验
POST发票真伪查验
Run in Apifox

用于向服务器提交发票查验请求，返回该发票的真伪与票面信息。

请求地址/api/InvoiceList/VerifyInvoiceAuthenticityPOST · JSON

请求头 Authorization: "access_token"，请求体类型 application/json; charset=utf-8。

请求参数对象定义

参数名称含义说明
CurInvoiceType发票类型
InvoiceCode发票号码
InvoiceNum发票代码
BillingDate开票日期日期格式 yyyy-MM-dd
CheckCode验证码
TotalAmount发票金额增值税普通发票、增值税专用发票时，传税前金额
SalesTaxNo销方税号

响应数据

响应示例{
  "Code": "0",          // 0 表示请求成功
  "IsSuccess": true,
  "Msg": "",
  "Data": {}
}
字段说明
Msg402 发票重复；405 录入张数有限制；200 提交成功或提交的发票审核成功，data 返回发票 ID（字符串格式）。若 IsSuccess 为 false，此字段显示错误信息。
Data根据状态不同，返回对象内容不同
ℹ️
  • 本接口用于查验请求；最终真伪判断结果在响应 Code=0 且 IsSuccess=true 时成立，具体以返回的发票对象票面字段为准。
电子收据API / 获取 Token
POST获取 Token
Run in Apifox

token 是全局唯一的后台接口调用凭据，调用所有业务后台接口时都需使用。为减少获取 token 次数，调用方可使用缓存服务来缓存 token 值。

请求地址/api/oauth/loginPOST · JSON

请求示例

请求示例{
  "appkey": "授权appkey",       // 由宜盟云提供
  "appSecret": "授权appSecret"  // 由宜盟云提供
}

响应示例

响应示例{
  "reqId": "faef71ad383245839f73bc8029556311",
  "msg": "操作成功",
  "code": 200,        // 如果返回为 0，则表示获取失败，msg 中有失败具体原因
  "isSuccess": true,
  "data": {
    "token": "1e39e60bd39a47fdaa89d3c6020328c0",
    "expiresIn": 86400   // 过期时间，默认 24 小时
  }
}
💡
  • 建议缓存 token，建议在到期前 23 小时 50 分钟重新获取一次 token。
电子收据API / 电子收据开具
POST电子收据开具
Run in Apifox

根据当前场景开具收据。

请求地址/api/receipt/addPOST · JSON

请求头 Authorization: token。

请求参数说明

参数名称含义必填字段类型说明
orgId单位 ID*必填string由宜盟云快收据提供
myTemplateId模版 ID*必填string由宜盟云快收据提供
mySignaturesId签章 ID*必填string由宜盟云快收据提供
createTime开具日期*必填date收据日期
totalAmount付款金额*必填decimal
totalAmountCapital付款金额大写选填string不填写则自动生成
customerName付款单位/客户*必填string
customerPhone客户电话选填string客户绑定了电话，可以小程序接收收据
feeName费用类型选填string
receiveMethod收款方式选填string
email转交人邮箱地址选填string会自动发送收据 pdf 文件到邮箱
invoicingPerson开票人选填string
signerPerson签单人选填string
receivePerson收款人选填string
feeDetail费用详情选填string如有多行费用明细，需提供明细结构
otherJson其他数据 json选填string其他数据
remarks备注选填string

响应数据

响应示例{
  "reqId": "faef71ad383245839f73bc8029556311",
  "code": "200",               // "200" 表示请求成功
  "isSuccess": true,
  "msg": "",
  "data": {
    "receiptId": "收据id",
    "receiptNo": "收据编号",
    "pdfUrl": "PDF地址，有效期24小时",
    "qrCode": "二维码base64"    // 微信扫描二维码可查看收据详情
  }
}
电子收据API / 电子收据预览
POST电子收据预览
Run in Apifox

根据当前场景预览收据，返回预览图片地址。

请求地址/api/receipt/preview_pngPOST · JSON

请求头 Authorization: token，请求参数与「电子收据开具」接口的参数保持一致。

响应示例{
  "msg": "预览成功",
  "code": 200,
  "isSuccess": true,
  "data": "png图片格式地址"
}
电子收据API / 收据状态更改
POST收据状态更改
Run in Apifox

对已开具的收据进行状态更改（退款、作废）。

请求地址/api/receipt/updateStatusPOST · JSON

请求头 Authorization: token。

请求参数说明

参数名称含义必填字段类型说明
receiptId收据 ID*必填string开收据返回的收据 id
status状态*必填int5 退款 / 7 作废
orgid单位 ID跨团队操作必填string
operatorName操作人姓名选填string
operatorDesc操作说明选填string
响应示例{
  "reqId": "faef71ad383245839f73bc8029556311",
  "code": "200",               // "200" 表示请求成功
  "isSuccess": true,
  "msg": "",
  "data": null
}
电子收据API / 已开收据查询列表
POST已开收据查询列表
Run in Apifox

分页查询已开具的收据列表。

请求地址/api/receipt/getPageListPOST · JSON

请求头 Authorization: token。

请求参数说明

参数名称含义必填字段类型说明
keywords关键字选填string编号、交款单位、收款人等
orgId单位 ID选填string
status状态选填int4 已开具 / 5 退款 / 7 作废
startDate收据开始日期选填datetime
endDate收据结束日期选填datetime
pageIndex当前页选填int
pageSize每页行数选填int

响应数据

响应示例{
  "reqId": "faef71ad383245839f73bc8029556311",
  "code": "200",               // "200" 表示请求成功
  "isSuccess": true,
  "msg": "",
  "totalCount": "总条数",
  "data": [{
    "receiptId": "收据id",
    "receiptNo": "收据编号",
    "pdfUrl": "PDF地址，有效期24小时",
    "createTime": "开具日期",
    "totalAmount": "付款金额",
    "totalAmountCapital": "金额大写",
    "customerName": "付款单位/客户",
    "customerPhone": "客户电话",
    "feeName": "费用类型",
    "receiveMethod": "收款方式",
    "email": "邮箱地址",
    "invoicingPerson": "开票人",
    "receivePerson": "收款人",
    "signerPerson": "签单人",
    "feeDetail": "费用详情",
    "otherJson": "其他数据json",
    "remarks": "备注",
    "systemTime": "系统时间"
  }]
}
电子收据API / 收据详情查询
GET收据详情查询
Run in Apifox

根据收据 ID 查询单张收据的详情。

请求地址/api/receipt/detailGET
ℹ️
  • 通过收据 ID（receiptId）查询对应收据详情，返回该收据的完整票面信息。
发票API / 返回码说明
版式文件下载 · 返回码说明

注意外层与内层两套返回码：外层 Code/IsSuccess 仅为请求受理状态，异步下载接口通常固定返回 Code=200、IsSuccess=true；真正的下载结果以内层 Data.code 与 Data.message 为准，切不可仅凭外层 IsSuccess=true 判定成功。

返回码（Data.code）含义
1000成功（扣一次接口调用费用）
200税局服务器繁忙，下载失败，建议重新下载
1001下载失败，建议重新下载
1002授权失败，请联系客服处理（一般很少有这种情况）
1003查验不一致，请确认发票号码、日期及金额是否正确
1004未查询到发票
1005原件正在获取中
1006税局服务器繁忙，下载失败，建议重新下载
⚠️
  • 以文件 URL 是否有值为最终成功标准。智税云偶发返回 Data.code=1000（成功码）且 isCharging=true（扣费），但实际未下载到原件，例如当天发票返回：Data.message="当天发票不能下载原件"，且 value.wjs 中 xml_url、pdf_url、ofd_url 均为空。此时应视为失败，不要进入成功处理；轮询此类"失败但 code=1000"的结果也无意义，应直接停止轮询并按 failure 处理。
  • 判断成功建议以 Data.code=1000 且 wjs 三个下载地址至少一个非空为准。
发票API / 原件对象结构
版式文件下载 · 原件对象结构（value）

下载成功时，返回 value 原件对象，其中包含数电票类型、发票类型、开票日期，以及 XML / PDF / OFD 三种版式文件的下载地址。

value 原件对象{
  "Sdfplx": "",      // 数电票类型
  "Fplx": "",        // 发票类型
  "Kprq": "",        // 开票日期
  "Wjs": {
    "xml_url": "",   // xml 下载地址
    "pdf_url": "",   // pdf 下载地址
    "ofd_url": ""    // ofd 下载地址
  }
}
字段含义说明
Sdfplx数电票类型
Fplx发票类型
Kprq开票日期开具发票的日期
Wjs版式文件对象包含 xml / pdf / ofd 三种版式的下载地址，见下表
字段含义说明
xml_urlXML 版式地址XML 版式文件的下载地址
pdf_urlPDF 版式地址PDF 版式文件的下载地址
ofd_urlOFD 版式地址OFD 版式文件的下载地址
发票API / 版式文件异步下载
POST版式文件异步下载
Run in Apifox

向服务器提交发票版式文件下载任务。此接口仅用于生成下载任务，不产生接口调用费用；下载成功后，会向提交时携带的回调地址 POST 下载结果，由回调地址接收并解析。版式文件下载接口支持同步、异步两种方式。

请求地址/api/invoice/xml/downdzpPOST · JSON

请求参数说明

参数名称含义必填字段类型说明
fphm发票号码*必填string长度必须是 20 位数字
kprq开票日期*必填string日期格式 yyyy-MM-dd
kpje价税合计*必填string数值型，两位小数，且不能为 0
wjlxs返回文件类型选填string[]字符串数组，如 ["PDF","XML","OFD"]；可不传，默认返回 pdf,xml,ofd
callAdd回调地址*必填string下载成功后，把下载内容推送回这个地址
requestID请求 ID选填string不超过 32 位字符串，回调时会原样传回，方便更新；不传则接口自动生成
is_delete是否终止任务选填int默认 0；传 1 表示终止此发票号码对应的下载任务

请求示例

请求示例{
  "fphm": "24512000000293331762",
  "kprq": "2025-06-18",
  "kpje": "1345.67",
  "wjlxs": ["PDF", "XML", "OFD"],
  "callAdd": "https://example.com/callback",
  "requestID": "task_20250618_001",
  "is_delete": 0
}

响应示例

响应示例{
  "Code": 200,          // 200 表示请求成功
  "Msg": "",            // 消息内容
  "Data": ""            // 返回的任务 ID，可不用处理
}
💡
  • 回调成功后需返回 {"Code":200,"Msg":""}，若未能成功返回，服务器每 2 分钟会重发回调，直到成功接收并返回正确参数。
  • 如超过 1 小时仍未收到回调，可调用同步接口 /api/invoice/xml/getdzp 直接查询结果。
  • 发票原件下载完成后才计算一次操作调用费用，不成功不计费。
发票API / 版式文件同步下载
POST版式文件同步下载
Run in Apifox

以同步方式直接下载发票版式文件，无需回调地址。请求参数与原下载接口一致，但不需要 callAdd，同步结果直接返回，返回内容与回调地址接收到的对象一致。

请求地址/api/invoice/xml/getdzpPOST · JSON

请求头 Authorization: "access_token"，请求体类型 application/json; charset=utf-8。

请求参数说明

参数名称含义必填字段类型说明
fphm发票号码*必填string长度必须是 20 位数字
kprq开票日期*必填string日期格式 yyyy-MM-dd
kpje价税合计*必填string数值型，两位小数，且不能为 0
wjlxs返回文件类型选填string[]字符串数组，如 ["PDF","XML","OFD"]；可不传，默认返回 pdf,xml,ofd
requestID请求 ID选填string不超过 32 位字符串
isSynchronous是否同步任务*必填int这里直接传 1，表示使用同步接口

请求示例

请求示例{
  "fphm": "24512000000293331762",
  "kprq": "2025-06-18",
  "kpje": "1345.67",
  "wjlxs": ["PDF", "XML", "OFD"],
  "requestID": "task_20250618_001",
  "isSynchronous": 1
}

响应数据

返回对象与回调地址接收到的对象一致，含 code（1000 表示成功，扣一次接口调用费用）、message（消息内容）、requestID（提交时传递的 requestID）、value（版式文件原件对象）四个字段，详见原件对象结构。

响应示例{
  "code": 1000,
  "message": "成功",
  "requestID": "task_20250618_001",
  "value": {
    "Sdfplx": "",
    "Fplx": "",
    "Kprq": "2025-06-18",
    "Wjs": {
      "xml_url": "https://.../xxx.xml",
      "pdf_url": "https://.../xxx.pdf",
      "ofd_url": "https://.../xxx.ofd"
    }
  }
}
💡
  • Code 1000 表示成功（扣一次接口调用费用），非 1000 时查看 message 内容，不扣费，返回码定义见返回码说明。
  • 若下载不成功，可传入 is_delete 终止任务后重新提交。
发票API / 获取凭证
POST获取凭证（access_token）
Run in Apifox

使用 appkey 与 appSecrect 换取 access_token，业务接口凭此鉴权。access_token 有效期为 2 小时，建议缓存并在 1 小时 50 分钟时重新获取。

请求地址/api/oauth/loginPOST · JSON

请求参数说明

参数名称含义必填字段类型说明
appkey应用标识*必填string由宜盟云分配
appSecrect应用密钥*必填string由宜盟云分配

请求示例

请求示例{
  "appkey": "****************",
  "appSecrect": "****************"
}

响应示例

响应示例{
  "ReqId": "1c2f8d4e-9a3b-4c5d-8e6f-0a1b2c3d4e5f",
  "Msg": "成功",
  "Code": 200,
  "IsSuccess": true,
  "Data": {
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.xxxx",
    "expire_time": "2025-05-12 18:28:16"    // 过期时间，默认 2 小时
  }
}
💡
  • 建议缓存 access_token，在到期前 1 小时 50 分钟重新获取。
发票API / 增值税发票查验
POST增值税发票查验
Run in Apifox

查验增值税发票（含数电票）真伪及票面信息。扣费说明：Code 返回 200 时扣费，返回码 006、009 也扣费。仅支持查验最近 5 年内的发票。

请求地址/api/invoice/cy/zzsfpPOST · JSON

请求头 Authorization: "access_token"，请求体类型 application/json; charset=utf-8。

请求参数说明

参数名称含义必填字段类型说明
fpdm发票代码选填string数电票（全电发票）时为空
fphm发票号码*必填string数电票为 20 位
kprq开票日期*必填string格式 yyyy-MM-dd
je发票金额选填string税前金额（不含税）
jshj价税合计选填string含税金额
jym校验码选填string后 6 位。数电票（20位号码）可不传
CheckMode查验模式选填int1 旧版 / 2 新版 / 3 自动（默认），为空或 null 按 3 处理

请求示例

请求示例{
  "fpdm": "031001900111",
  "fphm": "24512000000293331762",
  "kprq": "2025-06-18",
  "je": "1234.56",
  "jshj": "1345.67",
  "jym": "123456",
  "CheckMode": 3
}

响应数据

返回 Data 对象含发票类型代码（0901-数电纸质发票(增值税专用发票)、0903-数电纸质发票(机动车销售统一发票)、0904-数电纸质发票(普通发票)、0920-数电票（增值税专用发票）、0910-数电票（普通发票）、8208-数电票（通行费发票）、0915-数电纸质发票(二手车统一销售发票)、0930-数电票（机动车销售统一发票））、发票状态（0 正常、2 作废、3 已红冲、7 部分红冲、8 全额红冲）、金额税额、购销双方信息、货物明细 hwxx 等。

响应示例{
  "ReqId": "1c2f8d4e-9a3b-4c5d-8e6f-0a1b2c3d4e5f",
  "Msg": "成功",
  "Code": 200,
  "IsSuccess": true,
  "Data": {
    "fpdm": "031001900111",
    "fphm": "24512000000293331762",
    "fplx": "0920",
    "jym": "123456",
    "kprq": "2025-06-18",
    "fpztDm": "0",
    "je": "1234.56",
    "se": "111.11",
    "jshj": "1345.67",
    "gfmc": "购方名称",
    "xfmc": "销方名称",
    "hwxx": [{ "mc": "货物名称", "je": "1234.56", "se": "111.11" }]
  }
}
发票API / 财政票据查验
POST财政票据查验
Run in Apifox

查验财政电子票据真伪及票面信息。扣费说明：Code 返回 200 时扣费，返回码 1006、1008 也扣费。仅支持查验最近 1 年内的票据。

请求地址/api/invoice/cy/czpjfpPOST · JSON

请求头 Authorization: "access_token"，请求体类型 application/json; charset=utf-8。

请求参数说明

参数名称含义必填字段类型说明
fpdm票据代码选填string财政票据代码
fphm票据号码*必填string财政票据号码
kprq开票日期*必填string格式 yyyy-MM-dd
je票据金额选填string票据金额
jym校验码选填string校验码

请求示例

请求示例{
  "fpdm": "031001900111",
  "fphm": "24512000000293331762",
  "kprq": "2025-06-18",
  "je": "1000.00",
  "jym": "123456"
}

响应数据

返回 Data 对象含票据类型、票据名称、交款人/收款单位/收款人、票据状态（01 正常、02 冲红）、冲红信息、打印/入账状态、其他信息 qtxx、项目明细 xmmx 等。

响应示例{
  "ReqId": "1c2f8d4e-9a3b-4c5d-8e6f-0a1b2c3d4e5f",
  "Msg": "成功",
  "Code": 200,
  "IsSuccess": true,
  "Data": {
    "fplx": "财政票据",
    "fpdm": "031001900111",
    "fphm": "24512000000293331762",
    "jym": "123456",
    "Kprq": "2025-06-18",
    "jehj": "1000.00",
    "pjmc": "票据名称",
    "jkr": "交款人",
    "skdw": "收款单位",
    "ch": "01",
    "dy": "01",
    "rz": "01",
    "xmmx": [{ "xmmc": "项目名称", "je": "1000.00" }]
  }
}
ℹ️
  • 仅支持查验最近 1 年内的财政票据。
  • 返回码 1006、1008 时同样扣费。
发票API / 区块链（深圳）发票查验
POST区块链（深圳）发票查验
Run in Apifox

查验区块链（深圳）发票真伪。扣费说明：Code 返回 200 时扣费，返回码为 1 时同样扣费。

请求地址/api/invoice/cy/qklfpPOST · JSON

请求头 Authorization: "access_token"，请求体类型 application/json; charset=utf-8。

请求参数说明

参数名称含义必填字段类型说明
fpdm发票代码选填string数电票可为空
fphm发票号码*必填string发票号码
kprq开票日期*必填string格式 yyyy-MM-dd
xfsbh销方识别号*必填string销售方纳税人识别号
jym校验码选填string校验码

请求示例

请求示例{
  "fpdm": "031001900111",
  "fphm": "24512000000293331762",
  "kprq": "2025-06-18",
  "xfsbh": "91440300XXXXXXXXX",
  "jym": "123456"
}

响应数据

返回 Data 对象含发票代码/号码、发票类型、开票日期、发票状态、金额税额、购销双方信息、开票类型 kjlx、开票机号 kpjh、开票人 kpr、数科码 skm 等。

响应示例{
  "ReqId": "1c2f8d4e-9a3b-4c5d-8e6f-0a1b2c3d4e5f",
  "Msg": "成功",
  "Code": 200,
  "IsSuccess": true,
  "Data": {
    "fpdm": "031001900111",
    "fphm": "24512000000293331762",
    "fplx": "区块链电子发票",
    "kprq": "2025-06-18",
    "fpzt": "0",
    "je": "1234.56",
    "se": "111.11",
    "jshj": "1345.67",
    "xfmc": "销方名称",
    "xfsbh": "91440300XXXXXXXXX",
    "kjlx": "正常开具",
    "kpr": "开票人"
  }
}
ℹ️
  • 返回码为 1 时同样扣费（表示查验成功但可能存在差异）。
发票API / 发票查验截图
POST发票查验截图
Run in Apifox

生成增值税发票查验结果截图，返回图片 Base64。扣费说明：Code 返回 200 时扣费，返回码 002、006、009、020 也扣费，若 data 为空则不扣费。注意：仅增值税发票支持查验截图。

请求地址/api/invoice/cy/zzsfpjtPOST · JSON

请求头 Authorization: "access_token"，请求体类型 application/json; charset=utf-8。

请求参数说明

参数名称含义必填字段类型说明
fpdm发票代码选填string数电票为空
fphm发票号码*必填string发票号码
kprq开票日期*必填string格式 yyyy-MM-dd
jym校验码选填string校验码
jshj价税合计选填string含税金额
je发票金额选填string发票金额
CheckMode查验模式选填int1 旧版 / 2 新版 / 3 自动（默认），为空或 null 按 3 处理

请求示例

请求示例{
  "fpdm": "031001900111",
  "fphm": "24512000000293331762",
  "kprq": "2025-06-18",
  "jym": "123456",
  "jshj": "1345.67",
  "je": "1234.56",
  "CheckMode": 3
}

响应数据

响应示例{
  "msg": "成功",
  "code": 200,
  "isSuccess": true,
  "data": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD..."  // 查验截图图片 Base64
}
ℹ️
  • 仅增值税发票支持查验截图。
  • 返回码 002、006、009、020 时同样扣费；data 为空则不扣费。
发票API / 发票 OCR 识别
POST发票 OCR 识别
Run in Apifox

通过 OCR 识别技术对发票图片进行识别，返回发票票面信息对象。扣费说明：Code 返回 200 时扣费；data 为空（识别失败或非发票）不扣费。

请求地址/api/invoice/ocr/ocrInvoicePOST · JSON

请求头 Authorization: "access_token"，请求体类型 application/json; charset=utf-8。

请求参数说明

参数名称含义必填字段类型说明
imageUrl发票图片地址二选一string发票图片的可访问互联网链接
imageData发票图片数据二选一string图片 Base64 编码字符串，与 imageUrl 二者选其一

请求示例

请求示例（imageUrl）{
  "imageUrl": "https://example.com/invoice.jpg"
}
请求示例（imageData）{
  "imageData": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBD..."
}

响应数据

返回 Data 发票对象，包含发票类型、发票代码/号码、开票时间、校验码、金额税额、购销双方信息、收款/审核/开票人及货物明细 GoodsDetails 等字段。

响应示例{
  "msg": "成功",
  "code": 200,
  "isSuccess": true,
  "data": {
    "InvoiceType": "发票类型",
    "InvoiceTypeName": "发票类型名称",
    "InvoiceCode": "发票代码",
    "InvoiceNum": "发票号码",
    "InvoiceTime": "开票时间",
    "VerifyCode": "校验码",
    "BTaxFee": 0,        // 税前金额 decimal
    "ATaxFee": 0,        // 税后金额 decimal
    "TaxFee": 0,         // 税额 decimal
    "RateNum": 0,        // 税率 decimal
    "SellerName": "销售方名称",
    "SellerCreditCode": "销售方纳税人识别号/统一信用代码",
    "SellerAddrTel": "销售方地址电话",
    "SellerFinancialAccount": "销售方开户行及账号",
    "BuyName": "购买方名称",
    "BuyCreditCode": "购买方纳税人识别号/统一信用代码",
    "BuyerAddrTel": "购买方地址电话",
    "BuyerFinancialAccount": "购买方开户行及账号",
    "Payee": "收款人",
    "Checker": "审核人",
    "InvoiceClerk": "开票人",
    "GoodsDetails": [{
      "GoodsName": "商品名称",
      "GoodsSpec": "规格",
      "GoodsUnit": "单位",
      "GoodsPrice": "单价",
      "GoodsNum": "数量",
      "GoodsAmount": "金额",
      "GoodsRate": "税率",
      "GoodsRateAmount": "税额"
    }],
    "MsgCode": "消息代码"
  }
}
💡
  • imageUrl 与 imageData 二者选其一，若都传以 imageData 为准。
  • Code 返回 200 时扣费；data 为空说明图片可能不是发票或识别失败，此时不扣费。
  • 建议优先使用 imageData 传图片 Base64，避免外链图片不可访问导致识别失败。
宜盟云接口开放平台 · 接口文档 v2.0
本文档涵盖发票查重与真伪查验、电子收据、发票查验（增值税/财政票据/区块链/查验截图/OCR识别）、版式文件下载四大能力模块。如与线上接口不一致，以实际返回为准。
微信客服 电话客服 400-009-0352