发票云(旗舰版)API文档
旗舰版标准版智能特性
旗舰版标准版智能特性
🤖 AI Support​​
  1. 单据开票接口(税控+数电)
  • 整体介绍
  • 快速开始
  • 加解密
  • 文件预览&文件上传&文件下载
  • 发票数据结构
  • 错误码
  • 常见接口错误
  • 场景指引
    • 概述
    • 直接开票
    • 单据开票
    • 扫码开票
  • 授权
    • 1.01.获取app_token
    • 1.02获取access_token
  • 开票
    • 单据开票接口(税控+数电)
      • 单据开票对接指引
      • 开票申请单错误码列表
      • 1.1.01 开票申请单生成及开票(支持拆分合并后,再开票)
        POST
      • 1.1.02 开票申请单撤回(对接方主动撤回)
        POST
      • 1.1.03 开票申请单发票查询
        POST
      • 1.1.04 开票申请单快速红冲(仅支持税控普票)
        POST
      • 1.1.05 开票申请单批量作废(作废单据的发票,仅支持税控纸票)
        POST
      • 1.1.06 开票申请单红冲单或作废单生成(星瀚发票云版本5.0.015支持,不支持数电票)
        POST
      • 1.1.07 开票申请单重开单生成(星瀚发票云版本5.0.015支持,不支持数电票)
        POST
      • 1.1.08 创建负数单匹配任务
        POST
      • 1.1.09 查询负数单匹配任务结果
        POST
      • 1.1.10 单据开票预览
        POST
    • 直接开票接口
      • 数电开票
        • 接入指引(必看)
        • 返回编码说明
        • 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业务系统组装二维码链接格式
        • 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. 单据开票接口(税控+数电)

1.1.08 创建负数单匹配任务

开发中
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
快速开始环境
https://cosmic-sandbox.piaozone.com/jdpjykjyxgs
POST
/kapi/app/sim/openApi
本接口为异步接口,需要结合1.1.09接口使用

请求参数

Query 参数
access_token
string 
可选
示例值:
1617326422240529408_YGVCbl9K6s8XTrIE0J9rdaztYI5Nw9LqmCadaCx2kW9v5CLRGZwLetQjDShDRbi3LVxQQTH5e9v1v7h4ac4L2BUTF1n6ucvd1wM8
Body 参数application/json
requestId
string 
时间戳
必需
businessSystemCode
string 
必需
对接不同系统来源编码,用于区分不同系统的回调接口
interfaceCode
enum<string> 
接口业务编码
必需
枚举值:
BILL.MATCH
data
array [object {17}] 
必需
需要把data的值加密成字符串,默认为base64
billNo
string <regex>
必需
单据编号;参数限制:数字、英文、下划线、-
<= 50 字符
默认值:
0
正则匹配:
^[a-zA-Z0-9_-]+$
redReason
enum<string> 
必需
冲红原因,开具红字普票时选填,1销货退回;2开票有误;3开票中止;4销售折让(填了待冲蓝票代码、号码时,如不填,默认为2开票有误)
枚举值:
1234
默认值:
2
invoiceType
enum<string> 
必需
发票种类,未配置票种管理策略时必填
枚举值:
02802600400702508xdp10xdp
orgCode
string 
可选
组织编码(默认可以不传,会通过销方税号自动匹配,一个税号分配给多个组织使用的必须要传组织) 【长度:20】
<= 20 字符
sellerTaxpayerId
string 
可选
销方税号。组织编号、销方名称/税号三选一必传 (1)传组织编号,销方信息未传时,根据组织编号找销方信息。 (2)销方税号/销方二选一,两者都填,以销方税号为准。
<= 20 字符
sellerName
string 
可选
销方名称,销方税号或销方二选一必填,两者都填,以销方税号为准
<= 100 字符
buyerTaxpayerId
string 
必需
购买方税号,(专票必填) 当购买方性质为企业填写税号,当购方性质为个人填写身份证
<= 20 字符
buyerName
string 
必需
购买方名称,根据购方名称匹配税号、地址电话、开户行账号(如有),不传且需自动开票时,提示:购方名称为空,请补充,不传且不自动开票时,保存为开票申请单
<= 100 字符
pushMatchRules
enum<string> 
必需
商品明细匹配规则 0-按物料匹配(默认) 1-物料分类匹配 2-按商品匹配 3-按开票项匹配
枚举值:
0123
默认值:
0
fillValueRule
enum<string> 
必需
商品名称取值规则 默认-取开票项名称 goodsName-取上游商品名称goodsCode-取上游商品编码 materialType-取上游物料分类
枚举值:
nullgoodsNamegoodsCodematerialType
textField1
string 
可选
主表扩展字段1【长度:GBK150字节】
<= 150 字符
textField2
string 
可选
主表扩展字段2【长度:GBK150字节】
<= 150 字符
textField3
string 
可选
主表扩展字段3【长度:GBK150字节】
<= 150 字符
textField4
string 
可选
主表扩展字段4【长度:GBK150字节】
<= 150 字符
textField5
string 
可选
主表扩展字段5【长度:GBK150字节】
<= 150 字符
totalAmount
number 
可选
不含税金额。在匹配规则中,匹配基准为按金额匹配时必填,匹配基准为按数量匹配时不填
billDetail
array [object {17}] 
单据明细
必需
示例
{
  "requestId": "1624601109096",
  "businessSystemCode": "BUSINESS_FPY",
  "interfaceCode": "BILL.PUSH",
  "data": [
    {
      "billNo": "ids-uat-3std1-29",
      "billDate": "2023-05-17",
      "totalAmount": 11300,
      "autoInvoice": "0",
      "invoiceType": "08xdp",
      "buyerName": "深圳市顺丰快运有限公司test01",
      "buyerProperty": "0",
      "sellerTaxpayerId": "91440300MA5G9GK78Y",
      "sellerName": "金蝶票据云科技(深圳)有限公司",
      "sellerBankAndAccount": "13710884704",
      "sellerAddressAndTel": "高新技术产业园南区科技南十二路58996989",
      "drawer": "开票人",
      "billDetail": [
        {
          "amount": 11300,
          "detailId": "1194121661989796666",
          "goodsName": "蜂胶口腔膜",
          "lineProperty": 2,
          "price": 11300,
          "quantity": 1,
          "revenueCode": "1070304990000000000",
          "taxRate": "0.13",
          "units": "个"
        }
      ]
    }
  ]
}

示例代码

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=1617326422240529408_YGVCbl9K6s8XTrIE0J9rdaztYI5Nw9LqmCadaCx2kW9v5CLRGZwLetQjDShDRbi3LVxQQTH5e9v1v7h4ac4L2BUTF1n6ucvd1wM8' \
--header 'Content-Type: application/json' \
--data-raw '{
  "requestId": "1624601109096",
  "businessSystemCode": "BUSINESS_FPY",
  "interfaceCode": "BILL.PUSH",
  "data": [
    {
      "billNo": "ids-uat-3std1-29",
      "billDate": "2023-05-17",
      "totalAmount": 11300,
      "autoInvoice": "0",
      "invoiceType": "08xdp",
      "buyerName": "深圳市顺丰快运有限公司test01",
      "buyerProperty": "0",
      "sellerTaxpayerId": "91440300MA5G9GK78Y",
      "sellerName": "金蝶票据云科技(深圳)有限公司",
      "sellerBankAndAccount": "13710884704",
      "sellerAddressAndTel": "高新技术产业园南区科技南十二路58996989",
      "drawer": "开票人",
      "billDetail": [
        {
          "amount": 11300,
          "detailId": "1194121661989796666",
          "goodsName": "蜂胶口腔膜",
          "lineProperty": 2,
          "price": 11300,
          "quantity": 1,
          "revenueCode": "1070304990000000000",
          "taxRate": "0.13",
          "units": "个"
        }
      ]
    }
  ]
}'

返回响应

🟢200成功
application/json
Body
data
object 
返回内容,需要解密
可选
batchNo
string 
任务号
必需
errorCode
string 
0为成功
必需
message
string 
错误信息
必需
success
boolean 
成功响应
必需
示例
{
  "message": "成功",
  "errorCode": "0",
  "status": true,
  "success": true
}
🟢200失败
上一页
1.1.07 开票申请单重开单生成(星瀚发票云版本5.0.015支持,不支持数电票)
下一页
1.1.09 查询负数单匹配任务结果
Built with