1. WebHook
1.1. 说明
向企业端业务系统推送对应订单发票状态变更消息事件，将POST消息的JSON数据包推送到业务系统提供的URL上,可同时推送多个业务系统；
1.2. 服务地址
服务地址由业务系统提供
1.3. 调用方式
POST(body)
1.4. 参数示例
{
"msgType": "SUCCESS",
"eventType": "FPKJ",
"msg": "提示信息",
"lsh": "开票请求流水号",
"timestamp": "2021-06-13T03:06:02.619+00:00",
"data": "Base64编码信息"
}
1.4.1. 参数说明
| 参数 | 参数名称 | 类型 | 长度 | 必须 | 备注 |
|---|---|---|---|---|---|
| msgType | 消息类型 | varchar | 是 | SUCCESS成功消息通知; ERROR异常消息通知； |
|
| eventType | 事件类型 | varchar | 是 | FPKJ发票开具； HZSQ红字申请； |
|
| msg | 信息 | varchar | 200 | 否 | 异常消息通知的错误信息 |
| lsh | 流水号 | varchar | 50 | 是 | 开票请求的流水号 |
| timestamp | 推送时间 | Date | 是 | 格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ | |
| data | 业务数据 | varchar | 否 | 业务JSON数据Base64编码后的字符串，具体参考推送事件数据 |
data业务JSON数据Base64解码后参数示例
发票开具成功
{
"msgType": "SUCCESS",
"eventType": "FPKJ",
"msg": "提示信息",
"lsh": "开票请求流水号",
"timestamp": "2021-06-13T03:06:02.619+00:00",
"data": "{
"fplxdm": "发票类型代码",
"fphm": "66987825",
"kprq": "2021-06-11T05:32:10.000+00:00",
"pdf": "pdf地址",
"ofd": "ofd地址",
"xml": "xml地址",
"qr": "二维码地址",
"kplx": "开票类型",
"jshj": "价税合计",
"xhdwsbh": "销货单位识别号",
"yfplxdm": "对应原蓝票发票类型代码",
"yfphm": "对应原蓝票发票号码",
"yfpdm": "对应原蓝票发票代码",
"ykprq": "对应原蓝票开票日期",
"xxbbh": "红字确认单编号",
"xxbid": "红字确认单id",
"hzqrxxztDm": "红字确认单状态"
}"
}
发票开具失败
{
"msgType": "ERROR",
"eventType": "FPKJ",
"msg": "error message",
"timestamp": "2021-06-13T03:06:02.619+00:00",
"lsh": "开票请求流水号",
"data":null
}
红字通知单申请成功
{
"msgType": "SUCCESS",
"eventType": "HZSQ",
"msg": "提示信息",
"timestamp": "2021-06-13T03:06:02.619+00:00",
"lsh": "开票请求流水号",
"data":"{
"xxbbh": "红字确认单编号",
"xxbid": "红字确认单id",
"hzqrxxztDm": "红字确认单状态",
"xhdwsbh": "销货单位识别号",
"yfplxdm": "对应原蓝票发票类型代码",
"yfphm": "对应原蓝票发票号码",
"yfpdm": "对应原蓝票发票代码",
"ykprq": "对应原蓝票开票日期"
}"
}
红字通知单申请失败
{
"msgType": "ERROR",
"eventType": "HZSQ",
"msg": "error message",
"timestamp": "2021-06-13T03:06:02.619+00:00",
"lsh": "开票请求流水号",
"data":null
}
1.4.2. data参数说明
| 序号 | 字段 | 名称 | 长度 | 类型 | 必须 | 说明 |
|---|---|---|---|---|---|---|
| 1 | fplxdm | 发票类型代码 | 2 | varchar | 否 | 81-数电票专票 82-数电票普票 |
| 2 | fphm | 发票号码 | 20 | varchar | 否 | |
| 3 | kprq | 开票日期 | Date | 否 | 格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ | |
| 4 | PDF格式下载地址 | 300 | varchar | 否 | ||
| 5 | ofd | OFD格式下载地址 | 300 | varchar | 否 | |
| 6 | xml | XML格式下载地址 | 300 | varchar | 否 | |
| 7 | qr | 二维码格式格式下载地址 | 300 | varchar | 否 | |
| 8 | kplx | 开票类型 | 1 | varchar | 否 | 0-蓝票（正数发票） 1-红票（负数发票） |
| 9 | jshj | 价税合计金额 | （18,2） | Decimal | 否 | 价税合计保留小数点后2位 |
| 10 | xhdwsbh | 销售方纳税人识别号 | 20 | varchar | 否 | |
| 11 | yfplxdm | 原发票类型代码 | 3 | varchar | 否 | 004-纸质专票 007-纸质普票 025-卷票 026-电子普票 028-电子专票 81-数电票专票 82-数电票普票 |
| 12 | yfphm | 原发票号码 | 20 | varchar | 否 | |
| 13 | yfpdm | 原发票代码 | 12 | varchar | 否 | 数电发票无 |
| 14 | ykprq | 原开票日期 | Date | 否 | 格式：yyyy-MM-dd'T'HH:mm:ss.SSSZ | |
| 15 | xxbbh | 红字确认单编号 | 20 | varchar | 否 | |
| 16 | xxbid | 红字确认单ID | 32 | varchar | 否 | |
| 17 | hzqrxxztDm | 红字确认单状态 | 2 | varchar | 否 | 01:无需确认 02:销方录入 03:购方录入待销方确认 04:购销双方已确认 05:作废（销方录入购方否认） 06:作废（购方录入销方否认） 07:作废（超72小时未确认） 08:（发起方撤销） 09:作废（确认后撤销） 10:作废（异常凭证） |
1.4.3. 返回参数说明
要求客户端接收到数据返回200.OK(HTTP状态码，不是Body内容)确认消息收到。 如果超过10s服务端未收到200确认，服务端则认为消息推送失败。失败后消息会在一个小时后重试推送，一直重试24次直到彻底失败放弃推送。