发票云(旗舰版)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已开发票查询
        POST
      • 4.1.02机动车发票查询(税控)
        POST
      • 4.1.03.数电票发票批量查询
        POST
      • 4.1.04.数电票发票单张查询
        POST
    • 回调接口(支持除数电票直接开票接口外的开票回调)
      • 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. 发票查询接口

4.1.04.数电票发票单张查询

快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
POST
/kapi/app/sim/openApi

请求参数

Query 参数
access_token
string 
必需
{access_token}
Body 参数application/json
requestId
string 
必需
当前13位毫秒级时间戳加3位随机数字(总共16位)
businessSystemCode
string 
必需
对接业务系统来源编码,用于区分不同业务系统的回调接口
interfaceCode
enum<string> 
接口编码
必需
枚举值:
ALLE.INVOICE.QUERY
data
object 
必需
需要把data里面的object进行加密成字符串
serialNo
string 
可选
开红、蓝票时传入的流水号 。与发票号码不能同时为空
invoiceNum
string 
可选
发票号码。与流水号不能同时为空, 请注意:5.0.027版本支持
sellerTaxpayerId
string 
销售方纳税人识别号
必需
示例
{
  "requestId": "string",
  "businessSystemCode": "string",
  "interfaceCode": "ALLE.INVOICE.QUERY",
  "data": {
    "serialNo": "string",
    "invoiceNum": "string",
    "sellerTaxpayerId": "string"
  }
}

示例代码

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/kapi/app/sim/openApi?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "string",
    "businessSystemCode": "string",
    "interfaceCode": "ALLE.INVOICE.QUERY",
    "data": {
        "serialNo": "string",
        "invoiceNum": "string",
        "sellerTaxpayerId": "string"
    }
}'

返回响应

🟢200成功
application/json
Body
success
boolean 
必需
true或false
errorCode
string 
"0"为成功
必需
message
string 
错误描述
必需
data
object 
返回内容,需要解密
必需
batch
string 
批次号
可选
<= 50 字符
orderNo
string 
必需
发票流水号【长度30】
<= 30 字符
serialNo
string 
必需
单据编号【长度30】
<= 30 字符
buyerType
string 
必需
数据来源,0-单张,1-批量导入,2-数据同步,3-直接开票接口,4-单据拆合,5-作废重开,6-空白作废,7-扫码开票,8-excel导入,9-进项下载,10-公有云同步,11-手工新增红字信息表编号,12-小票码开票
buyerTaxpayerId
string 
购买方税号
可选
<= 20 字符
buyerName
string 
必需
购买方名称,GBK编码100个字节【长度:100】
<= 100 字符
buyerBank
string 
购买方银行
可选
<= 200 字符
buyerBankAccount
string 
购买方银行账号
可选
<= 50 字符
buyerAddress
string 
购买方地址
可选
<= 200 字符
buyerTel
string 
购买方电话
可选
<= 50 字符
buyerProperty
number 
必需
购买方性质,0-企业,1-个人【长度:1】
buyerRecipientMail
string 
必需
电子发票交付邮箱【长度:100】
buyerRecipientPhone
string 
必需
电子发票交付手机号,接收短信【长度:50】
deduction
number 
必需
差额【长度:(14,2)】
drawer
string 
必需
开票人【长度:10】
payee
string 
可选
收款人【长度:30】
reviewer
string 
可选
复核人【长度:30】
invoiceType
string 
必需
发票种类, 01-数字化电子专票,02-数字化电子普票
includeTaxAmount
number 
价税合计
必需
totalAmount
number 
合计金额
必需
totalTaxAmount
number 
合计税额
必需
invoiceNum
string 
发票号码
必需
<= 50 字符
specialType
string 
可选
特殊票种,00-非特殊票种 02-收购,06-抵扣通行费,07-不抵扣通行费,08-成品油,11-卷烟,18-机动车,E03-建筑服务发票,E04-货物运输,E05-不动产销售服务发票,E06-不动产经营租赁服务,E01-成品油(数电票),E18卷烟(数电票)
invoiceFileUrl
string 
PDF文件URL
可选
<= 200 字符
xmlFileUrl
string 
XML文件URL
可选
<= 200 字符
ofdFileUrl
string 
OFD文件URL
可选
<= 200 字符
invoiceImageUrl
string 
发票快照URL
可选
<= 200 字符
invoiceDate
string 
开票日期
必需
invoiceProperty
number 
必需
开票类型,0蓝票,1红票【长度:1】
originalInvoiceNumber
string 
可选
原蓝票号码,开红票必传【长度:8】
redInfoBillNo
string 
红字确认单编号
可选
<= 50 字符
govRedConfirmBillUuid
string 
必需
数电票红字确认单税局uuid
<= 50 字符
remark
string 
可选
备注,GBK编码230字节【长度:230】
sellerName
string 
必需
销售方名称,GBK编码100个字节,未传入时使用销售方纳税人识别号匹配系统维护的名称【长度:100】
<= 100 字符
sellerTaxpayerId
string 
必需
销售方纳税人识别号【长度:20】
sellerAddress
string 
销售方地址
可选
<= 200 字符
sellerTel
string 
销售方电话
可选
<= 50 字符
sellerBank
string 
销售方银行
可选
<= 200 字符
sellerBankAccount
string 
销售方银行账号
可选
<= 50 字符
invoiceStatus
enum<string> 
必需
发票状态,0正常,2开票中,3红冲,4开票失败
枚举值:
0123467
redReason
string 
红冲原因
必需
<= 200 字符
issueErrorMessage
string 
开票失败原因
必需
systemSource
string 
业务系统来源
可选
<= 50 字符
agentUser
string 
必需
(数电票)经办人名称
<= 50 字符
agentCardType
string 
必需
(数电票)经办人证件类型
agentCardNo
string 
必需
(数电票)经办人证件号码
<= 30 字符
agentCountry
string 
必需
(数电票)经办人国籍(地区)
agentTaxNo
string 
必需
(数电票)经办人自然人纳税人识别号
<= 30 字符
naturalPersonFlag
string 
必需
自然人标识,Y-是,N-否;默认根据购方纳税人识别号取反,有值时为N,无值时为Y
vatTaxRefundType
enum<string> 
必需
增值税即征即退类型,空:非增值税即征即退
枚举值:
010203040506070809101112
invoiceDetail
array [object {14}] 
发票明细
必需
cardType
string 
可选
证件类型,103-税务登记证,201-居民身份证,208-外国护照,210-港澳居民来往内地通行证,213-台湾居民来往大陆通行证,215-外国人居留证,219-香港永久性居民身份证,220-台湾身份证,221-澳门特别行政区永久性居民身份证,233-外国人永久居留身份证(外国人永久居留证),299-其他个人证件,
account
string 
电子税局账号
可选
<= 20 字符
estateLeaseInfo
object (不动产租赁) 
必需
不动产经营租赁服务信息,特定业务类型为06时必填
estateSaleInfo
object (不动产销售) 
必需
不动产销售服务信息,特定业务类型为05时必填
buildInfo
object (建筑服务) 
必需
建筑服务信息,特定业务类型为03时必填
示例
{
  "errorCode": "0",
  "success": true,
  "errorMsg": "",
  "data": {
    "batch": "",
    "orderNo": "3ZUAOD4LKWG90BQG9O1L",
    "buyerType": 2,
    "systemSource": "",
    "serialNo": "300_20240311134422540_0001",
    "invoiceType": "02",
    "sellerTaxpayerId": "91440300MA5G9GK78Y",
    "sellerName": "金蝶票据云科技(深圳)有限公司",
    "sellerAddress": "",
    "sellerTel": "",
    "sellerBank": "",
    "sellerBankAccount": "",
    "buyerTaxpayerId": "91440300358768292H",
    "buyerName": "深圳金蝶账无忧网络科技有限公司",
    "buyerAddress": "",
    "buyerTel": "",
    "buyerBank": "",
    "buyerBankAccount": "",
    "originalInvoiceNumber": "",
    "invoiceProperty": 0,
    "buyerProperty": 0,
    "buyerRecipientPhone": "",
    "buyerRecipientMail": "",
    "remark": "",
    "deduction": 0,
    "drawer": "",
    "payee": "",
    "reviewer": "",
    "redInfoBillNo": "",
    "includeTaxAmount": 9.54,
    "totalAmount": 9,
    "totalTaxAmount": 0.54,
    "invoiceDate": "2024-03-11 12:06:51",
    "invoiceNum": "24952000000028787793",
    "specialType": "",
    "invoiceStatus": "0",
    "redReason": "",
    "issueErrorMessage": "",
    "invoiceFileUrl": "",
    "invoiceImageUrl": "",
    "ofdFileUrl": "https://api-sit.piaozone.com/doc/free/fileInfo/preview/f1217432316435607552324890169",
    "xmlFileUrl": "https://api-sit.piaozone.com/test/rpa/free/preview/5368720388/91440300MA5G9GK78Y/3ZUAOD4LKWG90BQG9O1L?type=3",
    "invoiceDetail": [
      {
        "seq": 0,
        "billSourceId": "",
        "goodsCode": "",
        "revenueName": "",
        "revenueCode": "3040201010000000000",
        "goodsName": "*信息技术服务*纸电一体开收票",
        "specification": "",
        "units": "件",
        "quantity": "1.0000000000000",
        "price": "2.0000000000000",
        "taxUnitPrice": 0,
        "amount": 2,
        "includeTaxAmount": 2.12,
        "taxRate": "0.06",
        "taxAmount": 0.12,
        "discountAmount": 0,
        "discountRate": "",
        "privilegeType": "",
        "lineProperty": 0
      },
      {
        "seq": 1,
        "billSourceId": "",
        "goodsCode": "",
        "revenueName": "",
        "revenueCode": "3040201010000000000",
        "goodsName": "*信息技术服务*纸电一体开收票",
        "specification": "",
        "units": "件",
        "quantity": "1.0000000000000",
        "price": "3.0000000000000",
        "taxUnitPrice": 0,
        "amount": 3,
        "includeTaxAmount": 3.18,
        "taxRate": "0.06",
        "taxAmount": 0.18,
        "discountAmount": 0,
        "discountRate": "",
        "privilegeType": "",
        "lineProperty": 0
      },
      {
        "seq": 2,
        "billSourceId": "",
        "goodsCode": "",
        "revenueName": "",
        "revenueCode": "3040201010000000000",
        "goodsName": "*信息技术服务*纸电一体开收票",
        "specification": "",
        "units": "件",
        "quantity": "1.0000000000000",
        "price": "4.0000000000000",
        "taxUnitPrice": 0,
        "amount": 4,
        "includeTaxAmount": 4.24,
        "taxRate": "0.06",
        "taxAmount": 0.24,
        "discountAmount": 0,
        "discountRate": "",
        "privilegeType": "",
        "lineProperty": 0
      }
    ],
    "cardType": "",
    "account": ""
  }
}
上一页
4.1.03.数电票发票批量查询
下一页
5.1.01开票申请单回退接口(星瀚发起退回开票申请单)
Built with