发票云(标准版)API文档
旗舰版标准版智能特性
旗舰版标准版智能特性
🤖 AI Support​​
  1. 发票助手PC端对接
  • 整体介绍
  • 对接约定
  • 授权
    • 获取AccessToken
      POST
  • 开票
    • 产品介绍
    • 开发指南
    • 税控&数电同步开票
      • 业务场景下接口调用顺序
      • 1.01.读取税盘信息(czlx-7)
      • 1.02 .读取票种信息(czlx-30)
      • 1.03.发票开具(czlx-3)
      • 1.04.发票作废(czlx-6)
      • 1.05.发票查询(czlx-5)
      • 1.06.发票打印(czlx-4)
      • 1.07.专用发票申请红字信息表(czlx-20)
      • 1.08.查询专用发票申请红字信息表(czlx-18)
      • 1.09.批量打印(czlx-32)
      • 1.11.机动车销售统一发票开具(czlx-40)
      • 1.12.机动车销售统一发票查询(czlx-41)
      • 1.13.机动车销售统一发票红冲(czlx-42)
      • 1.15.核定票种查询(czlx-51)
      • 1.21.二手车-发票开具(czlx-43)
      • 1.22.二手车-发票查询(czlx-44)
      • 1.23.二手车-发票红冲(czlx-45)
      • 1.30 .查询授信额度接口(czlx-122)
      • 2.01.电子发票开具(czlx-110) ，【注】开数电票请对接：1.03.发票开具(czlx-3)
      • 2.02.电子发票信息查询(czlx-113)
      • 2.03.电子发票红冲 （只支持全额红冲）(czlx-114)
      • 2.04.刷新PDF(czlx-115)
      • 2.05.查询电子发票余量(czlx-116)
      • 3.01.查询税收分类编码信息(czlx-504)
      • 3.03.获取打印机列表(czlx-901)
    • 数电异步开票
      • 异步开票-v4
      • 查询异步开票结果-v4
    • 扫码开票
      • 上传销售单模式扫码开票
        • 接入指南
        • 1.token获取
        • 2.上传发票销售单接口
        • 3.回推接口地址
      • 自定义扫码开票
        • 接入指南
        • 1.对接方按规则组装二维码链接
        • 2.查询开票明细
        • 3.回推接口地址
    • 企业级-发票云销项查询
      • 根据业务条件查询当前企业的销项发票
  • 收票
    • 开发指南
    • 发票数据规范
    • 发票数据
      • 机动车发票数据
      • 火车票数据
      • 火车票退票凭证数据
      • 财政电子票据数据
      • 客运票/轮船票数据
      • 其他发票数据
      • 完税证明数据
      • 飞机票数据
      • 数电票（铁路电子客票）数据
      • 数电票（航空运输电子客票行程单）数据
      • 数电票（专票/普票)数据
      • 的士票数据
      • 定额发票数据
      • 通用机打(纸质/电子)发票数据
      • 过路过桥费数据
      • 二手车票数据
      • 专票和普票数据
      • 通行费发票数据
      • 海关缴款书数据
      • 发票文件数据
    • 企业级-发票云进项查询
      • 根据业务条件查询当前企业采集的发票
      • 根据代码号码查询当前企业采集的发票
      • 根据开票时间范围和采集时间范围查询当前企业采集的发票
      • 根据发票流水号或者发票代码号码查询当前企业采集的发票
      • 根据业务条件查询指定用户采集的发票
    • 税盘&数电票下载
      • 开发指南
      • 1、获取税款所属期信息
      • 2、进项发票表头采集
      • 3、发票不抵扣勾选
      • 4、海关缴款书抵扣勾选（税盘模式不支持）
      • 5、海关缴款书不抵扣勾选（税盘模式不支持）
      • 6、海关缴款书表头采集（税盘模式不支持）
      • 7、全量发票查询
      • 8、当前统计查询
      • 9、历史统计查询
      • 10、生成统计表
      • 11、撤销统计表
      • 12、确认统计表
      • 13、获取当前已勾选或往期已认证发票（税盘模式不支持）
      • 14、当期已勾选或往期已认证缴款书（税盘模式不支持）
      • 15、发票抵扣勾选
    • 电子凭证解析
      • billTypeCode表
      • 解析 + 验签 指定文件的xbrl信息
      • xbrl字符串转json
      • json转xbrl字符串
    • 发票异步下载
      • 进项全量发票采集-异步申请
      • 进项全量发票采集-异步结果查询
    • 发票数据规范
  • 查验识别
    • 开发指南
    • 发票查验（单张）
    • 发票查验（多张异步）
    • 发票识别+查验（单张）
    • 发票识别（多张）
    • 发票识别+查验（多张）
    • 数电票文件识别+查验
    • 返回状态码
  • 报销
    • 发票助手移动端-h5对接
    • 发票助手移动端-小程序对接
    • 第三方发票报销查询
    • 发票助手PC端对接
      • 对接流程
      • JS建立连接通道
      • 采集发票
      • 后端建立通道
      • 查看发票
      • 编辑单张发票
      • 分录操作
      • 常见问题
      • 获取userKey
        POST
      • 获取linkKey
        POST
      • 缓存单据
        POST
      • 保存单据
        POST
      • 更新单据状态
        POST
      • 根据发票流水号获取发票详细数据
        POST
      • 根据userkey查询单据下所有发票列表
        POST
      • 删除单据
        POST
      • 再次查验
        POST
      • 回写入账信息
        POST
      • 删除入账信息
        POST
  • 影像
    • 开发指南
    • 对接约定
    • 影像系统对接
    • 授权
      • 获取AccessToken(影像系统)
  • 档案
    • 异构系统接口定义
    • 发票返结构体
  1. 发票助手PC端对接

获取userKey

测试环境(除税控、数电和扫码开票外的接口）
https://api-dev.piaozone.com/test
测试环境(除税控、数电和扫码开票外的接口）
https://api-dev.piaozone.com/test
POST
/m4/fpzs/getUserKey

获取userKey#

请求#

billType参数#

默认值为""，即默认费用单据
参数值备注
Tra智能差旅行程单据
Pur智能物品采购单据
BizOut智能对公单据
""费用单据传空字符串

ticketParam 参数规则顺序#

0 不允许 1 允许 ，默认值为00001
顺序校验内容备注
第1位重复报销已被单据占用的发票是否允许导入
第2位购方抬头发票抬头与企业名称不一致的发票是否允许导入
第3位购方税号发票抬头与税号不一致发票是否允许导入
第4位发票验真发票查验不通过的发票是否允许导入
第5位个票个人发票是否允许导入
返回状态码(errcode)见：《返回状态码》的附录2

请求参数

Header 参数
Content-Type
string 
必需
示例值:
application/json
Body 参数application/json
timestamp
string 
时间戳
必需
用于签名验证，从1970年1月1日到当前的毫秒数
<= 13 字符
client_id
string 
发票云授权标识
必需
通常随着激活邮件下发
<= 20 字符
eid
string 
用户ID
必需
对接系统的用户ID，例如是金蝶云星空，就传一个星空的用户的唯一id，后续用于发票查询、区分发票归属等场景
<= 80 字符
sign
string 
签名
必需
签名, 签名规则根据加密方式来定，详情见对接约定中的签名规则部分
<= 100 字符
encType
string 
签名类型
可选
签名加密类型 0：MD5、1：SHA256、2：HMAC SHA256，不传默认MD5加密
<= 1 字符
默认值:
0
billNumber
string 
单据编号
必需
用于页面展示，没有实际意义
<= 80 字符
bxd_key
string 
单据ID
必需
用于区分单据唯一，可以使用一些唯一算法生成，每个单据务必不重复，重复则视为同一个单据
<= 50 字符
random
string 
链接ID
必需
JS建立通道时用来链接的通话ID
<= 35 字符
ticketParam
string 
合规性校验设置
必需
格式如：11011
<= 5 字符
默认值:
00001
billType
string 
单据类型
可选
默认值为""，即默认费用单据。 Tra 智能差旅行程单据，Pur 智能物品采购单据 ， BizOut |智能对公单据
<= 16 字符
branch_id
string 
分录ID
可选
指定查看分录的ID，用于分录编辑和查看时必须传入
<= 50 字符
invoiceSerialNos
string 
限制发票流水号
可选
再次打开采集界面时，指定只查看单据下的某下发票。默认全查看，传空字符串则都不查看
attachmentSerialNos
string 
限制附件流水号
可选
再次打开采集界面时，指定只查看单据下的某下附件。默认全查看，传空字符串则都不查看
tin
string 
企业税号
可选
用于后续合规性校验-发票购方税号是否一致
<= 20 字符
ghf_mc
string 
企业名称
可选
用于后续合规性校验-发票购方抬头是否一致
<= 100 字符
buyerAccount
string 
专票开户行账号
可选
用于后续合规性校验-专票开户行账号是否一致
<= 150 字符
buyerAddressPhone
string 
专票地址电话
可选
用于后续合规性校验-专票地址电话是否一致
<= 512 字符
salerName
string 
销方名称
可选
用于后续合规性校验-销方名称是否一致
<= 100 字符
salerTaxNo
string 
销方税号
可选
用于后续合规性校验-销方税号是否一致
<= 20 字符
relevanceExpenseId
string 
关联单据ID
可选
一个流程需要多个单据的时候，可能会出现一张发票绑定多个单据无需校验重复报销的场景，这时候可以传关联单据ID
<= 50 字符
示例
{
    "timestamp": "string",
    "client_id": "string",
    "eid": "string",
    "sign": "string",
    "encType": "0",
    "billNumber": "string",
    "bxd_key": "string",
    "random": "string",
    "ticketParam": "00001",
    "billType": "string",
    "branch_id": "string",
    "invoiceSerialNos": "string",
    "attachmentSerialNos": "string",
    "tin": "string",
    "ghf_mc": "string",
    "buyerAccount": "string",
    "buyerAddressPhone": "string",
    "salerName": "string",
    "salerTaxNo": "string",
    "relevanceExpenseId": "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://api-dev.piaozone.com/test/m4/fpzs/getUserKey' \
--header 'Content-Type: application/json' \
--data-raw '{
    "timestamp": "string",
    "client_id": "string",
    "eid": "string",
    "sign": "string",
    "encType": "0",
    "billNumber": "string",
    "bxd_key": "string",
    "random": "string",
    "ticketParam": "00001",
    "billType": "string",
    "branch_id": "string",
    "invoiceSerialNos": "string",
    "attachmentSerialNos": "string",
    "tin": "string",
    "ghf_mc": "string",
    "buyerAccount": "string",
    "buyerAddressPhone": "string",
    "salerName": "string",
    "salerTaxNo": "string",
    "relevanceExpenseId": "string"
}'

返回响应

🟢200成功
application/json
Body
errcode
string 
响应码
必需
0000成功，其他失败
description
string 
描述
必需
traceId
string 
追踪ID
必需
用于出现异常，发票云定位日志使用
data
object 
数据
必需
userKey
string 
授权key
必需
<= 32 字符
示例
{
    "errcode": "0000",
    "description": "操作成功",
    "data": {
        "userKey": ""
    },
    "traceId": ""
}
修改于 2025-05-29 09:22:08
上一页
常见问题
下一页
获取linkKey
Built with