发起归集任务
1、接口描述
该接口用于发起企业进销项发票归集任务
2、接口地址
POST /v1/invoice/collectTask HTTP/1.1
3、请求参数
- 参数说明
请求参数为JSON格式。
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| nsrsbh | String | 是 | 企业纳税人识别号，必填 |
| fplx | String | 否 | 发票类型代码，非必填，不填时默认全部,传多个类型时以','进行分割 |
| jxxbz | String | 否 | 进销项标志，非必填，不填时默认全部，格式 jx 进项 xx 销项 |
| kpyfq | Integer | 是 | 开票月份起，必填，202011，格式yyyyMM |
| kpyfz | Integer | 是 | 开票月份止，必填，202011，格式yyyyMM |
- 示例参数
{
"nsrsbh":"914xxxxxxxxT0X",
"fplx": "04,01",
"jxxbz":"jx",
"kpyfq":"202304",
"kpyfz":"202304"
}
4、返回结果
- 返回结果
返回结果为JSON格式。
{
"result": {
"req_id": "33dec691be234bee836c3871366ef635", --日志ID
"success": true,
"time": 26893,
"timestamp": 1687950067388
},
"value": {
"code": "2000", --请求状态
"data": {
"taskId": 473570171392320 --任务ID
},
"message": "success" -- 请求信息
}
- 字段说明
| 字段名 | 说明 |
|---|---|
| code | 请求状态 |
| taskId | 任务ID |
| message | 请求信息 |
查询归集任务状态
1、接口描述
该接口用于查询发票归集任务的状态
2、接口地址
POST /v1/invoice/collectTaskStatus HTTP/1.1
3、请求参数
- 参数说明
请求参数为JSON格式。
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| taskId | Integer | 是 | 任务ID，申请接口申请成功后返回。 |
| nsrsbh | String | 是 | 纳税人识别号 |
- 示例参数
{
"taskId" : 473570171392320,
"nsrsbh" : "1233123123132"
}
4、返回结果
返回结果为JSON格式。
{
"result": {
"req_id": "531b115bb33b4ec8974507867bd20b08",
"success": true,
"time": 57,
"timestamp": 1687950440259
},
"value": {
"jsonUrl": "", -- 发票信息oss下载地址
"kpyfq": 202304, -- 开票时间起
"updateTime": "2023-06-28 18:07:33",
"jxxbz": "jx", -- 进销项标志
"kpyfz": 202304, -- 开票时间止
"collectType": "FPYXZ101",
"nsrsbh": "91440300MA5F0KPT0X", -- 纳税人识别号
"createTime": "2023-06-28 18:07:33", -- 发起时间
"failCode": "2000",
"failMsg": "success",
"appKey": 10001999,
"id": 473563642954048, -- 任务id
"fplxStr": "01,03,04,08,10,11,14,15,17,81,82,84,85", -- 票种
"status": "3" -- 任务状态
}
}
- 字段说明
| 字段名 | 说明 |
|---|---|
| jsonUrl | 发票信息oss下载地址 |
| kpyfq | 开票月份起 |
| jxxbz | 进销项标志，jx 进项 xx 销项 |
| kpyfz | 开票月份止 |
| nsrsbh | 纳税人识别号 |
| createTime | 发起时间 |
| id | 任务id |
| fplxStr | 票种 |
| status | 任务状态 1 进行中 2 失败 3 成功 |
获取发票数据
1、接口描述
该接口用于归集企业近5年内的进销项发票 需要在归集任务处理成功之后调用
2、接口地址
POST /v1/invoice/getCollectTaskPageData HTTP/1.1
3、请求参数
- 参数说明
请求参数为JSON格式。
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| taskId | Integer | 是 | 任务ID，申请接口申请成功后返回。 |
| nsrsbh | String | 是 | 纳税人识别号 |
| page | Object | 否 | 分页信息，可选，不传返回所有数据 |
分页信息说明
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| pageSize | Integer | 分页大小 |
| currentPage | Integer | 当前页 |
- 示例参数
{
"taskId" : 473570171392320,
"nsrsbh" : "12312312313",
"page": {
"pageSize": 20,
"currentPage": 1
}
}
4、返回结果
返回结果为JSON格式。
-- 发票数据获取成功，发票量小于2M
{
"result": {
"success": true,
"req_id": "1cdf815588484bc1a8206f3f71615110",
"timestamp": 1687950112866,
"time": 413
},
"value": {
"code": "2000",
"message": "",
"jsonUrl": "http://xxxx.txt", -- 文件下载链接
"data": {
"list": [ -- 发票List
{
"xfsbh": "914413xxxxx5277",-- 销方识别号
"gfsbh": "91440xxxxxKPT0X", -- 购方识别号
"fpdm": "0440xxxxxx11", -- 发票代码
"jxxbz": "xx", -- 进销项标志
"gfmc": "深圳xxxxxx件有限公司",-- 购方名称
"fplx": "10" ,-- 发票类型
"kpr": "陈贵琼",-- 开票人
"se": 19.32,-- 税额
"kprq": "2023-04-30 00:00:00",-- 开票日期
"bz": "发票单号：zmfp202xxxxx2403952591", -- 备注
"jshj": 167.91,-- 加税合计
"je": 148.59, -- 金额
"fpztDm": "0", -- 发票状态代码
"xfmc": "惠州大xxxxxxx有限公司", -- 销方名称
"tspzDm": "", -- 特殊票种代码，02农产品收购发票 08成品油发票
"hwxx": [ -- 货物信息
{
"ggxh": "", -- 规格型号
"fpdm": "044xxxxx11",-- 发票代码
"jldw": "升", -- 计量单位
"dj": "6.87606100",-- 单价
"mxxh": "1",-- 明细序号
"se": 23.01,-- 税额
"mc": "*汽油*92号车用汽油(VIB)",-- 名称
"sl": "25.74002600",-- 数量
"je": 176.99, -- 金额
"slv": 0.13,-- 税率
"spbm": "1070101010100000000",-- 商品编码
"fphm": "6xxxxx0",-- 发票号码
"lslbs": "" --- 空：非零税率，0：出口零税，1：免税，2：不征税，3 普通零税率
},
{
"ggxh": "",
"fpdm": "04xxxxxxxx11",
"jldw": "",
"dj": "",
"mxxh": "2",
"se": -3.69,
"mc": "*汽油*92号车用汽油(VIB)",
"sl": "",
"je": -28.4,
"slv": 0.13,
"spbm": "1070101010100000000",
"fphm": "68399780",
"lslbs": "" --- 空：非零税率，0：出口零税，1：免税，2：不征税，3 普通零税率
}
],
"fphm": "68399780" -- 发票号码
}
]
}
}
}
-- 发票数据获取成功，发票数据大于2M
{
"result": {
"success": true,
"req_id": "1cdf815588484bc1a8206f3f71615110",
"timestamp": 1687950112866,
"time": 413
},
"value": {
"code": "2000",
"message": "",
"jsonUrl": "http:xxxxxxxxxx.txt", -- 发票数据下载地址
"data": { -- 发票数据大于2M时data中不返回具体发票数据
"list": [
]
}
}
}
-- 发票数据获取成功，无发票数据
{
"result": {
"success": true,
"req_id": "1cdf815588484bc1a8206f3f71615110",
"timestamp": 1687950112866,
"time": 413
},
"value": {
"code": "2000",
"message": "暂无发票数据",
"jsonUrl": "",
"data": {
"list": [
]
}
}
}
-- 发票数据获取异常
{
"result": {
"success": true,
"req_id": "1cdf815588484bc1a8206f3f71615110",
"timestamp": 1687950112866,
"time": 413
},
"value": {
"code": "9999",
"message": "获取发票数据异常",
"jsonUrl": "",
"data": null
}
}