• 开发文档
  • 在线调试

1、获取当前场景收据号

功能说明：获取当前场景要开具的收据号码

调用方式：GET（http）

调用地址：/api/Receipt/GetReceiptNo

请求参数：

参数 类型 说明 必填
token String 接口调用Token（令牌） 是
appKey String 场景调用唯一凭证 否

返回参数：

参数 类型 说明 必填
Status int http响应状态码（默认200） 是
Success bool 操作是否成功 否
Msg String 返回信息 否
Response object 返回结果 否
receiptNo String 收据号 否
number int 剩余可开具数量 否
acEndTime date 认证到期日期 否
orderNumber int 未付款订单数量 否

调用示例：

                              请求示例
                                {
                                "token": "接口调用Token",
                                "appKey": "场景调用唯一凭证",
                                }
                                响应示例:
                                {
                                "Status": 200,
                                "Success": true,
                                "Msg": "获取成功",
                                "Response": {
                                "ReceiptNo": "0000001",
                                "ACEndTime": "2022-01-30T11:48:00",
                                "OrderNumber": 0
                                }
                                }

2、电子收据开具前预览

功能说明：根据当前场景开具收据前预览

调用方式：POST（http）

调用地址：/api/Receipt/ReceiptPreview

请求参数：请参考开发文档中场景对应的参数

参数 类型 说明 必填

返回参数：

参数 类型 说明 必填
Status int http响应状态码（默认200） 否
Success bool 操作是否成功 否
Msg String 返回信息 否
Response string BASE64图片 否

3、电子收据开具

功能说明：根据当前场景开具收据

调用方式：POST（http）

调用地址：/api/Receipt/OpenerReceiptInfo

请求参数：请参考开发文档中场景对应的参数

参数 类型 说明 必填

返回参数：

参数 类型 说明 必填
Status int http响应状态码（默认200） 否
Success bool 操作是否成功 否
Msg String 返回信息 否
Response object 返回结果 否
receiptNo String 收据号 否
FilePath string 收据地址 否

4、已开电子收据预览

功能说明：获取已开电子收据预览

调用方式：GET（http）

调用地址：/api/Receipt/PreviewImg

请求参数：

参数 类型 说明 必填
token String 接口调用Token（令牌） 是
appKey String 场景调用唯一凭证 是
receiptNo String 收据号 是

返回参数：

参数 类型 说明 必填
Status int http响应状态码（默认200） 是
Success bool 操作是否成功 否
Msg String 返回信息 否
Response string 收据路径 否

调用示例：

 请求示例
   {
   "token": "接口调用Token",
   "appKey": "场景调用唯一凭证",
   "receiptNo": "收据号",
   }
   响应示例:
    {
       "Status": 200,
       "Success": true,
       "Msg": "获取成功",
       "Response": "/Common/GetPdfImg?receiptid=1560445877106409472"
    }

5、已开电子收据明细

功能说明：获取已开电子收据明细

调用方式：GET（http）

调用地址：/api/Receipt/GetReceiptDetailed

请求参数：

参数 类型 说明 必填
token String 接口调用Token（令牌） 是
appKey String 场景调用唯一凭证 是
receiptNo String 收据号 是

返回参数：

参数 类型 说明 必填
Status int http响应状态码（默认200） 是
Success bool 操作是否成功 否
Msg String 返回信息 否
Response string Base64图片 否

调用示例：

 请求示例
   {
   "token": "接口调用Token",
   "appKey": "场景调用唯一凭证",
   "receiptNo": "收据号",
   }
   响应示例:
    {
       "Status": 200,
       "Success": true,
       "Msg": "获取成功",
       "Response": "数据"
    }

6、已开收据状态更改

功能说明：已开收据状态更改

调用方式：POST（http）

调用地址：/api/Receipt/CancelledReceipt

请求参数：

参数 类型 说明 必填
token String 接口调用Token（令牌） 是
appKey String 场景调用唯一凭证 是
receiptNo String 收据号 是
status int 状态（4作废，5冲抵，6退款） 是
obsoleteName string 操作人 是
obsoleteDesc int 操作说明 是

返回参数：

参数 类型 说明 必填
Status int http响应状态码（默认200） 是
Success bool 操作是否成功 否
Msg String 返回信息 否
Response object 返回值 否

调用示例：

 请求示例
   {
   "token": "接口调用Token",
   "appKey": "场景调用唯一凭证",
   "receiptNo": "收据号",
   "status": 4,
   "obsoleteName": "操作人",
   "obsoleteDesc": "操作说明"
   } 
   响应示例:
    {
       "Status": 200,
       "Success": true,
       "Msg": "获取成功",
       "Response": ""
    }

7、已开收据查询列表

功能说明：已开收据查询列表

调用方式：POST（http）

调用地址：/api/Receipt/GetReceiptOpenPage

请求参数：

参数 类型 说明 必填
token String 接口调用Token（令牌） 是
appKey String 场景调用唯一凭证 是
receiptNo String 收据号 否
status int 状态（4作废，5冲抵，6退款） 否
payer string 交款单位 否
collectionFee int 主费项 否
startDate Datetime 收据开始日期 否
endDate Datetime 收据结束日期 否
operatStartDate Datetime 收据创建开始日期 否
operatEndDate Datetime 收据创建结束日期 否
page int 当前页 是
pageSize int 每页行数 是

返回参数：参考文档

参数 类型 说明 必填

调用示例：

 请求示例
   {
   "token": "接口调用Token",
   "appKey": "场景调用唯一凭证",
   "receiptNo": "收据号",
   "status": 0,
   "payer": "交款单位",
   "collectionFee": "主费项",
   "startDate": "收据开始日期",
   "endDate": "收据结束日期",
   "operatStartDate": "收据创建开始日期",
   "operatEndDate": "收据创建结束日期",
   "page": 0,
   "pageSize": 0
   }  
   响应示例:
    {
       "Status": 200,
       "Success": true,
       "Msg": "获取成功",
       "Response": "参考文档"
    }

8、发送收据邮件（手机号推送公众号消息）

功能说明：发送收据邮件（手机号推送公众号消息）

调用方式：POST（http）

调用地址：/api/Receipt/SendReceiptMail

请求参数：

参数 类型 说明 必填
token String 接口调用Token（令牌） 是
appKey String 场景调用唯一凭证 是
receiptNo String 收据号 否
Email string 邮箱 否
PhoneNumber string 手机号 否

返回参数：参考文档

参数 类型 说明 必填
Status int http响应状态码（默认200） 是
Success bool 操作是否成功 否
Msg String 返回信息 否
Response object 返回结果 否

调用示例：

 请求示例
   {
   "token": "接口调用Token",
   "appKey": "场景调用唯一凭证",
   "receiptNo": "收据号", 
   "email": "邮箱",
   "phoneNumber": "手机号"
   }  
   响应示例:
    {
       "Status": 200,
       "Success": true,
       "Msg": "获取成功",
       "Response": ""
    }

9、开具结果回调接口（接入方提供）

功能说明：开具结果回调接口，接入方提供，并在【开具发起接口】中通过字段 NotifyUrl 传入， 开具完成立即回调一次通知，因网络等原因系统将定时 2 分钟后、5 分钟后、30 分钟后、4 小时后补偿回调 4 次，回调通知成功则停止回调。

调用方式：POST（http）

调用地址：接入方提供

请求参数：

参数 类型 说明 必填
state String 00 ：开具成功 500：开具失败 是
stateMsg String 开具结果描述 是
receiptNo String 收据号 是
documentNo string 收据订单号 是
signFileUrl string 开具完成文件URL地址。可直接下载开具文件。 是

返回参数：参考文档

参数 类型 说明 必填
Status int http响应状态码（默认200） 是
Success bool 操作是否成功 是
Msg String 接口返回信息描述 否
Response String 开具结果 0：记录回调通知完成 是

调用示例：

 请求示例
   {
   "state": "00",
   "stateMsg": "开具成功",
   "receiptNo": "收据号", 
   "documentNo": "收据订单号",
   "signFileUrl": "URL地址"
   }  
   响应示例:
    {
       "Status": 200,
       "Success": true,
       "Msg": "开具成功",
       "Response": "0"
    }

豫ICP备16032979号-2  |  Copyright © ESJ.TOP, 河南恒拓信息科技有限公司, All Rights Reserved

豫公网安备 41019602002128号 豫公网安备 41019602002249号