发票云(旗舰版)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开票申请单回退接口(星瀚发起退回开票申请单)
        POST
      • 5.1.02回调接口-按票回调(一次回调一张发票信息)
        POST
      • 5.1.03回调接口-按单回调(单据对应的所有发票开票完毕后一起回调(包含开票成功和开票失败),不支持合并又拆分的场景)
        POST
    • 开票风控接口
      • 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. 回调接口(支持除数电票直接开票接口外的开票回调)

5.1.03回调接口-按单回调(单据对应的所有发票开票完毕后一起回调(包含开票成功和开票失败),不支持合并又拆分的场景)

快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
POST
/:忽略该接口前缀,此为对接发票云方提供的回调地址(对接方必须按照成功响应示例报文返回 json )
一个开票申请单如果拆分开具了N张发票,在发票开具完毕后,只全部回调一次,开票成功失败的都会返回
(业务编号 businessSystemCode 以 3std1 开头,就会开启这种方式的回调)

请求参数

Body 参数application/json
interfaceCode
string 
必需
业务编码,开票回调是INVOICE.OPEN,作废回调是INVOICE.CANCEL,红冲回调是INVOICE.RED
returnCode
string 
必需
0成功,9999失败,按单回调无法根据此状态码判断,会存在部分开具成功,部分失败的情况,根据是否存在发票代码号码判断
returnMsg
string 
必需
开票失败原因,成功返回success
data
array [object {51}] 
必需
需要把data里面的base64字符串解密
abolishReason
string 
作废原因
必需
<= 50 字符
batch
string 
批次号
必需
<= 50 字符
billNo
string 
单据编号
必需
<= 50 字符
buyerAddressAndTel
string 
必需
购买方地址和电话,GBK编码100字节,开专票时若未传入则用名称匹配系统维护的地址电话【长度:100】
buyerBankAndAccount
string 
必需
购买方银行和账号,GBK编码100字节,开专票时若未传入则用名称匹配系统维护的银行和账号【长度:100】
buyerName
string 
购买方名称
必需
<= 50 字符
buyerProperty
number 
必需
购买方性质,0-企业,1-个人
buyerRecipientMail
string 
电子发票收票邮箱
必需
<= 300 字符
buyerRecipientPhone
string 
电子发票收票手机号
必需
<= 80 字符
buyerTaxpayerId
string 
购买方税号
必需
<= 20 字符
canceler
string 
作废人
必需
<= 10 字符
deduction
number 
必需
差额征税差额【长度:(14,2)】
deviceNo
string 
设备编号
必需
<= 50 字符
drawer
string 
必需
开票人【长度:10】
payee
string 
必需
收款人【长度:10】
reviewer
string 
必需
复核人【长度:10】
includeTaxAmount
number 
价税合计
必需
totalAmount
number 
合计金额
必需
totalTaxAmount
number 
合计税额
必需
includeTaxFlag
number 
必需
含税标识,0-不含税,1-含税【长度:1】
inventoryMark
string 
必需
清单标志,0-非清单发票,1-清单发票【长度:1】
invoiceCode
string 
发票代码
必需
<= 15 字符
invoiceNum
string 
发票号码
必需
<= 50 字符
invoiceStatus
string 
必需
发票状态 0-正常 2-待开 3-红冲 6-作废
invoiceDate
string 
开票日期
必需
invoiceDetail
array [object {18}] 
发票明细
可选
invoiceFileUrl
string 
必需
板式文件下载地址,航信百旺税盘开普通电票为PDF文件,开电子专票为ofd文件,ukey开电票都是ofd文件,数电票为ofd文件
<= 200 字符
invoiceImageUrl
string 
必需
PDF转图片预览地址
<= 200 字符
invoicePdfFileUrl
string 
必需
数电票pdf地址,星瀚版本5.0.022支持
<= 200 字符
invoiceXmlFileUrl
string 
必需
数电票xml地址,星瀚版本5.0.022支持
<= 200 字符
invoiceProperty
number 
必需
开票类型,0蓝票,1红票 【长度:1】
invoiceType
enum<string> 
必需
发票种类, 028-增值税电子专用发票, 004-增值税纸质专用发票, 026-增值税电子普通发票, 007-增值税纸质普通发票 【长度:4】
枚举值:
02802600400702508xdp10xdp
orderNo
string 
发票流水号
必需
<= 50 字符
originalInvoiceCode
string 
可选
原蓝票发票代码,开红票必传【长度:12】
originalInvoiceNumber
string 
可选
原蓝票发票号码,开红票必传【长度:8】
originalInvoiceStatus
string 
可选
原蓝票状态,红冲、回调时存在,红冲回调为3、作废回调为6
originalIssueTime
string 
可选
原蓝票开票时间,红冲、回调时存在,格式为"yyyyMMdd"
printFlag
string 
必需
纸票打印标识,0-未打印 1-已打印
redInfoBillNo
string 
必需
红字信息表编号,专用发票红冲必传【长度:16】
remark
string 
必需
备注,GBK编码230字节【长度:230】
sellerAddressAndTel
string 
销方地址和电话
必需
<= 100 字符
sellerBankAndAccount
string 
销方银行和账号
必需
<= 100 字符
sellerName
string 
销方名称
必需
<= 100 字符
sellerTaxpayerId
string 
销方税号
必需
<= 20 字符
serialNo
string 
必需
序列号 【拆分合并后重新生成的编号】
<= 50 字符
systemSource
string 
系统来源
必需
<= 50 字符
taxedType
number 
必需
征税方式,0-普通 2-差额
terminalNo
string 
终端号码
必需
<= 50 字符
checkCode
string 
校验码
必需
<= 50 字符
skm
string 
密码区
必需
<= 500 字符
issueErrorMessage
string 
开票失败原因
必需
<= 50 字符
bizControl
object 
必需
issueBizType
string 
企业业务管控编码
必需
bizType
string 
业务类型编码
必需
monthSurplusLimit
number 
月剩余额度
必需
daySurplusLimit
number 
每日剩余额
必需
isWarning
boolean 
必需
是否已超过月预警阈值
示例
{
  "interfaceCode": "string",
  "returnCode": "string",
  "returnMsg": "string",
  "data": [
    {
      "abolishReason": "string",
      "batch": "string",
      "billNo": "string",
      "buyerAddressAndTel": "string",
      "buyerBankAndAccount": "string",
      "buyerName": "string",
      "buyerProperty": 0,
      "buyerRecipientMail": "string",
      "buyerRecipientPhone": "string",
      "buyerTaxpayerId": "string",
      "canceler": "string",
      "deduction": 0,
      "deviceNo": "string",
      "drawer": "string",
      "payee": "string",
      "reviewer": "string",
      "includeTaxAmount": 0,
      "totalAmount": 0,
      "totalTaxAmount": 0,
      "includeTaxFlag": 0,
      "inventoryMark": "string",
      "invoiceCode": "string",
      "invoiceNum": "string",
      "invoiceStatus": "string",
      "invoiceDate": "string",
      "invoiceDetail": [
        {
          "amount": 0,
          "billSourceId": "string",
          "goodsName": "string",
          "includeTaxAmount": 0,
          "includeTaxPrice": "string",
          "lineProperty": 0,
          "price": "string",
          "privilegeContent": "string",
          "privilegeFlag": 0,
          "quantity": "string",
          "revenueCode": "string",
          "revenueName": "string",
          "seq": 0,
          "specification": "string",
          "taxAmount": 0,
          "taxRate": "string",
          "units": "string",
          "zeroTaxRateFlag": "string"
        }
      ],
      "invoiceFileUrl": "string",
      "invoiceImageUrl": "string",
      "invoicePdfFileUrl": "string",
      "invoiceXmlFileUrl": "string",
      "invoiceProperty": 0,
      "invoiceType": "028",
      "orderNo": "string",
      "originalInvoiceCode": "string",
      "originalInvoiceNumber": "string",
      "originalInvoiceStatus": "string",
      "originalIssueTime": "string",
      "printFlag": "string",
      "redInfoBillNo": "string",
      "remark": "string",
      "sellerAddressAndTel": "string",
      "sellerBankAndAccount": "string",
      "sellerName": "string",
      "sellerTaxpayerId": "string",
      "serialNo": "string",
      "systemSource": "string",
      "taxedType": 0,
      "terminalNo": "string",
      "checkCode": "string",
      "skm": "string",
      "issueErrorMessage": "string"
    }
  ],
  "bizControl": {
    "issueBizType": "string",
    "bizType": "string",
    "monthSurplusLimit": 0,
    "daySurplusLimit": 0,
    "isWarning": true
  }
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://cosmic-sandbox.piaozone.com/jdpjykjyxgs/:忽略该接口前缀,此为对接发票云方提供的回调地址(对接方必须按照成功响应示例报文返回 json )' \
--header 'Content-Type: application/json' \
--data-raw '{
    "interfaceCode": "string",
    "returnCode": "string",
    "returnMsg": "string",
    "data": [
        {
            "abolishReason": "string",
            "batch": "string",
            "billNo": "string",
            "buyerAddressAndTel": "string",
            "buyerBankAndAccount": "string",
            "buyerName": "string",
            "buyerProperty": 0,
            "buyerRecipientMail": "string",
            "buyerRecipientPhone": "string",
            "buyerTaxpayerId": "string",
            "canceler": "string",
            "deduction": 0,
            "deviceNo": "string",
            "drawer": "string",
            "payee": "string",
            "reviewer": "string",
            "includeTaxAmount": 0,
            "totalAmount": 0,
            "totalTaxAmount": 0,
            "includeTaxFlag": 0,
            "inventoryMark": "string",
            "invoiceCode": "string",
            "invoiceNum": "string",
            "invoiceStatus": "string",
            "invoiceDate": "string",
            "invoiceDetail": [
                {
                    "amount": 0,
                    "billSourceId": "string",
                    "goodsName": "string",
                    "includeTaxAmount": 0,
                    "includeTaxPrice": "string",
                    "lineProperty": 0,
                    "price": "string",
                    "privilegeContent": "string",
                    "privilegeFlag": 0,
                    "quantity": "string",
                    "revenueCode": "string",
                    "revenueName": "string",
                    "seq": 0,
                    "specification": "string",
                    "taxAmount": 0,
                    "taxRate": "string",
                    "units": "string",
                    "zeroTaxRateFlag": "string"
                }
            ],
            "invoiceFileUrl": "string",
            "invoiceImageUrl": "string",
            "invoicePdfFileUrl": "string",
            "invoiceXmlFileUrl": "string",
            "invoiceProperty": 0,
            "invoiceType": "028",
            "orderNo": "string",
            "originalInvoiceCode": "string",
            "originalInvoiceNumber": "string",
            "originalInvoiceStatus": "string",
            "originalIssueTime": "string",
            "printFlag": "string",
            "redInfoBillNo": "string",
            "remark": "string",
            "sellerAddressAndTel": "string",
            "sellerBankAndAccount": "string",
            "sellerName": "string",
            "sellerTaxpayerId": "string",
            "serialNo": "string",
            "systemSource": "string",
            "taxedType": 0,
            "terminalNo": "string",
            "checkCode": "string",
            "skm": "string",
            "issueErrorMessage": "string"
        }
    ],
    "bizControl": {
        "issueBizType": "string",
        "bizType": "string",
        "monthSurplusLimit": 0,
        "daySurplusLimit": 0,
        "isWarning": true
    }
}'

返回响应

🟢200成功
application/json
Body
message
string 
必需
errorCode
string 
必需
success
boolean 
成功响应
必需
示例
{
  "message": "string",
  "errorCode": "string",
  "success": true
}
上一页
5.1.02回调接口-按票回调(一次回调一张发票信息)
下一页
6.0.01 风控解除接口(星瀚发票云版本6.0.6支持)
Built with