发票查询接口
需授权 2019/7/22 预计阅读时间: 34 分钟公共参数
名称 | 说明 |
---|---|
appCode | 由电子发票平台分配的 appCode |
cmdName | chinaeinv.api.invoice.v3.cx |
sign | 数字签名字符串,调用方需要使用电子发票服务平台供的数字证书对 请求报文进行签名并作 Base64 编码,生成数字签名字符串 |
请求参数说明
名称 | 类型 | 必传 | 长度 | 描述 |
---|---|---|---|---|
serialNo | String | 是 | 50 | 操作流水号。查询时不检查重复性。 |
postTime | String | 是 | 19 | 请求发送时间。格式为yyyy-MM-dd HH:mm:ss。 |
criteria | Array | 是 | 查询条件列表。 | |
├ name | String | 是 | 查询条件名称,详见下表中的查询方式说明。 | |
└ value | String | 是 | 查询条件值,详见下表中的查询方式说明。 |
参数值:
查询方式 | name | value |
---|---|---|
根据发票编号查询 | invoiceCode | 发票代码+发票号码 |
根据订单编号查询 | orderNo | 订单编号 |
根据操作流水号单个查询 | singlesSerialNo | 单个操作流水号 |
返回参数说明
名称 | 类型 | 描述 |
---|---|---|
serialNo | String | 操作流水号。 |
postTime | String | 响应发送时间。格式为yyyy-MM-dd HH:mm:ss。 |
code | String | 处理结果代码。 |
message | String | 处理结果消息。 |
invoices | Array | 发票信息列表。 |
├ orderNo | String | 订单编号。 |
├ taxpayerName | String | 销货方名称。 |
├ taxpayerCode | String | 销货方纳税人识别号。 |
├ taxpayerAddress | String | 销货方地址。 |
├ taxpayerTel | String | 销货方电话。 |
├ taxpayerBankName | String | 销货方开户银行。 |
├ taxpayerBankAccount | String | 销货方银行账号。 |
├ customerName | String | 购货方名称。 |
├ customerCode | String | 购货方纳税人识别号。 |
├ customerAddress | String | 购货方地址。 |
├ customerTel | String | 购货方电话。 |
├ customerBankName | String | 购货方开户银行。 |
├ customerBankAccount | String | 购货方银行账号。 |
├ code | String | 发票代码+发票号码。(开票类型为增值税发票时后8位为发票号码,其余为发票代码;开票类型为数电发票(数电发票)时是20位的发票号码) |
├ checkCode | String | 校验码。(开票类型为数电发票时,无此字段) |
├ fiscalCode | String | 税控码。 |
├ status | String | 发票状态 1:正常 3:红冲 4:被红冲。 |
├ generateTime | String | 开票日期 格式为yyyy-MM-dd HH:mm(蓝字发票、红字发票发票开具的时间)。 |
├ totalAmount | Number | 税价合计金额。 |
├ noTaxAmount | Number | 不含税金额。 |
├ taxAmount | Number | 税额。 |
├ drawer | String | 开票人。 |
├ payee | String | 收款人。(开票类型为数电发票时,无此字段) |
├ reviewer | String | 复核人。(开票类型为数电发票时,无此字段) |
├ remark | String | 发票备注。 |
├ pdfUrl | String | PDF文件下载地址。 |
├ viewUrl | String | 发票查看地址。 |
├ xmlUrl | String | xml文件下载地址(仅数电发票支持) |
├ ofdUrl | String | odf文件下载地址(仅数电发票和电子专用发票支持) |
├ ewmUrl | String | 电子税局二维码交付地址(仅数电发票支持) |
├ relatedCode | String | 关联发票代码+号码。如果发票被冲红,则与被冲红发票相互关联。 |
├ validReason | String | 冲红原因。 |
├ validTime | String | 冲红时间(指红冲发票的税控时间,在红字发票中和上面的generateTime是同一个)。 |
└ items | Array | 发票项目明细列表。 |
├ type | String | 发票行性质 0 正常行、1 折扣行、2 被折扣行。 |
├ code | String | 商品编码。 |
├ name | String | 商品名称。带商品税收分类编码简称,例如:开票时传入商品名称为“水费”,则这里会返回“水冰雪水费”,详见《国家税务总局公告2017年第45号》第一条。 |
├ spec | String | 规格型号。 |
├ price | Number | 商品单价。 |
├ quantity | Number | 数量。 |
├ uom | String | 单位。 |
├ taxRate | Number | 税率。 |
├ amount | Number | 税价合计金额。 |
├ noTaxAmount | Number | 不含税金额。 |
├ taxAmount | Number | 税额。 |
├ catalogCode | String | 商品分类编码。 |
├ preferentialPolicyFlg | String | 优惠政策标识。 |
├ addedValueTaxFlg | String | 增值税特殊管理。 |
└ zeroTaxRateFlg | String | 零税率标识。 |
extendedParams | Object | 开票或冲红时传入的扩展参数。 |
请求报文示例
{
"criteria": [{
"name": "singlesSerialNo",
"value": "发票开具或者发票冲红的操作流水号"
}],
"postTime": "请求发送时间。格式为yyyy-MM-dd HH:mm:ss。",
"serialNo": "发票查询的操作流水号"
}
响应报文示例
{
"serialNo": "操作流水号",
"postTime": "响应发送时间。格式为yyyy-MM-dd HH:mm:ss。",
"code": "处理结果代码",
"message": "处理结果消息",
"invoices": [
{
"code": "发票代码+发票号码",
"totalAmount": "税价合计金额",
"customerName": "购货方名称,即发票抬头",
"customerCode": "购货方纳税人识别号",
"customerAddress": "购货方地址",
"customerTel": "购货方电话",
"customerBankName": "购货方开户银行",
"customerBankAccount": "购货方银行账号",
"taxpayerName": "销货方名称",
"taxpayerCode": "销货方纳税人识别号",
"taxpayerAddress": "销货方地址",
"taxpayerTel": "销货方电话",
"taxpayerBankName": "销货方开户银行",
"taxpayerBankAccount": "销货方银行账号",
"drawer": "开票人",
"payee": "收款人",
"reviewer": "复核人",
"checkCode": "校验码",
"fiscalCode": "税控码",
"generateTime": "生成时间",
"status": "发票状态。正常:1;红冲:3;被红冲:4。",
"noTaxAmount": "不含税金额",
"taxAmount": "税额",
"relatedCode": "关联发票代码+号码",
"validReason": "冲红原因",
"validTime": "冲红时间",
"viewUrl": "查看URL",
"pdfUrl": "PDF下载URL",
"remark": "发票备注",
"orderNo": "订单编号",
"items": [
{
"amount": "税价合计金额",
"noTaxAmount": "不含税金额",
"taxAmount": "税额",
"code": "商品编码",
"name": "商品名称",
"price": "商品单价",
"quantity": "数量",
"taxRate": "税率",
"uom": "单位",
"type": "发票行性质 0 正常行、1 折扣行、2 被 折扣行。",
"spec": "规格型号",
"catalogCode": "商品分类编码",
"preferentialPolicyFlg": "优惠政策标识",
"addedValueTaxFlg": "增值税特殊管理",
"zeroTaxRateFlg": "零税率标识"
}
]
}
],
"extendedParams": {
"扩展参数1的key": "扩展参数1的value",
"扩展参数2的key": "扩展参数2的value"
}
}
返回错误说明
代码 | 说明 |
---|---|
0 | 处理成功。 |
1 | 系统内部错误,如出现该错误请及时联系电子发票服务平台。 |
2 | 参数校验未通过,详情请参考处理结果消息。 |
3 | appCode不存在或数字证书不可用。 |
4 | 数字签名错误,请检查数字证书、字符编码格式等是否正确。 |
5 | 重复操作,即serialNo重复。 |
6 | 正在处理中。 |
400 | 纳税人不存在或不可用,可能是传入的纳税人识别号错误。 |
401 | 要冲红或者查询的发票不存在。 |