发票云(旗舰版)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.04 数电票红冲(直接红冲或通过红字确认单)
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
POST
/kapi/app/sim/openApi
调试
Run in Apifox
Run in Apifox
接口说明
#
红冲先后顺序说明
1、流水号在待开发票列表存在,则直接匹配数据红冲
2、存在明细匹配组装明细红冲(发票云版本5.0.024支持)
3、乐企且存在红字确认单编号(发票云版本5.0.024支持)
4、根据红字确认单编号和UUID查找存量确认单数据红冲
5、根据原蓝票号码查询存量蓝票数据录入提交生成红字确认单全额红冲
本接口可自动申请红字确认单,当确认单状态为无需确认时,自动根据红字确认单红冲,开具红票,发票开具完成后,可通过2.1.02数电票回调接口回调发票数据;当确认单状态为待对方确认等异常状态,则将状态返回,不开具发票。
注意:本接口调用后,原蓝票将自动红冲,红字确认单无法关联至负数开票申请单。
部分红冲匹配原蓝票明细规则(2选1):
1.
明细 直接传 originaldetailRowNo 匹配到原蓝票明细
2.
明细 发票云比对接口传值与蓝票明细自动匹配行序号,匹配字段包含:商品名称+税收分 类编码+税率+不含税单价(红冲原因为销售折让时,可不根据单价匹配)
验证方法
#
验证接口返回编码91401
1、带明细行的数据验证,发票号码需要符合:066574780154360003开头,确认单状态结尾(状态值参考上面的参数) 如:066574780154360003XXXX03
2、原蓝originaldetailRowNo需要修改数据库的发票号码。发票号码需要符合:066574780154360003开头,确认单状态结尾(状态值参考上面的参数) 如:066574780154360003XXXX03
验证回推返回91401
1、确认单编号验证:需要先在系统生成对应的红字确认单,然后修改红字确认单编号为:066574780154360004开头,确认单状态结尾(状态值参考上面的参数) 如:066574780154360004XXXX03
2、原蓝票红冲校验:需要先在系统生成对应的红字确认单,然后修改原蓝票号码为:066574780154360001开头,确认单状态结尾(状态值参考上面的参数) 如:066574780154360001XXXX03
税局业务规则
#
备注
数电票红冲的规则较为复杂,建议对接者对接前先阅读底下文档:
https://jdpiaozone.yuque.com/nbklz3/sszola/edhu9lhwt2kq46sv
部分红冲说明
金税四期数电发票全额红冲、部分红冲规则:红冲时,需要先申请红字确认单,且必须关联至原蓝票、原蓝票明细行序号才可以进行红冲。
税局规则:
1、
数电票在购买方将蓝字发票勾选或入账后,销售方才可以发起部分红冲
;当购买方未勾选未入账时,仅能由销售方发起全额红冲。
更新补充:税局最新规则,购方未勾选未入账等未使用蓝票的情形,支持进行部分红冲、全额红冲,红冲时,不需要对方确认。---更新时间:2024.9.20
2、税局的四种红冲原因,开票有误仅支持全额红冲,其他三种支持全额红冲、部分红冲,部分红冲时,原则上单价不允许变更。
请求参数
Query 参数
生成代码
access_token
string
可选
{access_token}
示例值:
1107974180231447552_L3nqi9yB42ysU25QKA2Z6qgxT3blIVYsp9Nr1eLbP9B63o4Pjb3177JC7544rQ0dgNCgwLEfI92NHbAaM5Cdxz1rsQwF9u1ANbDI
Header 参数
生成代码
access_token
string
可选
默认值:
{{access_token}}
Body 参数
application/json
生成代码
requestId
string
时间戳
必需
当前13位毫秒级时间戳加3位随机数字(总共16位)
businessSystemCode
string
对接业务系统来源编码
必需
对接业务系统来源编码
interfaceCode
enum<string>
接口业务编码
必需
固定值: ALLE.INVOICE.RED
枚举值:
ALLE.INVOICE.RED
data
object
必需
需要把data里面的base64字符串解密
serialNo
string
流水号
必需
由对接者定义及保障全局唯一性,【长度:50】
<= 50 字符
invoiceCode
string
原蓝票代码
可选
原蓝字发票代码【长度:20字节】,原蓝票为税控发票时必填
<= 20 字符
invoiceNum
string
原蓝票号码
必需
要红冲的蓝票号码,优先以这个为准;同时也支持旧字段invoiceNo【长度:20字节】
<= 100 字符
originalIssueTime
string
原蓝票时间
可选
格式:YYYY-MM-DD HH:MM:SS
originalInvoiceAmount
number
原蓝票金额(不含税)
可选
【长度:(14,2)】
originalTotalTaxAmount
number
原蓝票税额
可选
【长度:(14,2)】
redReason
enum<string>
红冲原因
必需
红冲原因, 申请时已经确定
枚举值:
01
02
03
04
默认值:
01
govRedConfirmBillUuid
string
税局确认单uuid
可选
1、当已申请红字确认单,绑定红字确认单开票时,govRedConfirmBillUuid 和 redInfoBillNo 二选一必填,填写后将根据红字确认单开具发票。
2、红字确认单必须在发票云存在,如不存在请先下载至发票云,发票云-基础资料-开票参数设置-自动化设置可以配置自动下载红字确认单任务。
<= 50 字符
redInfoBillNo
string
红字确认单编号
可选
1、当已申请红字确认单,绑定红字确认单开票时,govRedConfirmBillUuid 和 redInfoBillNo 二选一必填,填写后将根据红字确认单开具发票。
2、红字确认单必须在发票云存在,如不存在请先下载至发票云,发票云-基础资料-开票参数设置-自动化设置可以配置自动下载红字确认单任务。
<= 50 字符
account
string
数电账号
可选
数电票时可以传入,非数电传入会清空,如传入则使用传入的数电账号,未传入时,使用默认数电账号,发票云版本7.0可用
<= 50 字符
drawer
string
开票 人
可选
1、使用乐企开票时,必传,可展示为传输的开票人。
2、使用数电账号开票时,不传,票面的开票人展示为数电账号绑定的开票人名称,不按传输开票人展示;
3、7.0版本以上支持
<= 16 字符
invoiceType
enum<string>
发票种类
必需
枚举值:
01
02
orgCode
string
组织编码
可选
可以不传,会通过销方税号自动匹配,一个税号分配给多个组织使用的必须要传组织 【长度:20】
<= 20 字符
sellerName
string
销方名称
可选
【GBK编码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 字符
buyerName
string
购买方名称
可选
【长度:GBK编码100字节】
<= 100 字符
buyerTaxpayerId
string
购买方税号
可选
(专票必填)【长度:20】
<= 20 字符
buyerBank
string
购买方银行
可选
【购买方银行+购买方银行账号 150字节】
<= 150 字符
buyerBankAccount
string
购买方银行账号
可选
【购买方银行+购买方银行账号 150字节】
<= 150 字符
buyerAddress
string
购买方地址
可选
【购买方地址+购买方电话 120字节】
<= 120 字符
buyerTel
string
购买方电话