异构系统接口定义

第1章概述

1.1 目的

本文档旨在编写一个面向开发者的完整的API调用规范，供需要对接星瀚档案的开发者使用。本文档不包括API具体的实现细节。

1.2 适用范围

本文档适用阅读人员包括：发票云的设计、开发人员，公司内部合作部门成员。本文档的接口也仅限于公司内部应用使用。

1.3 适用版本

星瀚电子会计档案（旗舰版）

第2章基础接口

2.1获取授权接口

接口请求说明：http请求方式：POST（请使用https协议）
https://${baseUrl}/api/token
请求数据结构：

返回数据结构：

参数描述：

参数	类型	是否必须	描述
client_id	String	是	用于授权验证的唯一标识clientId,

sign	String	是	签名(由clientId+ clientSecret+timestamp的值MD5加密生成)
Timestamp	long	是	时间戳

返回参数：

参数	类型	描述
accessToken	String	字符串, 最长255，用于后续访问的令牌，随机字符串
expiresTime	long
长整型，令牌在多少秒内有效，单位为秒
errcode	String	操作结果码
description	String	操作描述

第3章通用接口

3.1 归档数据清单接口

接口请求说明：http请求方式：POST（请使用https协议）
http://{baseUrl}/api/list
请求数据结构：json

入参	描述	类型	是否必须
accessToken	授权token	String	True(有token接口才为ture)
pageSize	分页查询，每页数量	Int	true
currentPage	分页查询，当前页	Int	true
organizationNo	组织唯一编号	String	true
period	归档期属，格式yyyy-mm	String	true
docType	业务类型	String	true 资料类型:默认“01”凭证“02”单据“03”总账“04”明细账“05”月报“06”季报“07”半年报“08”年报“09”固定资产“10”银行回单“11”银行存款余额调节表“12”银行存款日记账“13”现金日记账“14”银行对账单“15”税务资料“16”发票…… 业务类型集成平台可自定义，业务类型与集成内容的内容编码保持一致
bookNo	账薄编号	String	false可选；默认不传就归档到主账薄
ids	唯一id，多个用英文逗号分隔	String	false可选；默认不传就获取所有数据，传了就只获取ids对应的数据

返回结果：
错误信息：

成功信息：
返回data字段里的发票字段可参考：

doctype:01

data说明

参数	描述	字段类型	字段长度	是否必填
id	凭证id
title	凭证抬头
voucherOrgNumber	核算单位编码
voucherOrgName	核算单位名字
accountDate	过账日期
period	凭证所属期属
voucherNum	凭证号
attachNum	附件张数,非必填
voucherType	凭证类型，记，转付
currency	币种
rate	汇率
totalDebitTra	借方交易币合计
totalDebitLoc	借方本位币合计
totalCreditTra	贷方交易币合计
totalCreditLoc	贷方本位币合计
approval	会计主管，非必填
posting	记账人
review	复核人
creater	制单人，非必填
operator	经办人，非必填
cashier	出纳，非必填
auditing	审核人
accounter	过账人
scanBillNo	影像编号

Item凭证分录字段说明

字段	说明
accountcode	会计科目代码
accountname	会计科目名称
desc	凭证摘要
costcenter	成本中心
dr	借方金额
cr	贷方金额

file文件属性说明

字段	说明
fileName	文件名（用于存储）
isMainFile	是否是主文件，0主文件1关联附件
srcName	源文件名（用于展示）
download	文件下载地址

uppervoucherList上游凭证列表属性说明

字段	说明
voucherId	凭证id（唯一）
voucherNum	凭证号
voucherType	凭证类型

billList关联单据属性说明

字段	说明
billId	单据id（唯一）
billNo	单据编号
billName	单据类型

bankList关联银行回单属性说明

字段	说明
bankId	回单id（唯一）
tradeId	交易流水id

invoiceList关联发票属性说明**(见发票识别返回结果)**

字段	说明
invoiceCode	发票代码
invoiceNo	发票号码
serialNo	发票流水号
downloadUrl	发票下载地址

doctype:02-*

doctype:03

doctype:04

doctype:05,06,07,08

doctype:09

doctype:10

doctype:11

doctype:12

doctype:13

doctype:14

doctype:15

doctype:16

注：data字段里标注颜色部分的发票字段需参考以下发票识别返回结果体

1、增值税专票、普票、卷票返回数据结构：Json

2、机动车发票返回结构：Json

3、二手车发票返回结构：Json

4、通行费发票返回结构：Json

5、识别的士票返回结构

6、识别火车票返回结构

7、识别飞机票返回结构

8、识别通用机打票返回结构

9、识别定额票返回结构

10、识别客运票返回结构

11、识别过路过桥票返回结构

12、识别其他票返回结构

失败返回结构体：

3.2档案文件下载接口（若3.1提供了文件下载地址，则不需要此接口）

接口请求说明：http请求方式：POST（请使用https协议）
http://{baseUrl}/api/file/download
请求数据结构：json

入参	描述	类型	是否必须
accessToken	授权token	String	true
organizationNo	组织唯一编号	String	true
fileName	要下载文件名,与清单接口返回的结构化数据file里面的fileName保持一致	String	true
isMainFile	是否是主文件	Int	true
period	归档期属，格式yyyy-mm	String	true
docType	业务类型，参考异构业务数据字典	String	true 资料类型:默认“01”凭证“02”单据…… 集成平台可自定义
bookNo	账薄	String	false可选；默认不传就归档到主账薄

第1章 概述#

1.1 目的#

1.2 适用范围#

1.3 适用版本#

第2章 基础接口#

2.1获取授权接口#

第3章 通用接口#

3.1 归档数据清单接口#

doctype:01#

doctype:02-*#

doctype:03#

doctype:04#

doctype:05,06,07,08#

doctype:09#

doctype:10#

doctype:11#

doctype:12#

doctype:13#

doctype:14#

doctype:15#

doctype:16#

3.2档案文件下载接口（若3.1提供了文件下载地址，则不需要此接口）#