申请数电票版式文件下载
1、接口描述
该接口用于申请数电发票版式文件，可通过该接口批量申请已开具和取得的数电发票 xml、 pdf 、ofd版式文件
2、接口地址
POST /v1/FP/applyLayoutFile HTTP/1.1
3、请求参数
- 参数说明
请求参数为JSON格式。
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| nsrsbh | String | 是 | 企业纳税人识别号，必填 |
| kpyf | Integer | 是 | 开票月份，必填，202011，格式yyyyMM |
| jxxbzs | List |
否 | 进销项标识列表，jx 进项，xx 销项 不填默认全部 |
| fplxs | List |
否 | 【81 电子发票（增值税专票，82电子发票（普通发票），61全电发票（航空运输电子客票行程单），83全电发票（铁路电子客票）】 |
| addJob | boolean | 否 | 是否发起下载任务，第一次调用接口传入 true 发起任务，之后定时调用接口传入 false 获取状态，直到接口返回处理成功或者失败，返回成功调用发票归集接口 |
- 示例参数
{
"nsrsbh": "xxx",
"kpyf": 202011,
"jxxbzs": ["jx", "xx"],
"fplxs": ["81", "82"]
}
4、返回结果
- 返回结果
返回结果为JSON格式。
{
"result": {
"success": true,
"req_id": "b763b8603aa34dcb874e16fc31e22d28",
"timestamp": 1606804799800,
"time": 170
},
"value": [{ -- 任务状态列表
"jxxbz": "jx", -- 进销项标识
"fplx": "81", -- 发票类型代码
"status": "processed", -- 状态,
"kpyf": 202306,
"msg": "", -- 提示信息
"time": "2020-11-30 14:25:09", -- 时间
"errorCode": "" -- 发票任务异常状态代码,
"nsrsbh": "34JK3E89J9S1234124"
}]
}
//失败返回结果
{
"result": {
"req_id": "f7005a7d9351462e8d5c569d4f36124c",
"success": false,
"time": 41,
"timestamp": 1670323665906
},
"error": {
"code": "xxxx",
"message": "xxx"
}
}
- 字段说明
| 字段名 | 说明 |
|---|---|
| status | 任务状态代码 |
| msg | 当任务状态返回失败时，说明失败原因 |
| errorCode | 发票任务异常状态代码 |
| downloadUrl | 发票源文件(有效期一个月) |
5、错误码
| 错误代码 | 错误消息 | 状态码 |
|---|---|---|
| 无 | 无 | 无 |
获取数电票版式文件数据
1、接口描述
该接口用于获取企业进销项数电票的版式文件数据， 需要申请下载版式文件任务处理成功之后调用
2、接口地址
POST /v1/FP/getLayoutFile HTTP/1.1
3、请求参数
- 参数说明
请求参数为JSON格式。
| 参数名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| nsrsbh | String | 是 | 企业纳税人识别号，必填 |
| kpyf | Integer | 是 | 开票月份，必填，202011，格式yyyyMM |
| jxxbz | String | 是 | 进销项标识，必填，jx 进项，xx 销项 |
| fplx | String | 是 | 【81 电子发票（增值税专票，82电子发票（普通发票），61全电发票（航空运输电子客票行程单），83全电发票（铁路电子客票）】 |
| page | Object | 否 | 分页信息，可选，不传返回所有数据 |
分页信息说明
| 参数名称 | 参数类型 | 说明 |
|---|---|---|
| pageSize | Integer | 分页大小 |
| currentPage | Integer | 当前页 |
- 示例参数
{
"nsrsbh": "xxx",
"kpyf": 202011,
"jxxbz": "jx",
"fplx": "81",
"page": {
"pageSize": 20,
"currentPage": 1
}
}
4、返回结果
返回结果为JSON格式。
81 电子发票（增值税专票） 返回实例及字段说明
{
"result": {
"req_id": "bf78fdf024dc4c4fa23b2a8cd3d10a98",
"success": true,
"time": 462,
"timestamp": 1686894530458
},
"value": {
"page": {
"totalPage": 1,
"pageSize": 20,
"currentPage": 1,
"totalCount": 2
},
"list": [{
"xfsbh": "", --销方税号
"kpyf": , --开票月份
"gfmc": "", --购方名称
"sdphm": "", --数电票号码
"se": , --税额
"kprq": "", --开票日期 格式 yyyy-MM-dd HH:mm:ss
"xml": "", --XML版式文件下载地址
"fpztDm": "", --发票状态代码
"gfsbh": "", --购方税号
"ofd": "", --OFD版式文件下载地址
"pdf": "", --PDF版式文件下载地址
"jshj": , --价税合计
"je": , --金额
"xfmc": "", --销方名称
}, {
"xfsbh": "34JK3E89J9S1234124",
"kpyf": 202305,
"gfmc": "xxxxxxxxxxx有限公司",
"sdphm": "23442000000072899511",
"se": 224.04,
"kprq": "2023-05-23 15:47:57",
"xml": "",
"fpztDm": "01",
"gfsbh": "34JK3E89J9S1234125",
"ofd": "",
"pdf": "",
"jshj": 3958.0,
"je": 3733.96,
"xfmc": "***********有限公司",
}]
}
}
82电子发票（普通发票）返回示例及字段说明
{
"result": {
"req_id": "a508f673f2384a9f8e72b7bc72b83195",
"success": true,
"time": 113,
"timestamp": 1686895786270
},
"value": {
"page": {
"totalPage": 1,
"pageSize": 20,
"currentPage": 1,
"totalCount": 2
},
"list": [{
"xfsbh": "34JK3E89J9S1234124", --销方税号
"kpyf": 202305, --开票月份
"gfmc": "xxxxxxxxxxxx有限公司", --购方税号
"sdphm": "23442000000072899511", --数电票号码
"se": 0.0, --税额
"kprq": "2023-05-15 11:05:52", --开票日期
"xml": "",--XML版式文件下载地址
"fpztDm": "01", --发票状态代码
"gfsbh": "34JK3E89J9S1234125",--购方税号
"ofd": "",--OFD版式文件下载地址
"pdf": "",--PDF版式文件下载地址
"jshj": 7880.0, --价税合计
"je": 7880.0, --金额
"xfmc": "**************分公司",--销方名称
},{
"xfsbh": "34JK3E89J9S1234124", --销方税号
"kpyf": 202305, --开票月份
"gfmc": "xxxxxxxxxxxx有限公司", --购方税号
"sdphm": "23442000000072899511", --数电票号码
"se": 0.0, --税额
"kprq": "2023-05-15 11:05:52", --开票日期
"xml": "",--XML版式文件下载地址
"fpztDm": "01", --发票状态代码
"gfsbh": "34JK3E89J9S1234125",--购方税号
"ofd": "",--OFD版式文件下载地址
"pdf": "",--PDF版式文件下载地址
"jshj": 7880.0, --价税合计
"je": 7880.0, --金额
"xfmc": "**************分公司",--销方名称
}]
}
}
//失败返回结果
{
"result": {
"req_id": "f7005a7d9351462e8d5c569d4f36124c",
"success": false,
"time": 41,
"timestamp": 1670323665906
},
"error": {
"code": "xxxx",
"message": "xxx"
}
}
- 字段说明
| 字段名 | 说明 |
|---|---|
| fpztDm | 发票状态代码 |
5、错误码
| 错误代码 | 错误消息 | 状态码 |
|---|---|---|
| 无 | 无 | 无 |