发票查验版式文件下载结果查询

接口描述

该接口用于数电发票查验版式文件下载结果查询。可用过查验时返回的bswjxzTaskId进行结果查询，也可通过单个或多个全电发票号码进行结果查询。

💡

注意：taskId在获取过三次结果成功后即失效。
使用qdfphm或qdfphmList查询结果成功一次对应的最近一条任务记录的taskId也失效。
taskId失效后无法再次通过本结果获取版式文件记录！如需获取，需要重新发起查验+版式文件下载任务。

错误码

错误代码	错误信息	说明
BusinessVerification	未查询到对应的发票查验版式文件下载记录发票查验版式文件已过期，请重新下载！发票查验版式文件已取走，请重新下载！	请重新发起下载任务！
CheckBswjxzException	任务执行超时获取版式文件失败，请重试获取版式文件超时，请重试	请联系管理员
CheckAuthorityVerification	无权限错误码	请检查购方税号是否已订购查验扩展版产品
CheckTaxLoginInfoError	登录信息有误错误码	请检查购方税号登录信息是否正确
CheckTaxLoginFailed	登录失败错误码	请重新发起下载任务！

请求参数

Header 参数

access_token

string

必需

通过调用access_token接口返回的access_token值

示例值:

req_date

string

必需

当前时间转为的毫秒数

示例值:

req_sign

string

签名算法得到的签名

必需

示例值:

Content-Type

string

可选

默认值:

application/json

Body 参数application/json

taskId

string | null

查验结果返回的bswjxzTaskId

可选

taskIdList

array[string] | null

查验结果返回的bswjxzTaskId组成的任务id列表

可选

qdfphm

string | null

全电发票号码（数电发票号码）

可选

qdfphmList

array[string] | null

全电发票号码列表

可选

注：taskId、taskIdList、qdfphm、qdfphmList任选其中一种方式进行结果查询均可，但不可都为空。

示例

//通过taskId查询版式文件下载结果
{
    "taskId": 531928300933248
}
// 通过taskIdList查询版式文件下载结果
{
    "taskIdList": [
        544284508953347,
        544284508945152,
        544284508953344
    ]
}
//通过全电发票号码查询版式文件下载结果
{
    "qdfphm": "24****************04"
}
//通过全电发票号码列表查询版式文件下载结果
{
    "qdfphmList": [
        "24****************04",
        "24****************05",
        "24****************06"
    ]
}

返回响应

🟢200成功

application/json

Body

reqId

string

请求id

必需

由服务器端生成的唯一标识，对应每次请求。排查接口异常时，可提供该字段方便定位

code

string | null

错误码

必需

错误码

success

boolean

是否成功标记

必需

接口是否成功（是否发生业务异常）

message

string | null

错误信息

必需

data

array [object {12}] | null

业务数据

可选

qdfphm

string

数电发票号码

必需

kprq

string <yyyy-MM-dd HH:mm:ss> | null

开票日期

可选

仅当任务成功时返回精准的时分秒，任务失败仅返回精确到年月日，时分秒都为0

jshj

number | null

价税合计

可选

fplx

string | null

发票类型

可选

仅当任务成功时返回，任务失败时不返回

pdfUrl

string | null

pdf版式文件url

可选

ofdUrl

string | null

ofd版式文件url

可选

xmlUrl

string | null

xml版式文件url

可选

ewmUrl

string | null

ewm二维码地址url

已废弃

enum<string> | enum<null>

查验版式文件下载的任务执行状态

可选

1-申请处理中；2-申请处理失败；3-申请处理完成；

枚举值:

123

示例值:

code

string | null

错误码

可选

仅当任务状态为失败，即zt=2时不为空

message

string | null

错误信息

可选

仅当任务状态为失败，即zt=2时不为空

chargingNsrsbh

string | null

计费纳税人识别号

可选

仅当开通税号版发票查验版式文件下载产品时返回值

示例

成功示例发票查验版式文件已过期发票查验版式文件已取走新增kprq、fplx、jshj返回示例

{
  "reqId": "df46cccec9cb4b3db93c6f266d71c25d",
  "code": "2000",
  "success": true,
  "message": null,
  "data": [
    {
      "qdfphm": "24********************04",
      "zt": "3",
      "code": null,
      "message": null,
      "ofdUrl": "http://qxy-oss-robot-product.oss-cn-beijing.aliyuncs.com/0708872f7d0892a86ac409f5380e0d24.ofd?***************",
      "pdfUrl": "http://qxy-oss-robot-product.oss-cn-beijing.aliyuncs.com/b8a3b049dedeea9e43d332add31a7b52.pdf?***************",
      "xmlUrl": "http://qxy-oss-robot-product.oss-cn-beijing.aliyuncs.com/dzfp_24332000000122959604_20240520171423.xml?***************"
    }
  ]
}

🟢200失败

发票查验版式文件下载结果查询

接口描述#

错误码#

请求参数

返回响应

接口描述

错误码