发票云(旗舰版)API文档
旗舰版标准版智能特性
旗舰版标准版智能特性
🤖 AI Support​​
  1. 数电开票
  • 整体介绍
  • 快速开始
  • 加解密
  • 文件预览&文件上传&文件下载
  • 发票数据结构
  • 错误码
  • 常见接口错误
  • 场景指引
    • 概述
    • 直接开票
    • 单据开票
    • 扫码开票
  • 授权
    • 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 产品订阅(平台服务商专用)
    • 发票云创建组织
  1. 数电开票

2.1.02 数电票回调

快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
POST
/此为对接发票云方提供的回调地址(对接方必须按照成功响应示例报文返回 json )
返回编码统一参考:《返回编码说明》

请求参数

Body 参数application/json
returnMsg
string 
必需
开票失败原因,成功返回 success
returnCode
string 
必需
0-成功 9999-失败
interfaceCode
string 
接口编码
必需
data
object 
必需
需要把data的值进行解密
serialNo
string 
必需
外部流水号,返回调用时传入的流水号【长度:50】
<= 50 字符
invoiceNum
string 
发票号码
必需
<= 100 字符
invoiceProperty
string 
必需
开票类型,0蓝票,1红票 【长度:1】
invoiceDate
string 
开票日期
必需
invoiceType
string 
必需
发票种类, 01-数字化电子专票,02-数字化电子普票
includeTaxAmount
number 
含税金额
必需
sellerName
string 
必需
销方名称【长度:不超过100】,如果在星瀚有配置企业信息可不填,
<= 100 字符
sellerTaxpayerId
string 
销方税号
必需
<= 20 字符
sellerBank
string 
必需
销方银行【长度:不超过100】
<= 100 字符
sellerBankAccount
string 
必需
销方银账号【长度:不超过100】
<= 100 字符
sellerAddress
string 
必需
销方地址【长度:不超过100】
<= 100 字符
sellerTel
string 
必需
销方电话【长度:不超过100】
<= 100 字符
buyerName
string 
必需
购买方名称【长度:不超过100】
<= 100 字符
buyerTaxpayerId
string 
可选
购买方税号(专票必填)
<= 20 字符
buyerBank
string 
购买方银行
可选
<= 100 字符
buyerBankAccount
string 
购买方银行账号
可选
<= 100 字符
buyerAddress
string 
购买方地址
可选
<= 100 字符
buyerTel
string 
购买方电话
可选
<= 100 字符
specialType
enum<string> 
可选
特定要素类型代码。空:非特定要素;01:成品油发票;02:稀土发票;03:建筑服务发票;04:货物运输服务发票;05:不动产销售服务发票;06:不动产租赁服务发票;07:代收车船税;08:通行费;09:旅客运输服务发票(待开发);10:医疗服务(住院)发票;11:医疗服务(门诊)发票;12:自产农产品销售发票;13:拖拉机和联合收割机发票;14:机动车;15:二手车;16:农产品收购发票;17:光伏收购发票;18:卷烟发票
枚举值:
null01E0203040506070809101112131415021718
默认值:
null
buyerRecipientPhone
string 
电子发票收票手机号
可选
<= 80 字符
buyerRecipientMail
string 
电子发票收票邮箱
可选
<= 300 字符
remark
string 
可选
备注,GBK编码230字节【长度:230】
<= 230 字符
drawer
string 
必需
开票人【长度:10】
<= 10 字符
deduction
number 
可选
差额征税差额【长度:(14,2)】,征税方式为【差额征税】时必填
deductionType
string 
可选
差额征税类型代码,空:非差额发票01:全额开票 02:差额开票
purchaseType
string 
可选
收购发票类型代码,空:非收购发票01:农产品收购发票02:光伏收购发票 03:二手车收购发票
exportationType
string 
可选
出口业务适用政策代码,空:非出口业务01:退税政策02:免税政策03:征税政策
vatTaxRefundType
enum<string> 
可选
增值税即征即退类型,空:非增值税即征即退
枚举值:
010203040506070809101112
originalInvoiceNumber
string 
可选
原蓝票发票号码,开红票必传【长度:20】
<= 20 字符
redInfoBillNo
string 
可选
红字确认单编号,数电票红票、红冲必传【长度:16】
<= 16 字符
govRedConfirmBillUuid
string 
可选
数电票红字确认单税局uuid(数电票红票必填)
originalIssueTime
string 
可选
原蓝票开票日期:开红字普票时,且发票云不存在该蓝票时必填
agentUser
string 
可选
(数电票)经办人名称
agentCardType
string 
可选
(数电票)经办人证件类型
agentCardNo
string 
可选
(数电票)经办人证件号码
agentCountry
string 
可选
(数电票)经办人国籍(地区)
agentTaxNo
string 
可选
(数电票)经办人自然人纳税人识别号
naturalPersonFlag
string 
可选
自然人标识,Y-是,N-否;默认根据购方纳税人识别号取反,有值时为N,无值时为Y
invoiceFileUrl
string 
PDF文件URL
可选
xmlFileUrl
string 
XML文件URL
可选
ofdFileUrl
string 
OFD文件URL
可选
invoiceDetail
array [object {17}] 
发票明细
必需
estateSaleInfo
object (不动产租赁) 
可选
不动产销售服务信息,特定业务类型为05时必填
estateLeaseInfo
object (不动产租赁) 
可选
不动产经营租赁服务信息,特定业务类型为06时必填
buildInfo
object (建筑服务) 
可选
建筑服务信息,特定业务类型为03时必填
redConfirmBillStatus
enum<string> 
可选
红字确认单状态。发票云版本5.0.024支持
枚举值:
01020304050607080910
travelerList
array[array (旅客运输) {1}] 
可选
示例
{
  "returnMsg": "string",
  "returnCode": "string",
  "interfaceCode": "string",
  "data": {
    "serialNo": "string",
    "invoiceNum": "string",
    "invoiceProperty": "string",
    "invoiceDate": "string",
    "invoiceType": "string",
    "includeTaxAmount": 0,
    "sellerName": "string",
    "sellerTaxpayerId": "string",
    "sellerBank": "string",
    "sellerBankAccount": "string",
    "sellerAddress": "string",
    "sellerTel": "string",
    "buyerName": "string",
    "buyerTaxpayerId": "string",
    "buyerBank": "string",
    "buyerBankAccount": "string",
    "buyerAddress": "string",
    "buyerTel": "string",
    "specialType": "null",
    "buyerRecipientPhone": "string",
    "buyerRecipientMail": "string",
    "remark": "string",
    "drawer": "string",
    "deduction": 0,
    "deductionType": "string",
    "purchaseType": "string",
    "exportationType": "string",
    "vatTaxRefundType": "01",
    "originalInvoiceNumber": "string",
    "redInfoBillNo": "string",
    "govRedConfirmBillUuid": "string",
    "originalIssueTime": "string",
    "agentUser": "string",
    "agentCardType": "string",
    "agentCardNo": "string",
    "agentCountry": "string",
    "agentTaxNo": "string",
    "naturalPersonFlag": "string",
    "invoiceFileUrl": "string",
    "xmlFileUrl": "string",
    "ofdFileUrl": "string",
    "invoiceDetail": [
      {
        "seq": 0,
        "detailRowNo": 0,
        "lineProperty": "string",
        "billSourceId": "string",
        "goodsCode": "string",
        "goodsName": "string",
        "revenueCode": "string",
        "specification": "string",
        "units": "string",
        "quantity": 0,
        "price": 0,
        "amount": 0,
        "taxRate": "string",
        "taxAmount": 0,
        "discountAmount": 0,
        "discountRate": "string",
        "privilegeType": "01"
      }
    ],
    "estateSaleInfo": {
      "provinceAdress": "string",
      "cityAdreess": "string",
      "simpleAddress": "string",
      "detailAddress": "string",
      "crossCitySign": "0",
      "areaunit": "平方千米",
      "startLeaseDate": "2019-08-24",
      "endLeaseDate": "2019-08-24",
      "estateId": "string",
      "specialIndustryNumber": "string",
      "carBrandNo": "string"
    },
    "estateLeaseInfo": {
      "provinceAdress": "string",
      "cityAdreess": "string",
      "simpleAddress": "string",
      "detailAddress": "string",
      "crossCitySign": "0",
      "areaunit": "平方千米",
      "startLeaseDate": "2019-08-24",
      "endLeaseDate": "2019-08-24",
      "estateId": "string",
      "specialIndustryNumber": "string",
      "carBrandNo": "string"
    },
    "buildInfo": {
      "simpleAddress": "string",
      "detailAddress": "string",
      "crossCitySign": "0",
      "buildingName": "string",
      "landTaxNo": "string",
      "specialIndustryNumber": "string",
      "crossCityTaxVerifyNo": "string"
    },
    "redConfirmBillStatus": "01",
    "travelerList": [
      [
        {
          "traveler": "string",
          "cardType": "100",
          "cardNo": "string",
          "travelDate": "2024-04-02",
          "startPlace": "广东省深圳市宝安区",
          "endPlace": "广东省东莞市南城区",
          "transportType": "1",
          "seatClass": "一等座"
        }
      ]
    ]
  }
}

示例代码

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 '{
    "returnMsg": "string",
    "returnCode": "string",
    "interfaceCode": "string",
    "data": {
        "serialNo": "string",
        "invoiceNum": "string",
        "invoiceProperty": "string",
        "invoiceDate": "string",
        "invoiceType": "string",
        "includeTaxAmount": 0,
        "sellerName": "string",
        "sellerTaxpayerId": "string",
        "sellerBank": "string",
        "sellerBankAccount": "string",
        "sellerAddress": "string",
        "sellerTel": "string",
        "buyerName": "string",
        "buyerTaxpayerId": "string",
        "buyerBank": "string",
        "buyerBankAccount": "string",
        "buyerAddress": "string",
        "buyerTel": "string",
        "specialType": "null",
        "buyerRecipientPhone": "string",
        "buyerRecipientMail": "string",
        "remark": "string",
        "drawer": "string",
        "deduction": 0,
        "deductionType": "string",
        "purchaseType": "string",
        "exportationType": "string",
        "vatTaxRefundType": "01",
        "originalInvoiceNumber": "string",
        "redInfoBillNo": "string",
        "govRedConfirmBillUuid": "string",
        "originalIssueTime": "string",
        "agentUser": "string",
        "agentCardType": "string",
        "agentCardNo": "string",
        "agentCountry": "string",
        "agentTaxNo": "string",
        "naturalPersonFlag": "string",
        "invoiceFileUrl": "string",
        "xmlFileUrl": "string",
        "ofdFileUrl": "string",
        "invoiceDetail": [
            {
                "seq": 0,
                "detailRowNo": 0,
                "lineProperty": "string",
                "billSourceId": "string",
                "goodsCode": "string",
                "goodsName": "string",
                "revenueCode": "string",
                "specification": "string",
                "units": "string",
                "quantity": 0,
                "price": 0,
                "amount": 0,
                "taxRate": "string",
                "taxAmount": 0,
                "discountAmount": 0,
                "discountRate": "string",
                "privilegeType": "01"
            }
        ],
        "estateSaleInfo": {
            "provinceAdress": "string",
            "cityAdreess": "string",
            "simpleAddress": "string",
            "detailAddress": "string",
            "crossCitySign": "0",
            "areaunit": "平方千米",
            "startLeaseDate": "2019-08-24",
            "endLeaseDate": "2019-08-24",
            "estateId": "string",
            "specialIndustryNumber": "string",
            "carBrandNo": "string"
        },
        "estateLeaseInfo": {
            "provinceAdress": "string",
            "cityAdreess": "string",
            "simpleAddress": "string",
            "detailAddress": "string",
            "crossCitySign": "0",
            "areaunit": "平方千米",
            "startLeaseDate": "2019-08-24",
            "endLeaseDate": "2019-08-24",
            "estateId": "string",
            "specialIndustryNumber": "string",
            "carBrandNo": "string"
        },
        "buildInfo": {
            "simpleAddress": "string",
            "detailAddress": "string",
            "crossCitySign": "0",
            "buildingName": "string",
            "landTaxNo": "string",
            "specialIndustryNumber": "string",
            "crossCityTaxVerifyNo": "string"
        },
        "redConfirmBillStatus": "01",
        "travelerList": [
            [
                {
                    "traveler": "string",
                    "cardType": "100",
                    "cardNo": "string",
                    "travelDate": "2024-04-02",
                    "startPlace": "广东省深圳市宝安区",
                    "endPlace": "广东省东莞市南城区",
                    "transportType": "1",
                    "seatClass": "一等座"
                }
            ]
        ]
    }
}'

返回响应

🟢200成功
application/json
Body
message
string 
必需
errorCode
string 
响应码,成功-0
必需
success
boolean 
成功传true
必需
示例
{
  "message": "回调成功",
  "errorCode": "0",
  "success": true
}
🟢200失败
上一页
2.1.01 数电票蓝字发票开具
下一页
2.1.03 红字确认单生成
Built with