NFC-e
查询 NFC-e
返回状态、二维码、小票与 XML 下载链接,以及开票入参回显。
GET
/openapi/v2/empresas/{empresaId}/nfce/{nfceId}需要
token、timestamp、sign 三个签名头,参见认证与签名。路径参数
empresaId* | string | 开票主体标识 |
nfceId* | string | NFC-e 标识 |
* 必填字段
200
查询成功。
id | string | 请求标识 |
tipo | string | 单据类型 |
status | string | 单据状态 |
motivoStatus | string | 状态原因 |
ambienteEmissao | string | 开票环境 |
dataCriacao | string | 受理时间 |
dataUltimaAlteracao | string | 最后更新时间 |
| object | 订单 |
| object | 消费者 |
transporte | object | 运输信息 |
numero | string | 票号 |
serie | string | 系列号 |
dataEmissao | string | 开票时间 |
chaveAcesso | string | 访问密钥 |
dataAutorizacao | string | 授权时间 |
| object | 授权协议 |
qrCode | string | 二维码内容 |
urlConsulta | string | 按访问密钥查询的网址 |
linkDanfe | string | 小票 PDF 下载地址 |
linkDownloadXml | string | XML 下载地址 |
emitidaEmContingencia | bool | 离线应急开出标志 |
alertas | array | 授权告警 |
| array | 商品行 |
valorTotal | number | 票面总额 |
terminal | string | 收银台标识 |
status单据状态
取消受理中票仍为 Autorizada。
| 取值 | 含义 |
|---|---|
| AguardandoAutorizacao | 已受理,等待 SEFAZ 结果 |
| Autorizada | SEFAZ 已授权 |
| Negada | 被 SEFAZ 驳回,或平台后台处理失败,原因在 motivoStatus |
| Cancelada | 已取消 |
| ContingenciaPendente | SEFAZ 不可用时离线开出,平台在 SEFAZ 恢复后自动补传 |
tipo单据类型
| 取值 | 含义 |
|---|---|
| NFC-e | 电子消费者发票,固定此值 |
ambienteEmissao开票环境
| 取值 | 含义 |
|---|---|
| Homologacao | 税务局测试环境,票无法律效力 |
| Producao | 正式环境 |
pedido.presencaConsumidor消费者在场方式
| 取值 | 含义 |
|---|---|
| OperacaoPresencial | 门店现场销售,不能带承运方 |
| EntregaEmDomicilio | 非现场销售并配送,必须传 cliente 的证件号与地址,以及 transporte.transportadora;送货地址须与开票主体同州 |
| OperacaoPresencialForaDoEstabelecimento | 店外现场销售,如展会、流动摊点,不能带承运方 |
pedido.pagamento.formas[].tipo支付方式
回显开票传入值。
| 取值 | 含义 |
|---|---|
| Dinheiro | 现金,可产生找零 |
| Cheque | 支票 |
| CartaoDeCredito | 信用卡,多数州须填 credenciadoraCartao |
| CartaoDeDebito | 借记卡,多数州须填 credenciadoraCartao |
| CreditoLoja | 赊销 |
| ValeAlimentacao | 食品券,可填 credenciadoraCartao |
| ValeRefeicao | 餐券,可填 credenciadoraCartao |
| ValePresente | 礼品券,可填 credenciadoraCartao |
| ValeCombustivel | 燃油券,可填 credenciadoraCartao |
| BoletoBancario | 银行票据,可填 credenciadoraCartao |
| DepositoBancario | 银行存款 |
| PagamentoInstantaneoPix | Pix 动态码,多数州须填 credenciadoraCartao |
| TransferenciaBancaria | 银行转账,可填 credenciadoraCartao |
| ProgramaDeFidelidade | 积分或返现 |
| PagamentoInstantaneoPixEstatico | Pix 静态码:静态二维码、Pix 密钥或账户信息 |
| CreditoEmLoja | 店内余额,来自此前付款或退货 |
| PagamentoEletronicoNaoInformado | 未能对接的电子支付,只用于收银硬件故障且无法离线开票 |
| PagamentoInstantaneoPixAutomatico | Pix 自动扣款 |
| TransferenciaTefBookTransfer | TEF 同行转账 |
| PagamentoPosterior | 后付,金额 0;有这一笔时合计可低于票面总额,不能找零 |
| Outros | 其他,须填 descricao |
cliente.endereco.uf消费者所在州
回显开票传入值,总是开票主体所在州。
| 取值 | 含义 |
|---|---|
| AC | Acre |
| AL | Alagoas |
| AP | Amapá |
| AM | Amazonas |
| BA | Bahia |
| CE | Ceará |
| DF | Distrito Federal |
| ES | Espírito Santo |
| GO | Goiás |
| MA | Maranhão |
| MT | Mato Grosso |
| MS | Mato Grosso do Sul |
| MG | Minas Gerais |
| PA | Pará |
| PB | Paraíba |
| PR | Paraná |
| PE | Pernambuco |
| PI | Piauí |
| RJ | Rio de Janeiro |
| RN | Rio Grande do Norte |
| RS | Rio Grande do Sul |
| RO | Rondônia |
| RR | Roraima |
| SC | Santa Catarina |
| SP | São Paulo |
| SE | Sergipe |
| TO | Tocantins |
transporte.frete.modalidade运费方式
| 取值 | 含义 |
|---|---|
| SemFrete | 无运费 |
| PorContaDoEmitente | 发货方承担 |
| PorContaDoDestinatario | 收货方承担 |
| PorContaDeTerceiros | 第三方承担 |
| TransporteProprioPorContaDoRemetente | 发货方自有车辆 |
| TransporteProprioPorContaDoDestinatario | 收货方自有车辆 |
itens[].cfopNFC-e 可用的 CFOP
回显开票传入值。
| 取值 | 含义 |
|---|---|
| 5101 | 销售自产商品。配非代收税码:CST 00 / 20 / 40 / 41 / 90 或 CSOSN 102 / 103 / 300 / 400 / 900 |
| 5102 | 转售外购商品。税码同 5101 |
| 5103 | 店外销售自产商品。税码同 5101 |
| 5104 | 店外转售外购商品。税码同 5101 |
| 5115 | 销售寄售收到的商品。税码同 5101 |
| 5405 | 销售上游已代收 ST 的商品。配 CST 60 或 CSOSN 500 |
| 5656 | 向最终消费者销售燃料。须带 combustivel 块;配 CST 60 / 61 或 CSOSN 500 |
| 5667 | 店外向最终消费者销售燃料。须带 combustivel 块;配 CST 60 / 61 或 CSOSN 500 |
| 5910 | 赠品或奖励。代收与非代收税码都可配 |
| 5933 | 缴 ISSQN 的服务行。用 impostos.issqn 代替 icms,ncm 填 00;整票至少要有一行商品 |
| 错误码 | HTTP | |
|---|---|---|
| 10022006 | 404 | 该主体下 nfceId 不存在。 |
| 10003000 | 404 | empresaId 不存在。 |
