财政票据电子化系统.docx
《财政票据电子化系统.docx》由会员分享,可在线阅读,更多相关《财政票据电子化系统.docx(33页珍藏版)》请在冰豆网上搜索。
财政票据电子化系统
财政票据电子化系统
第三方接口文档
2014年06月
1.编写目的
1.编写过程是一个模拟开发的思考过程,通过这种思考,经验丰富的程序员可以把大部分的问题都能挖掘出来.
2.使开发与测试可以有共同的标准。
开发人员可以按着详细设计文档写代码,与此同时,测试人员可以根据详细设计文档写测试用例,从提高项目的质量.
2.背景
财政实行大集中式电子化票据管理,部分单位已使用第三方业务系统,为了避免用户多次录入,便于统一管理维护,提供接口模式对接第三方业务系统数据.
3.主要业务对接流程
3.1电脑开票流程
3.2直缴缴款书流程
缴款书开票
由第三方业务系统发起“直缴缴款书转入开票”请求传入待缴款项目等信息,开具缴款书。
银联POS刷卡缴款确认
第三方业务系统发起“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方法声明:
FunctionInterfaceMethod(aXml,resXml:
PChar):
PChar;
OCX方法声明:
FunctionInterMethod(constXml:
WideString):
WideString;safecall;
参数:
参数名
类型
说明
aXml
PChar
根据要调用的具体方法,需传入相应的方法参数
resXml
PChar
根据调用传入方法参数,执行相应的方法,返回与之方法名相应的返回参数(XML格式)
参数说明:
1.调用DLL传入参数和返回参数的类型是PChar
2.通过调用OCX传入的参数和返回的参数类型是string(IE不支持PChar)
3.传入参数和返回参数的格式均采用xml的节点格式,但不包含xml头信息
4.1.1.1.主要参数格式说明
方法名称
单位开票点编码
单位开票点用户编码
用户密码
单位校验KEY
接口版本
系统类型
参数1
参数2
.....
节点
说明
webbill
根结点
name
方法名称(如:
InvoiceBill、InvalidBill、GetBillType等),该项是变动的
ivcnode
开票点编码(根据票据系统)
nodeuser
单位开票点用户编码(根据票据系统)
userpwd
单位开票点用户密码(根据票据系统)
key
单位校验KEY(根据票据系统)
version
版本号(默认:
1.0.0.1)
Systype
系统类型(默认:
1)
params
方法的参数集合
param1、param2
……
方法的参数是根据节点name的方法名称来决定的,该项是变动的
通用参数说明:
单位开票点用户编码,用户密码等信息双方保持一致。
单位开票点编码默认为001;多开票点情况根据财政票据系统实际使用情况配置。
4.1.2接口业务方法详述
4.1.2.1.电脑开票
说明:
根据票据预设的格式,转入开票信息,并可进行打印票据信息
电脑开票参数示例
传入参数格式
InvoiceBill
单位开票点编码
单位开票点用户编码
用户密码
单位校验KEY
接口版本
系统类型
票据信息数据
是否打印
票据类型
备注
主要节点说明:
节点名
类型
参数内容
name
string
方法名(值为InvoiceBill)
version
string
该方法(值1.0.0.1)
param1
string
票据信息数据
Ø“票据信息数据”说明,通用格式如下:
<缴款人>缴款人缴款人>
<其它1>其它1其它1>
<其它2>其它2其它2>
<其它3>其它3其它3>
……
<其它x>其它4其它x>
收费项目编码
数量
单价
金额
其它1
其它2
……
其它6
收费项目编码
数量
单价
金额
其它1
其它2
……
其它x
票据信息数据节点说明
节点
数据类型
XML目录位置
说明
bill
bill
票据信息
head
bill->head
票据信息的头信息
缴款人
string
bill->head->缴款人
票据的缴款人信息,信息节点为固定节点
其它1
string
bill->head->其它x
节点的“其它1”、“其它2”等为可选节点,节点的名称也可以随意命名,节点个数可以在20个以内,具体内容以“5附件”为准
其它2
……
其它x
chargeitems
bill->chargeitems
收费项目集合
charge
string
bill->chargeitems->charge
收费项目
chargecode
string
bill->chargeitems->charge->chrgcode
收费项目编码(即医疗票据的大类)
cnt
number
bill->chargeitems->charge->cnt
数量(最多保留两位小数)
standard
number
bill->chargeitems->charge->standard
收费标准(最多保留六位小数)
amt
number
bill->chargeitems->charge->amt
金额(格式:
0.00保留两位小数位)
other1
……
otherx
string
bill->chargeitems->charge->otherx
节点的
other1”、“other2”等为可选节点,节点的名称也可以随意命名,节点个数可以在20个以内,具体内容以“5附件”为准
param2
string
是否打印(0否,1是)
param3
string
票据类型(根据票据系统)
Param4
string
备注(可为空)
返回结果
结果状态
失败信息
票据号
票据类型
票别号
金额
数字指纹
说明:
表示返回结果(0为失败,1为成功)
数字指纹:
用于票据信息真伪的验证。
4.1.2.2.作废已开具的票据
说明:
将原本开过的票据信息,进行作废操作。
一次仅只作废一张票据号
传入参数格式
InvalidBill
单位开票点编码
单位开票点用户编码
用户密码
单位校验KEY
接口版本
系统类型
票据号
票据类型
票别号
作废权限控制
说明:
作废权限控制(0为系统默认权限,1为跨单位,2为跨用户)
返回结果
结果状态
失败信息
票据号
票据类型
票别号
说明:
表示返回结果(0为失败,1为成功)
4.1.2.3.取所有机打票据类型
说明:
用票单位有多种票据类型,通过此函数可以读取出此单位的所有票据类型
传入参数格式
GetBillType
单位开票点编码
单位开票点用户编码
用户密码
单位校验KEY
接口版本
系统类型
返回结果
结果状态
失败信息
票据类型
票据名称
票别号1
票别号2
……
票别号X
……
说明:
表示返回结果(0为失败,1为成功)
可允许有多个,可允许有多个
4.1.2.4.作废一张空白票据号
说明:
作废一张当前默认的机打票据类型的票据号
传入参数格式
InvalidBillNo
单位开票点编码
单位开票点用户编码
用户密码
单位校验key
接口版本
系统类型
未使用的票据号
票据类型
票别号
返回结果
结果状态
失败信息
票据号
票据类型
票别号
说明:
表示返回结果(0为失败,1为成功)
4.1.2.5.取发放票据记录
说明:
提供上级单位向本单位发放票据的详细数据(未被使用过的),使业务系统不必二次录入,接口只提供数据没办法判断是否已经取过了
转入参数格式
GetStockOut
单位开票点编码
单位开票点用户编码
用户密码
单位校验key
接口版本
系统类型
返回结果
结果状态
失败信息
1
起始号
终止号
票据类型
票别号
说明:
表示返回结果(0为失败,1为成功)
表示票段数
4.1.2.6.取第一张电脑票票号
说明:
根据预设的票据类型,读取当前第一张可用的票据号
传入参数格式
GetCurBillNo
单位开票点编码
单位开票点用户编码
用户密码
单位校验key
接口版本
系统类型
票据类型
返回结果
结果状态
失败信息
1
票据号
说明:
表示返回结果(0为失败,1为成功)
4.1.2.7.打印一张电脑票据
说明:
打印一张指定的电脑票据
传入参数格式
PrintBill
单位开票点编码
单位开票点用户编码
用户密码
单位校验key
接口版本
系统类型
票据号
票据类型
票别号
返回结果
结果状态
失败信息
成功信息
说明:
表示返回结果(0为失败,1为成功)
4.1.2.8.电脑票POS刷卡缴款确认
说明:
根据参数中的信息对对应的电脑票据进行POS刷卡缴款确认
传入参数格式
PosPayComputerInv
单位开票点编码
单位开票点用户编码
用户密码
单位校验KEY
接口版本
系统类型
票据号
票据类型
票别号
金额
返回结果
结果状态
失败信息
开票票据号
开票票据类型
票别号
交易参考号
凭证号
说明:
表示返回结果(0为失败,1为成功)
4.1.2.9.电脑票POS刷卡缴款确认查询
说明:
根据参数中的信息查询对应的电脑票据POS刷卡的缴款情况
传入参数格式
PosQueryComputerInv
单位开票点编码
单位开票点用户编码
用户密码
单位校验KEY
接口版本
系统类型
票据号
票据类型
票别号
金额
返回结果
结果状态
失败信息
开票票据号
开票票据类型
票别号
交易参考号
凭证号
说明:
表示返回结果(0为失败,1为成功)
4.1.2.10.读取第一张缴款书票据号
说明:
读取当前第一张可用的缴款书票据号
传入参数格式
GetCurPayLetterNo
单位开票点编码
单位开票点用户编码
用户密码
单位校验key
接口版本
系统类型
票据类型
返回结果
结果状态
失败信息
票据号
说明:
表示返回结果(0为失败,1为成功)
4.1.2.11.直缴缴款书转入
说明:
根据票据预设的需求格式,转入缴款信息,并可进行打印票据信息
直缴缴款书转入参数示例
传入参数格式
IvcPayLetterBill
单位开票点编码
单位开票点用户编码
用户密码
单位校验key
接口版本
系统类型
票据信息数据
是否打印
票据类型
缴款类型(01:
国库02:
专户)
备注
节点名
类型
参数内容
param1
string
票据信息数据
Ø“票据信息数据”说明,通用格式如下:
缴款人名称
缴款账号