财政票据电子化系统第三方接口文档
2014年06月
第1页
财政票据电子化系统第三方接口文档
1. 编写目的
1. 编写过程是一个模拟开发的思考过程,通过这种思考,经验丰富的程序员可以把大部分的问题
都能挖掘出来.
2. 使开发与测试可以有共同的标准。开发人员可以按着详细设计文档写代码,与此同时,测试人
员可以根据详细设计文档写测试用例,从提高项目的质量.
2. 背景
财政实行大集中式电子化票据管理,部分单位已使用第三方业务系统,为了避免用户多次录入,便于统一管理维护,提供接口模式对接第三方业务系统数据.
3. 主要业务对接流程
3.1 电脑开票流程
第三方业务系统票据接口票据电子化系统1 : 待开票信息InvoiceBill()2 : 开票并打印()3 : 返回开票信息()4 : 返回信息()
3.2 直缴缴款书流程
缴款书开票
第2页
财政票据电子化系统第三方接口文档
第三方业务系统IvcPayLetterBill票据接口票据电子化系统待缴款项目转入待缴款项目开具缴款书接收缴款书信息返回缴款书信息并打印
由第三方业务系统发起 “直缴缴款书转入开票”请求传入待缴款项目等信息,开具缴款书。
银联POS刷卡缴款确认
第三方业务系统票据接口银联POS票据电子化系统PosPayLetterBill()待缴款信息POS刷卡缴款确认银联缴款接收失败提示信息返回失败信息缴款失败缴款成功重新缴款发送待缴款信息查询缴款情况PosQueryPayLetter()POS机缴款确认查询缴款确认查询接收缴款确认失败信息返回缴款确认失败信息缴款确认失败缴款确认成功缴款书缴款确认不再使用POS刷卡缴款接收开票信息返回开票信息并打印票据开具电脑票
第3页
财政票据电子化系统第三方接口文档
第三方业务系统发起 “POS机刷卡缴款确认” 请求传入待缴款信息进行缴款确认。 1. 缴款确认成功则开具对应的电脑票并返回电脑票相关信息。
2. 缴款确认失败则必须发送 “POS机缴款确认查询”请求传入待缴款信息对当前缴款书的缴款情况
做确认。
缴款失败情况简要说明: 1. 正常的交易失败 2. POS机设备连接脱落
3. 网络连接、电话拨号等信号不正常
4. 系统设计
4.1 接口规范
1、如果是C/S架构,则调用接口DLL:TotalInterface.dll中的接口方法。 2、如果是B/S架构,则调用组件OCX:BillActiveFormProj.ocx中的接口方法。
OCX通过安装包自动注册在系统注册表中,键值为[7CDB6D1E-CD4A-47B4-BFD0-310B66089007] 通过键值获取OCX对象调用接口方法
TotalInterface.dll和BillActiveFormProj.ocx都包含在应用环境包中。
4.1.1 接口方法详述
接口名称: InterfaceMethod 描述:所有的接口都是通过该方法进行调用 DLL方法声明: Function InterfaceMethod(aXml, resXml : PChar) : PChar; OCX方法声明: Function InterMethod(const Xml: WideString): WideString; safecall; 参数: 参数名 aXml resXml PChar PChar 类型 说明 根据要调用的具体方法,需传入相应的方法参数 根据调用传入方法参数,执行相应的方法,返回与之方法名相应的返回参数(XML格式) 参数说明:
1.调用DLL 传入参数和返回参数的类型是PChar
2.通过调用OCX 传入的参数和返回的参数类型是 string (IE 不支持PChar) 3.传入参数和返回参数的格式均采用xml的节点格式,但不包含xml头信息
4.1.1.1. 主要参数格式说明
第4页 财政票据电子化系统第三方接口文档
节点 webbill name ivcnode nodeuser userpwd key version Systype params param1、param2 …… 通用参数说明:
单位开票点用户编码,用户密码等信息双方保持一致。
单位开票点编码默认为001;多开票点情况根据财政票据系统实际使用情况配置。
根结点 方法名称(如:InvoiceBill、InvalidBill、GetBillType等),该项是变动的 开票点编码(根据票据系统) 单位开票点用户编码(根据票据系统) 单位开票点用户密码(根据票据系统) 单位校验KEY(根据票据系统) 版本号(默认:1.0.0.1) 系统类型(默认:1) 方法的参数集合 方法的参数是根据节点name的方法名称来决定的, 该项是变动的 说明 第5页
财政票据电子化系统第三方接口文档
4.1.2 接口业务方法详述 4.1.2.1. 电脑开票
说明:根据票据预设的格式,转入开票信息,并可进行打印票据信息
电脑开票参数示例
传入参数格式
主要节点说明: 节点名 name version param1 类型 string string string 参数内容 方法名(值为InvoiceBill) 该方法(值1.0.0.1) 票据信息数据 ➢ “票据信息数据”说明,通用格式如下: 财政票据电子化系统第三方接口文档
财政票据电子化系统第三方接口文档
chargecode string bill-> chargeitems->charge->chrgcode 收费项目编码(即医疗票据的大类) cnt standard number bill-> chargeitems->charge-> cnt 数量(最多保留两位小数) number bill-> standard chargeitems->charge-> 收费标准(最多保留六位小数) amt other1 …… otherx number bill-> chargeitems->charge-> amt 金额(格式:0.00 保留两位小数位) string bill-> chargeitems->charge->otherx 节点的 other1”、“other2”等为可选节点,节点的名称也可以随意命名,节点个数可以在20个以内,具体内容以“5附件”为准 param2 param3 Param4 string string string 是否打印(0否,1是) 票据类型(根据票据系统) 备注(可为空)
返回结果
说明:
数字指纹:用于票据信息真伪的验证。
4.1.2.2. 作废已开具的票据
说明:将原本开过的票据信息,进行作废操作。一次仅只作废一张票据号
第8页
财政票据电子化系统第三方接口文档
传入参数格式
说明:
返回结果
说明:
4.1.2.3. 取所有机打票据类型
说明: 用票单位有多种票据类型,通过此函数可以读取出此单位的所有票据类型
传入参数格式
第9页 财政票据电子化系统第三方接口文档
返回结果
说明:
说明:作废一张当前默认的机打票据类型的票据号
传入参数格式
第10页 财政票据电子化系统第三方接口文档
返回结果
说明:
4.1.2.5. 取发放票据记录
说明:提供上级单位向本单位发放票据的详细数据(未被使用过的),使业务系统不必二次录入,接口只提供数据没办法判断是否已经取过了
转入参数格式
第11页
财政票据电子化系统第三方接口文档
返回结果
说明:
4.1.2.6. 取第一张电脑票票号
说明:根据预设的票据类型,读取当前第一张可用的票据号
传入参数格式
第12页 财政票据电子化系统第三方接口文档
说明:
4.1.2.7. 打印一张电脑票据
说明:打印一张指定的电脑票据
传入参数格式
第13页 财政票据电子化系统第三方接口文档
说明:
4.1.2.8. 电脑票POS刷卡缴款确认
说明:根据参数中的信息对对应的电脑票据进行POS刷卡缴款确认
传入参数格式 第14页 财政票据电子化系统第三方接口文档
返回结果
4.1.2.9. 电脑票POS刷卡缴款确认查询
说明:根据参数中的信息查询对应的电脑票据POS刷卡的缴款情况
传入参数格式 第15页 财政票据电子化系统第三方接口文档
返回结果
4.1.2.10. 读取第一张缴款书票据号
说明:读取当前第一张可用的缴款书票据号
传入参数格式
第16页 财政票据电子化系统第三方接口文档
说明:
4.1.2.11. 直缴缴款书转入
说明:根据票据预设的需求格式,转入缴款信息,并可进行打印票据信息直缴缴款书转入参数示例
传入参数格式
第17页 财政票据电子化系统第三方接口文档 财政票据电子化系统第三方接口文档
返回结果 第19页 财政票据电子化系统第三方接口文档
说明:
4.1.2.12. 作废一张缴款书票据
说明:作废一张开过的缴款书票据
传入参数格式
第20页 财政票据电子化系统第三方接口文档
说明:
4.1.2.13. 打印一张缴款书票据
说明:打印一张开过的缴款书票据
传入参数格式
第21页 财政票据电子化系统第三方接口文档
说明:
4.1.2.14. 缴款书POS机刷卡缴款确认
说明:根据参数中的信息对对应的缴款书进行POS刷卡缴款并开具电脑票据
传入参数格式
第22页 财政票据电子化系统第三方接口文档
说明: 说明: 4.1.2.15. 缴款书POS机缴款确认查询 说明:根据参数中的信息查询对应的缴款书POS刷卡的缴款情况,成功则缴款确认并开具电脑票据 传入参数格式 第23页 财政票据电子化系统第三方接口文档 说明: 说明: 4.2 与第三方业务系统对接的数据项说明 由于双方系统的数据不一致,因此在对接时需要规范数据格式、统一数据来源 第24页 财政票据电子化系统第三方接口文档 1.单位开票点用户编码,用户密码等信息双方保持一致。 2.单位开票点编码默认为001;多开票点情况根据财政票据系统实际使用情况配置。 3.单位校验KEY,由财政票据系统提供 4.票据、票别号等根据财政票据系统实际情况而变化 5.收费项目需要在财政票据系统中做数据对照设置 5. 附件 5.1 电脑开票参数示例 <缴款人>李四缴款人> <业务流水号>000000001业务流水号> <性别>男性别> 第25页 财政票据电子化系统第三方接口文档 5.2 直缴缴款书转入参数示例 第26页 财政票据电子化系统第三方接口文档 第27页 因篇幅问题不能全部显示,请点此查看更多更全内容