电子凭证解析及验签
接口描述
电子凭证解析及验签。
请求方式
POST
请求地址
https://qst.imfbp.com/apihub/api
URL 参数
| 参数名称 | 类型 | 必选 | 说明 |
|---|---|---|---|
| Action | String | 是 | 操作的接口名称，本接口取值：Xbrl。 |
Header 参数
| 参数名称 | 类型 | 必选 | 说明 |
|---|---|---|---|
| Timestamp | String | 是 | 公共参数。 |
| SecretId | String | 是 | 公共参数。 |
| Signature | String | 是 | 公共参数。 |
| Algorithm | String | 否 | 公共参数。 |
| Content-Type | String | 是 | 取值：multipart/form-data |
Body 请求参数
| 参数名称 | 类型 | 必选 | 说明 |
|---|---|---|---|
| fileData | File | 否 | OFD 文件 |
| file | File | 否 | OFD 文件 |
| fileByte | byte[] | 否 | OFD 二进制 |
| fileName | String | 是 | 如果参数使用 fileByte 则该参数为必选 |
| voucherType | String | 是 | 电子凭证类型(见 附录 一、接收方接收到的电子凭证类型枚举) |
| renderPDF | String | 是 | 是否渲染PDF。0:否 1:是 |
tip
fileData、file、fileByte 必须提供一个。
返回参数
公共返回参数
| 参数名称 | 类型 | 说明 |
|---|---|---|
| code | Integer | 200 表示请求成功，其他参见错误码 |
| message | String | 错误提示信息 |
| startTime | long | 开始时间 |
| endTime | long | 结束时间 |
| callId | long | 调用记录主键 |
| data | Object | 验签具体错误信息 |
data 内容说明
| 参数名称 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 是否解析成功 |
| verified | Boolean | 是否数字签名验签成功 |
| rootVerified | Boolean | 是否根证书验签成功 |
| xbrlJson | JSONObject | XbrlJson 对象 |
| signatureInfo | JSONObject | 签名证书信息 |
| errorMsg | String | 解析失败原因（如：票据类型不存在） |
| remark | String | 备注（如：未验签） |
| pdfBase64 | String | PDF的Base64编码 |
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
- code：错误码。
- message：错误描述信息，帮助理解和解决发生的错误。
| 错误码 | 描述 |
|---|---|
| 13000 | 验证成功 |
| 13001 | 验证失败 |
| 13002 | 电子签章数据失效 |
| 13003 | 文件被篡改 |
| 13004 | 文件未签章 |
| 13005 | 错误OFD文件结构和文档格式异常 |
| 13006 | 错误的OFD路径 |
| 13007 | 非OFD文件! |
| 13008 | voucherType【电子凭证类型】不能为空,(见:接收方接收到的电子凭证类型枚举)! |
| 4001 | 调用SDK权限校验不通过！ |
| 4002 | 调用接口Action不能为空！ |
| 4003 | API名称出错！ |
| 4004 | SecretId不能为空！ |
| 4005 | Timestamp不能为空！ |
| 4006 | Signature不能为空！ |
| 4007 | 用户没有调用当前API的权限！ |
| 4008 | 签名不正确 |
| 4009 | 查询用户密钥为空，请联系管理员 |
| 4010 | 无当前接口权限 |
| 4011 | Timestamp与服务器接收到请求的时间相差不得超过五分钟 |
| 4012 | apicode不能为空！ |
| 4013 | apicode未关联客户！ |
| 5001 | 不支持的请求方式 |
| 6001 | 套餐包余量不足 |
| 6002 | 未开通访问此API套餐 |
附录 一、接收方接收到的电子凭证类型枚举
下表列示了工具包当前版本支持的接收方接收到的电子凭证类型，及业务系统调用工具包接口时对应传入的凭证类型编号参数。
需要注意的是，随着电子凭证会计数据标准深化试点的推进，电子凭证类型以及开具地区或单位将逐步增加，工具包的迭代版本中将逐步增加新类型电子凭证的支持。
| 电子凭证类型 | 地区/单位 | 文件格式 | 接口调用参数凭证类型编号 |
|---|---|---|---|
| 数字化电子发票 | 全国 | xml | dzfp |
| 财政电子票据 | 中央单位 | efi | |
| 增值税电子普通发票 | - | zip | inv_ord_issuer |
| 增值税电子专用发票 | - | ofd | inv_spcl_issuer |
| 铁路电子客票 | 中国国家铁路集团有限公司 | ofd | rai_issuer |
| 航空运输电子客票行程单 | 航空公司/航空代理公司 | ofd | atr_issuer |
| 电子非税收入一般缴款书 | 中央单位 | ntrev_gpm_issuer | |
| 银行电子回单 | - | ofd | bker_issuer |
| 银行电子对账单 | - | ofd | bkrs |