冲红发票查询请求
所有接口都要遵循接口说明的要求,请求参数放在body字段下传输,且在请求前,先要获取数据签名。
特殊说明:
当前版本纸票冲红操作不会调用税盘开票,真正的冲红操作应该在线下完成,调用接口只是将平台的纸票状态修改为已冲红,因此在调用查询接口时不会返回红票号码和红票代码等发票信息;
当前版本纸票冲红操作不会调用税盘开票,真正的冲红操作应该在线下完成,调用接口只是将平台的纸票状态修改为已冲红,因此在调用查询接口时不会返回红票号码和红票代码等发票信息;
请求地址
环境 | 请求地址 |
正式环境 | https://www.cargonpay.com/prod-api/ret/api |
测试环境 | http://221.238.46.76:9889/ret/api |
接口名称
api.invoice.query.reverse
请求参数
M–必填 O–非必填 C–一定条件下必填
序号 | 标识 | 字段名称 | 字段类型 | 要求 | 说明 |
1 | body | 查询条件 | Object[] | M | 最少1条记录 |
2 | name | 条件名称 | Varchar(100) | M | 支持传:serialNo |
3 | value | 条件值 | Varchar(25) | M |
请求示例
JSON格式
[{ "name": "serialNo", "value": "202011000002000000" }]
复制代码
响应参数
M–必填 O–非必填 C–一定条件下必填
序号 | 标识 | 字段名称 | 字段类型 | 要求 | 说明 |
1 | data | 发票信息 | Object[] | M | |
2 | serialNo | 流水号 | Varchar(30) | M | 开票流水号 |
3 | operateStatus | 操作状态码 | Varchar(1) | M | 当前操作状态状态码 |
4 | message | 操作状态说明 | Varchar(100) | M | 当前操作状态说明 |
5 | invoiceNo | 发票号码 | Varchar(50) | O | 如果发票未开立,则为空 |
6 | invoiceCode | 发票代码 | Varchar(50) | O | 如果发票未开立,则为空 |
7 | checkCode | 校验码 | Varchar(50) | O | 如果发票未开立,则为空 |
8 | fiscalCode | 税控码 | Varchar(50) | O | 如果发票未开立,则为空 |
9 | generateTime | 冲红日期 | Varchar(20) | O | 如果发票未开立,则为空;格式为:yyyy-MM-dd |
10 | currency | 币别 | Varchar(50) | M | 包含:CNY、USD |
11 | totalAmount | 税价合计金额 | Decimal(18,2) | M | 人民币金额 |
12 | noTaxAmount | 不含税金额 | Decimal(18,2) | O | 人民币金额 |
13 | taxAmount | 税额 | Decimal(18,2) | O | 人民币金额 |
14 | pdfUrl | PDF地址 | Varchar(500) | O | |
15 | viewUrl | 查看地址 | Varchar(500) | O | |
16 | cipherText | 发票密文 | Varchar(500) | O | |
17 | qrCode | 二维码 | Varchar(200) | O | |
18 | taxDeviceNo | 机器码 | Varchar(50) | O | |
19 | originalInvoiceCode | 原发票代码 | Varchar(50) | M | |
20 | originalInvoiceNo | 原发票号码 | Varchar(50) | M | |
21 | details | 发票明细 | Object[] | M | |
22 | type | 发票行性质 | Varchar(1) | M | 发票行性质 |
23 | name | 商品名称 | Varchar(90) | M | 商品名称 |
24 | spec | 规格型号 | Varchar(40) | O | 规格型号 |
25 | price | 单价 | Decimal(18,2) | O | 单价 |
26 | quantity | 数量 | Int | O | 数量:1 |
27 | uom | 单位 | Varchar(20) | O | |
28 | taxRate | 税率 | Decimal(18,6) | M | 税率:0.00 |
29 | zeroTaxrateFlag | 零税率标识 | Varchar(10) | M | 零税率标识,包含:1-免税;2-不征税;3-普通零税率 |
30 | amount | 小计 | Decimal(18,6) | M | 价税合计金额,人民币金额 |
31 | catalogCode | 商品分类编码 | Varchar(50) | M | 商品分类编码 |
32 | noTaxAmount | 不含税金额 | Decimal(18,6) | M | 不含税金额,人民币金额 |
33 | taxAmount | 税额 | Decimal(18,2) | M | 税额 |
响应示例
成功
JSON格式
[{ "serialNo": "", "invoiceNo": "", "invoiceCode": "", "checkCode": "", "operateStatus": "", "message": "", "fiscalCode": "", "generateTime": "", "currency": "", "totalAmount": "", "noTaxAmount": "", "taxAmount": "", "pdfUrl": "", "viewUrl": "", "cipherText": "", "qrCode": "", "taxDeviceNo": "", "originalInvoiceCode": "", "originalInvoiceNo": "", "details": [{ "item": "", "type": "", "name": "", "spec": "", "price": "", "quantity": "", "uom": "", "taxRate": "", "zeroTaxrateFlag": "", "amount": "", "catalogCode": "", "noTaxAmount": "", "taxAmount": "" }] }]
复制代码
失败或处理中
JSON格式
[{ "serialNo": "", "message": "", "responseTime": "" }]
复制代码
- 请求地址
- 接口名称
- 请求参数
- 请求示例
- 响应参数
- 响应示例