发票云(旗舰版)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开票申请单回退接口(星瀚发起退回开票申请单)
      • 5.1.02回调接口-按票回调(一次回调一张发票信息)
      • 5.1.03回调接口-按单回调(单据对应的所有发票开票完毕后一起回调(包含开票成功和开票失败),不支持合并又拆分的场景)
    • 开票风控接口
      • 6.0.01 风控解除接口(星瀚发票云版本6.0.6支持)
    • 扫码开票接口(税控+数电)
      • 业务系统生成二维码链接模式
        • 3.1.01业务系统组装二维码链接格式
          GET
        • 3.1.02查询订单接口(由客户提供)
          POST
        • 3.1.03 扫码提交购方抬头规则
          POST
        • 3.1.04账单中心开票小程序短链接生成
          POST
      • 推单星瀚生成二维码链接模式
        • 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. 业务系统生成二维码链接模式

3.1.02查询订单接口(由客户提供)

快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
POST
/此为对接发票云方提供的查询订单接口地址(对接方必须按照成功响应示例报文返回 json ) 接口配置地址关联动态二维码配置里的业务编码(位于 发票云->系统管理->业务系统)
扫码开票二维码规则:
1 规则说明
示例扫码地址:http://scan.piaozone.com/demo/tyqr?k=key,ddh,je,timestamps,md5,$
key:门店id,由金蝶分配
ddh:小票单号
je: 小票金额
timestamps: 时间戳
md5: MD5加密值
注意:最后要拼接$结尾
2 MD5值说明
MD5(KEY + DDH + MD5(public_key+ DDH) + JE)
第一步:
MD5_1 = MD5(public_key + DDH)
第二步:
MD5_2 = MD5(KEY + DDH + MD5_1 + JE)
附:
public_key 由金蝶分配,每个租户分配一对(查看路径:发票云--系统管理--云应用参数配置--移动云参数配置)
public_key 由 key 关联查询(金蝶端校验)
流程步骤:
1.对接客户通过以下接口生成二维码给到用户(http://scan.piaozone.com/demo/tyqr?k=key,ddh,je,timestamps,md5,$)
2.用户扫码到开票界面,填写购方信息
3.用户提交开票
4.发票云系统通过客户提供给发票云的明细查询地址(http://xxxxxxx/scanInvoice/queryOrder)查询单据编号对应的明细数据
5.完成开票

请求参数

Body 参数application/json
interfaceCode
enum<string> 
必需
固定业务编码 GET.ORDER
枚举值:
GET.ORDER
data
string 
必需
单据编号,是BASE64编码或AES密文,根据设置的加密规则进行解码或解密
示例
{
  "interfaceCode": "GET.ORDER",
  "data": "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/此为对接发票云方提供的查询订单接口地址(对接方必须按照成功响应示例报文返回 json ) 接口配置地址关联动态二维码配置里的业务编码(位于 发票云->系统管理->业务系统)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "interfaceCode": "GET.ORDER",
    "data": "string"
}'

返回响应

🟢200成功
application/json
Body
code
string 
必需
返回"0"则表示成功,其他表示失败
示例值:
0
message
string 
必需
接口返回成功消息,失败返回失败原因
data
object 
必需
data数据为明文不需要加密
billNo
string 
单据编号,必填
必需
drawer
string 
开票人,必填
必需
payee
string 
付款人
可选
reviewer
string 
复核人
可选
billDate
string 
必需
单据日期,必填 格式yyyy-MM-dd
remark
string 
发票备注,选填
可选
includeTaxFlag
string 
必需
含税标识,必填 0-不含税 1-含税
billProperty
string 
必需
单据性质,必填 1-正数 -1负数
sellerTaxpayerId
string 
必需
销售方纳税人识别号,必填
buyerTaxpayerId
string 
购方税号
可选
buyerName
string 
购方名称
可选
buyerBankAndAccount
string 
购方银行账号
可选
buyerAddressAndTel
string 
购方地址电话
可选
cancalState
string 
必需
作废标识,必填。 0-未作废,1-作废
billAmount
number 
必需
单据金额,必填。如果含税标识是含税就是含税金额,不含税就是不含税金额
billTax
number 
单据税额,选填
可选
issueBizType
string 
可选
调度开票业务类型(传开票业务类型编码)
billDetail
array [object {14}] 
必需
示例
{
  "code": "0",
  "message": "string",
  "data": {
    "billNo": "string",
    "drawer": "string",
    "payee": "string",
    "reviewer": "string",
    "billDate": "string",
    "remark": "string",
    "includeTaxFlag": "string",
    "billProperty": "string",
    "sellerTaxpayerId": "string",
    "buyerTaxpayerId": "string",
    "buyerName": "string",
    "buyerBankAndAccount": "string",
    "buyerAddressAndTel": "string",
    "cancalState": "string",
    "billAmount": 0,
    "billTax": 0,
    "issueBizType": "string",
    "billDetail": [
      {
        "amount": 0,
        "quantity": "string",
        "discountAmount": 0,
        "specification": "string",
        "units": "string",
        "privilegeContent": "string",
        "taxRate": "string",
        "privilegeFlag": "string",
        "price": "string",
        "goodsCode": "string",
        "lineProperty": "string",
        "taxAmount": 0,
        "goodsName": "string",
        "revenueCode": "string"
      }
    ]
  }
}
上一页
3.1.01业务系统组装二维码链接格式
下一页
3.1.03 扫码提交购方抬头规则
Built with