财政电子票据公共服务接口规范.docx
- 文档编号:299607
- 上传时间:2022-10-08
- 格式:DOCX
- 页数:14
- 大小:30.95KB
财政电子票据公共服务接口规范.docx
《财政电子票据公共服务接口规范.docx》由会员分享,可在线阅读,更多相关《财政电子票据公共服务接口规范.docx(14页珍藏版)》请在冰豆网上搜索。
财政电子票据公共服务接口规范
财政电子票据公共服务接口规范
1适用范围
本规范规定了财政电子票据公共服务接口,为财政电子票据服务平台和外部系统间在交互财政电子票据相关电子信息时的接口技术规范,实现财政电子票据的下载和入账反馈。
2技术规范
2.1处理流程
使用公共服务接口时,基于HTTPS协议,采用PoST方式“请求-响应”模式进行交互。
电子票据服务平台
请求方系统I
I
I
IL11.1:
构造请求数据
1.2:
请求方发送请求
.2.2:
电子票据服务平台返回响应结果
∣j.I3:
请求方接收数据
I
I
(1)请求方发送请求
请求方系统由财政电子票据服务平台分配一个身份标识app_id,每个app_id配有一个秘钥(appKey)o请求方根据接口要求,构造请求参数并使用密钥(appKey)对请求参数进行签名。
(2)电子票据服务平台返回响应结果
电子票据服务平台通过验证请求参数的签名来验证请求方身份合法性及数据完整性,无误后进行处理。
a)处理成功时,根据请求服务不同,响应结果分为两种情况:
电子票据下载时,返回电子票据文件压缩包;电子票据入账时,返回JSoN格式的参数。
b)处理失败时,响应结果为JSON格式的参数。
(3)请求方接收数据
请求方收到响应结果后,首先判断电子票据服务平台响应是否成功:
电子票据下载时,通过HTTPContent-Type判断是否成功;电子票据入账时,通过返回码判断是否成功。
2.2数据类型
序
号
类型
类型名称
说明
1
String
字符串
标准XML字符串类型(xs:
String)。
长度分为定长和变长两种,例如:
长度"8”表示字符串长度固定为8,长度“[1,100]”表示字符串长度在1到100之间
2
NString
数字串
表示由数字0-9组成的字符串,如:
3
Integer
整数
标准XML整数类型(xs:
integer)
4
DeCimal
实数
标准XML实数类型(Xsrdecimal)
5
Base64Binary
Base64编码
字符串
标准XMLBase64编码字符串类型(xs:
base64Binary)
6
Date
日期
表示日期,格式为yyyy≡dd(年月曰),长度为8位,如:
7
Time
时间
表示时间,格式为HH:
mm:
ss(时分秒)•长度为8位,如:
09:
29:
53
8
DateTime
日期时间
表示日期时间,格式为yyyyMMddHH:
JnlT1:
SS(年月日时分秒),长
度为17位,如:
09:
29:
53
9
UTCDateTinle
UTC日期时间
表示UTC日期时间,格式为ddMMMyyyyHH:
mm:
SSz(日月年时
分秒时区),长度为24位,如:
13JUn201609:
29:
53GMT
10
CUrrenCy
金额
表示金额,单位为元,整数部分最长15位,小数部分固定两位,
不能包含逗号等分隔符,如:
12345.67
2.3参数说明
序号
标识符
数据项名称
类型
长度
说明
强制
1
method
String
接口服务名称
是
2
app„id
String
应用帐号
是
3
SeCUrity
安全码
String
请求串的防伪码。
是
4
format
String
定义请求参数message和接口返回的数据格式。
取值说明:
json
是
5
datetime
DateTijne
时间,格式为
YyyyMMddHHmmssSSS
是
6
VerSiOn
版本
NString
5
接口版本,默认版本1.0.1
是
7
messageid
请求编号
String
[1,50]
每次请求生成一个唯一请求编号
是
8
message
请求业务参数
String
请求业务参数,参见具体接口描述。
需转换为Base64编码。
说明:
(1)参数名必须为小写字母;
(2)业务参数message的构成,根据具体接口描述构造;
(3)字符集统一釆用UTF-8编码格式。
3接口列表
接口服务名称
描述
downloadPNG4ΛccountByDate
电子票据下载
accoUntForRecode
电子票据入账反馈
4接口描述
单位通过该接口下载待入账电子票据。
4.1.1服务名downloadPNG4AccountByDate4.1.2业务参数
节点:
message
序号
标识符
数据项名称
类型
长度
说明
强制
1
agencycode
单位代码
String
[1,30]
一般采用组织机构代码
是
2
agency_name
单位名称
String
[1,100]
是
3
agency_type
单位类型
NString
1
1:
开票单位
2:
交款单位
是
4
billbatchCOde
电子票据代码
NString
8
否
5
enddate
开票终止日期
Date
否
6
batchno
批次序列号
NString
13
上次下载时返回的最大的序列号;初始值为0
是
4.1.3返回参数
根据HTTP响应头中COntent-TyPe值判断成功或失败。
成功时值为appliCatiOn∕χ-ziP-COmPreSSed,失败时值为appIiCation/jSOno
(1)成功返回电子票据文件压缩包,命名规则为:
包内电子票据份数-最大批次序列号.ZipO电子票据压缩包文件名提取方式:
HTTPHeaderCOntent-CliSPOSitiOn,值为"attachment;filename=包内电子票据份数-最大批次序列号.zip"。
压缩包内包含电子票据文件和清单文件,毎批最大份数100。
电子票据文件命名规则为:
电子票据代码-电子票据号码.后缀名(后缀名为Png)。
清单文件是JSON格式的文本文件,命名规则为:
最大批次序列号.Jsono
清单文件内容如下:
序号
标识符
数据项名称
类型
长度
说明
强制
1
Data
电子票据清单
3以
String
[1,4096]
JSON格式
是
Data包含一系列电子票据,每份电子票据的数据项目:
序号
标识符
数据项名称
类型
长度
说明
强制
1
EInVOiCeCOde
票据代码
NString
8
是
2
EInVOiCeNUmber
票据号码
NString
10
是
3
EInVOiCeName
电子票据名称
String
[1,100]
是
4
InVOiCingPartyName
开票单位名称
String
[1,100]
是
5
ISSUeDate
开票日期
Date
是
6
TOtaI∕∖mount
总金额
CUrrenCy
是
7
HandlingPerson
开票人
String
[1,20]
是
8
PayerPartyName
交款人名称
String
[1,100]
是
9
ItenI
项目明细
-ItemCOde
项目编码
String
[1,30]
是
-ItemName
项目名称
String
[1,100]
是
-ItemQUantity
数量
Integer
否
I-Itemllnit
单位
String
[1,30]
否
-ItenIAmOUnt
金额
CUrrenCy
是
-ItenIEXt
项目明细扩展
节点
否
10
ReIatedEInVOiCe
相关电子票据
-ReIatedEInVOiCeCOde
相关电子票据代码
NString
8
红字电子票据非空
否
-ReIatedEInVOiCeNUmber
相关电子票据号码
NString
10
红字电子票据非空
否
11
MainEXt
基本信息扩展
节点
否
12
EInVOiCeFHeNumber
电子票据份数
NString
[1.3]
固定值1
是
13
ElnVOiCeFile
电子票据文件名
String
[1,100]
PNG文件名称
是
(2)失败返回参数:
节点:
error_message
序号
标识符
数据项名称
类型
长度
说明
强制
1
error_COde
返回码
NString
3
失败的返回代码
是
2
errormsg
返回消息
NString
[1.200]
错误信息
是
4.2电子票据入账反馈
单位入账后,通过该接口将财政电子票据入账凭证号反馈财政电子票据服务
平台。
4.2.1
服务名accountForRecode
4.2.2
业务参数
节点:
message
序号
标识符
数据项名称
类型
长度
说明
强制
1
agency-code
单位代码
String
[1,30]
一般采用组织机构代码
是
2
agency-name
单位名称
String
[1,100]
是
3
agency-typθ
单位类型
NString
1
1:
开票单位
2:
交款单位
是
4
billbatchCOde
电子票据代码
NString
8
是
5
billno
电子票据号码
NString
10
是
6
accnumber
入账凭证号
String
账务系统生成的记账凭证号
是
7
accamount
入账金额
CUrrenCy
是
4.23返回参数
(1)成功返回参数
节点:
message
序号
标识符
数据项名称
类型
长度
说明
强制
1
succCOde
返回码
NString
3
成功的返回代码:
5
200
2
SUCCmsg
返回消息
NString
[1.200]
是
(2)失败返回参数:
节点:
err0rJneSSage
序号
标识符
数据项名称
类型
长度
说明
强制
1
error-code
返回码
NString
3
失败的返回代码
是
2
errorInSg
返回消息
NString
Eh200]
错误信息
是
5调用步骤说明
以HccountForRecode调用为例,具体步骤如下:
5.1设置参数值
请求参数(示例):
method=UaccountForRecodeM,
appid-M7e7f4ec1a5c2cce38a4219b
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 财政 电子 票据 公共 服务 接口 规范
![提示](https://static.bdocx.com/images/bang_tan.gif)