发票云(旗舰版)API文档
旗舰版
标准版
智能特性
旗舰版
标准版
智能特性
🤖 AI Support
数电开票
复制页面
整体介绍
快速开始
加解密
文件预览&文件上传&文件下载
发票数据结构
错误码
常见接口错误
场景指引
概述
直接开票
单据开票
扫码开票
授权
1.01.获取app_token
1.02获取access_token
开票
单据开票接口(税控+数电)
单据开票对接指引
开票申请单错误码列表
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 数电票蓝字发票开具
POST
2.1.02 数电票回调
POST
2.1.03 红字确认单生成
POST
2.1.04 数电票红冲(直接红冲或通过红字确认单)
POST
2.1.05 授信额度查询
POST
2.1.08 红字确认单撤销
POST
2.1.09 红字确认单确认或拒绝
POST
2.1.12 红字确认单下载
POST
2.1.13 红字确认单编号查询
POST
2.1.14 发票用途状态查询(发票云版本6.0.11支持,暂只支持乐企)
POST
税控开票
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 产品订阅(平台服务商专用)
发票云创建组织
数电开票
MCP
复制页面
2.1.02 数电票回调
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
POST
/此为对接发票云方提供的回调地址(对接方必须按照成功响应示例报文返回 json )
调试
Run in Apifox
Run in Apifox
返回编码统一参考:
《返回编码说明》
通过2.1.01数电蓝字发票开具、2.1.04数电票红冲接口开具数电发票后,通过本接口回调
请求参数
Header 参数
生成代码
access_token
string
可选
默认值:
{{access_token}}
Body 参数
application/json
生成代码
returnMsg
string
回调信息
必需
开票失败时返回失败原因,开票成功返回 success
returnCode
string
回调代码
必需
0-成功 9999-失败
interfaceCode
string
接口业务编码
必需
固定值,回调蓝票时:INVOICE.OPEN,回调红票时:INVOICE.RED
data
object
必需
需要把data的值进行解密
serialNo
string
外部流水号
必需
返回调用时传入的流水号
<= 50 字符
invoiceNum
string
发票号码
必需
<= 100 字符
invoiceProperty
enum<string>
开票类型
必需
<= 1 字符
枚举值:
0
1
invoiceDate
string
开票日期
必需
invoiceType
enum<string>
发票种类
必需
枚举值:
01
02
includeTaxAmount
number
含税金额
必需
sellerName
string
销方名称
必需
【长度:不超过100】
<= 100 字符
sellerTaxpayerId
string
销方税号
必需
<= 20 字符
sellerBank
string
销方银行
可选
【销方银行+销方银行账号 GBK编码150字节】
<= 150 字符
sellerBankAccount
string
销方银账号
可选
【销方银行+销方银行账号 GBK编码150字节】
<= 150 字符
sellerAddress
string
销方地址
可选
【销方地址+销方电话 GBK编码120字节】
<= 120 字符
sellerTel
string
销方电话
可选
【销方地址+销方电话 GBK编码120字节】
<= 120 字符
naturalPersonFlag
string
自然人标识
可选
Y-是,N-否;默认根据购方纳税人识别号取反,有值时为N,无值时为Y
buyerName
string
购买方名称
必需
【长度:不超过100】
<= 100 字符
buyerTaxpayerId
string
购买方税号
可选
专票必填
<= 20 字符
buyerBank
string
购买方银行
可选
【购买方银行+购买方银行账号 150字节】
<= 150 字符
buyerBankAccount
string
购买方银行账号
可选
【购买方银行+购买方银行账号 150字节】
<= 150 字符
buyerAddress
string
购买方地址
可选
【购买方地址+购买方电话 120字节】
<= 120 字符
buyerTel
string
购买方电话
可选
【购买方地址+购买方电话 120字节】
<= 120 字符
specialType
enum<string>
特定要素类型代码
可选
空:非特定要素;01:成品油发票;02:稀土发票;03:建筑服务发票;04:货物运输服务发票;05:不动产销售服务发票;06:不动产租赁服务发票;07:代收车船税;08:通行费;09:旅客运输服务发票(待开发);10:医疗服务(住院)发票;11:医疗服务(门诊)发票;12:自产农产品销售发票;13:拖拉机和联合收割机发票;14:机动车;15:二手车;16:农产品收购发票;17:光伏收购发票;18:卷烟发票
枚举值:
null
01
E02
03
04
05
06
07
08
09
10
11
12
13
14
15
02
17
18
默认值:
null
buyerRecipientPhone
string
电子发票收票手机号
可选
<= 80 字符
buyerRecipientMail
string