发票云(旗舰版)API文档
旗舰版标准版智能特性
旗舰版标准版智能特性
🤖 AI Support​​
  1. 档案
  • 整体介绍
  • 快速开始
  • 加解密
  • 文件预览&文件上传&文件下载
  • 发票数据结构
  • 错误码
  • 常见接口错误
  • 场景指引
    • 概述
    • 直接开票
    • 单据开票
    • 扫码开票
  • 授权
    • 1.01.获取app_token
      POST
    • 1.02获取access_token
      POST
  • 开票
    • 单据开票接口（税控+数电）
      • 单据开票对接指引
      • 开票申请单错误码列表
      • 1.1.01 开票申请单生成及开票（支持拆分合并后，再开票）
      • 1.1.02 开票申请单撤回（对接方主动撤回）
      • 1.1.03 开票申请单发票查询
      • 1.1.04 开票申请单快速红冲（仅支持税控普票）
      • 1.1.05 开票申请单批量作废（作废单据的发票，仅支持税控纸票）
      • 1.1.06 开票申请单红冲单或作废单生成（星瀚发票云版本5.0.015支持，不支持数电票）
      • 1.1.07 开票申请单重开单生成（星瀚发票云版本5.0.015支持，不支持数电票）
      • 1.1.08 创建负数单匹配任务
      • 1.1.09 查询负数单匹配任务结果
      • 1.1.10 单据开票预览
    • 直接开票接口
      • 数电开票
        • 接入指引（必看）
        • 返回编码说明
        • FAQ
        • 电子税局操作
          • 2.1.30 电子税局登录检测
        • 2.1.01 数电票蓝字发票开具
        • 2.1.02 数电票回调
        • 2.1.03 红字确认单生成
        • 2.1.04 数电票红冲（直接红冲或通过红字确认单）
        • 2.1.05 授信额度查询
        • 2.1.08 红字确认单撤销
        • 2.1.09 红字确认单确认或拒绝
        • 2.1.12 红字确认单下载
        • 2.1.13 红字确认单编号查询
        • 2.1.14 发票用途状态查询（发票云版本6.0.11支持，暂只支持乐企）
      • 税控开票
        • 2.2.01税控开票（直接开票，不支持拆分合并）
        • 2.2.02税控发票快速红冲（仅支持全额红冲）
        • 2.2.03税控发票作废
        • 2.2.04税控红字信息表申请
        • 2.2.05税控红字信息表下载
        • 2.2.06税控发票库存查询
        • 2.2.07税控开票设备查询
        • 2.2.08税控发票打印发票打印（需安装套打打印组件，仅适用于局域网内的HTTP调用方式）
        • 2.2.09税控发票打印（仅适用于组件开票，托管无法使用）
        • 2.2.10邮件短信重发（数电票和税控发票都支持）
        • 2.2.11税控机动车发票开具
        • 2.2.12税控机动车发票作废
        • 2.2.13税控机动车发票红冲
        • 2.2.14税控机动车发票打印
        • 2.2.15机动车信息查询（数电专用）
    • 发票查询接口
      • 4.1.01已开发票查询
      • 4.1.02机动车发票查询（税控）
      • 4.1.03.数电票发票批量查询
      • 4.1.04.数电票发票单张查询
    • 回调接口（支持除数电票直接开票接口外的开票回调）
      • 5.1.01开票申请单回退接口（星瀚发起退回开票申请单）
      • 5.1.02回调接口-按票回调(一次回调一张发票信息)
      • 5.1.03回调接口-按单回调（单据对应的所有发票开票完毕后一起回调（包含开票成功和开票失败），不支持合并又拆分的场景）
    • 开票风控接口
      • 6.0.01 风控解除接口（星瀚发票云版本6.0.6支持）
    • 扫码开票接口（税控+数电）
      • 业务系统生成二维码链接模式
        • 3.1.01业务系统组装二维码链接格式
        • 3.1.02查询订单接口(由客户提供)
        • 3.1.03 扫码提交购方抬头规则
        • 3.1.04账单中心开票小程序短链接生成
      • 推单星瀚生成二维码链接模式
        • 3.2.01上传销售单获取二维码链接
  • 收票
    • 全票池引入
      • 5.01全票池导入
    • 收票报销
      • 发票助手对接流程
      • 3.01 打开发票采集页面获取eventCode
      • 3.02 查看发票获取eventCode
      • 3.03 保存单据
      • 3.04 删除单据
      • 3.05 保存凭证
      • 3.06 删除凭证
      • 3.07 长轮询获取发票信息
      • 3.08 发票验重
    • 查询全票池的发票
      • 1.01 发票查询
      • 1.02 发票查询（按流水号查询）
      • 1.03获取单据文件信息
      • 1.04 删除全票池发票
    • 税局下载发票和勾选认证
      • 4.01 税局登录
      • 4.02 进项发票表头归集
      • 4.03 进项发票表头归集结果查询
      • 4.04 获取税款所属期信息
      • 4.05 发票勾选&撤销勾选
      • 4.06 发票勾选结果查询
      • 4.07 当前统计查询
      • 4.08 生成&撤销统计表
      • 4.09 生成&撤销统计表结果查询
      • 4.10 确认统计表
      • 4.11 确认统计表结果查询
      • 4.12 变更税款所属期
      • 4.13 发票预勾选
      • 4.14 发票预勾选确认
      • 4.15 预勾选确认结果查询
      • 4.16 批量创建税局入账申请任务
      • 4.17 查询税局入账申请任务结果
    • 识别查验
      • 2.01 发票查验
      • 2.02 发票识别查验
      • 2.03 文件上传
      • 2.04 发票编辑
    • 微服务接口
  • 页面类
    • 基础设置页面
      • 基础设置相关页面
    • 开票页面
      • 开票相关页面
    • 收票页面
      • PC端打开选择发票页面
      • PC端打开查看发票页面
      • 移动端打开查看发票页面
      • 移动端打开选择发票页面
    • 数据统计页面
      • 销项发票统计页面
    • 2.1、退出登录API接口
  • 影像
    • 开发指南
    • 1.基础接口
      • 1.01获取eventCode
      • 1.02接收ERP单据推送接口
    • 2.影像页面
      • 2.01PC端影像调阅
      • 2.02移动端影像调阅
      • 2.03影像采集页面
      • 2.04影像匹配结果页面
    • 3.影像操作
      • 3.01影像退扫
      • 3.02影像取消退扫
      • 3.03影像删除
      • 3.04获取PC端影像调阅页面地址
      • 3.05获取移动端影像调阅页面地址
      • 3.06影像状态查询
    • 4.采集接口
      • 4.01影像文件采集
      • 4.02影像单据提交
  • 档案
    • 对接说明（电子档案云旗舰版）
    • 异构系统接口定义
  • 设置类
    • 3.1、切换组织
    • 3.2、新增组织（星空ERP专用）
    • 3.3、新增租户组织下的员工
    • 3.4、查询电子税局账号
  • 订单
    • 1.01 产品订阅（平台服务商专用）
    • 发票云创建组织
  1. 档案

异构系统接口定义

第1章 概述#

1.1 目的#

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

1.2 适用范围#

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

1.3 适用版本#

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

第2章 基础接口#

2.1获取授权接口#

接口请求说明：http请求方式：POST（请使用https协议）
https://${baseUrl}/api/token
请求数据结构：
返回数据结构：
参数描述：
参数类型是否必须描述
client_idString是用于授权验证的唯一标识clientId,
signString是签名(由clientId+ clientSecret+timestamp的值MD5加密生成)
Timestamplong是时间戳
返回参数：
参数类型描述
accessTokenString字符串, 最长255，用于后续访问的令牌，随机字符串
expiresTimelong
长整型，令牌在多少秒内有效，单位为秒
errcodeString操作结果码
descriptionString操作描述

第3章 通用接口#

3.1 归档数据清单接口#

接口请求说明：http请求方式：POST（请使用https协议）
http://{baseUrl}/api/list
请求数据结构：json
入参描述类型是否必须
accessToken授权tokenStringTrue(有token接口才为ture)
pageSize分页查询，每页数量Inttrue
currentPage分页查询，当前页Inttrue
organizationNo组织唯一编号Stringtrue
period归档期属，格式yyyy-mmStringtrue
docType业务类型Stringtrue 资料类型:默认“01”凭证“02”单据“03”总账“04”明细账“05”月报“06”季报“07”半年报“08”年报“09”固定资产“10”银行回单“11”银行存款余额调节表“12”银行存款日记账“13”现金日记账“14”银行对账单“15”税务资料“16”发票…… 业务类型集成平台可自定义，业务类型与集成内容的内容编码保持一致
bookNo账薄编号Stringfalse可选；默认不传就归档到主账薄
ids唯一id，多个用英文逗号分隔Stringfalse可选；默认不传就获取所有数据，传了就只获取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授权tokenStringtrue
organizationNo组织唯一编号Stringtrue
fileName要下载文件名,与清单接口返回的结构化数据file里面的fileName保持一致Stringtrue
isMainFile是否是主文件Inttrue
period归档期属，格式yyyy-mmStringtrue
docType业务类型，参考异构业务数据字典Stringtrue 资料类型:默认“01”凭证“02”单据…… 集成平台可自定义
bookNo账薄Stringfalse可选；默认不传就归档到主账薄
修改于 2024-08-09 09:45:17
上一页
对接说明（电子档案云旗舰版）
下一页
3.1、切换组织
Built with