发票云(旗舰版)API文档
旗舰版标准版智能特性
旗舰版标准版智能特性
  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业务系统组装二维码链接格式
        • 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 产品订阅（平台服务商专用）
      POST
    • 发票云创建组织
      POST
  1. 订单

1.01 产品订阅（平台服务商专用）

快速开始环境
快速开始环境
POST
/ierp/kapi/app/ocm/ThirdPlatOrderApi

请求参数

Query 参数
access_token
string 
必需
{access_token}
Body 参数application/json
opType
enum<string> 
必需
固定：addCosmicApiOrder
枚举值:
addCosmicApiOrder
systemSource
string 
必需
来源；由发票云线下给出
callbackUrl
string 
可选
回调地址，用于开票结果通知；订阅开票产品必填
thirdOrderNo
string 
必需
订单id，由平台服务商生成，用来双方系统对账使用
data
object 
必需
纳税人信息（整个data内容需要进行加密）
taxUserList
array [object {4}] 
必需
账号列表，目前暂时用第一个
companyInfo
object 
企业相关信息内容
必需
collectChannel
number 
必需
收票通道：1: RPA, 2: 软证书； 3：乐企, 默认为：1 RPA
taxChannel
number 
必需
税局开票通道：1: RPA, 2: 乐企, 3: 服务商；默认为: 1
taxDeviceList
array [object {2}] 
税盘相关信息内容
必需
orderContent
array [object {4}] 
订单内容
必需
product_end_date
string 
可选
约定结束时间（格式：YYYY-MM-DD）
product_start_date
string 
可选
约定开始时间（格式：YYYY-MM-DD）
subscribe_days
number 
可选
订阅产品的服务周期（单位：天）
productName
number 
可选
订阅产品：1: 云API开票, 2: 云API收票；默认为：1；元素类型是number
示例
{
  "opType": "addCosmicApiOrder",
  "systemSource": "string",
  "callbackUrl": "string",
  "thirdOrderNo": "string",
  "data": {
    "taxUserList": [
      {
        "middleNumber": {},
        "roleText": "string",
        "etaxPassword": "string",
        "etaxAccount": "string"
      }
    ],
    "companyInfo": {
      "contactEmail": "string",
      "companyName": "string",
      "taxNo": "string",
      "companyType": "string",
      "areaCode": "string",
      "registerAddress": "string",
      "bankName": "string",
      "bankAccount": {},
      "contactName": "string"
    },
    "collectChannel": 0,
    "taxChannel": 0,
    "taxDeviceList": [
      {
        "deviceType": 0,
        "deviceNo": "string"
      }
    ]
  },
  "orderContent": [
    {
      "product_end_date": "string",
      "product_start_date": "string",
      "subscribe_days": 0,
      "productName": 0
    }
  ]
}

示例代码

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/ierp/kapi/app/ocm/ThirdPlatOrderApi?access_token=' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功
application/json
Body
data
object 
必需
addressUrl
string 
必需
RPA初始化的界面地址（即H5地址 addressUrl）
accountId
string 
必需
数据中心id，用于获取access_token
appId
string 
必需
应用授权id,用于获取access_token
appSecuret
string 
必需
应用授权秘钥,用于获取access_token
user
string 
用户
必需
businessSystemCode
string 
业务系统编码
必需
aesKey
string 
加密密钥
必需
userType
string 
用户类型
必需
requestUrl
string 
星瀚发票云平台地址
必需
message
string 
描述
必需
errorCode
string 
返回码
必需
success
boolean 
返回成功状态
必需
示例
{
  "data": {
    "addressUrl": "string",
    "accountId": "string",
    "appId": "string",
    "appSecuret": "string",
    "user": "string",
    "businessSystemCode": "string",
    "aesKey": "string",
    "userType": "string",
    "requestUrl": "string"
  },
  "message": "string",
  "errorCode": "string",
  "success": true
}
修改于 2024-02-22 10:40:15
上一页
3.4、查询电子税局账号
下一页
发票云创建组织
Built with