NFC-e
Consultar NFC-e
Devuelve estado, QR Code, enlaces del cupón y del XML y el eco de la emisión.
GET
/openapi/v2/empresas/{empresaId}/nfce/{nfceId}Requiere las cabeceras de firma
token, timestamp y sign, vea Autenticación.Consulta por el id enviado en la emisión. Los enlaces de descarga no requieren firma y se vuelven a generar en cada consulta; vea Descarga de archivos. El cupón se genera en la primera descarga; si el servicio de renderizado está ocupado, el enlace devuelve 503 y basta reintentar.
Parámetros de ruta
empresaId* | string | Identificador de la empresa emisora |
nfceId* | string | Identificador de la NFC-e |
* Campo obligatorio
200
Nota encontrada.
id | string | Identificador de la solicitud |
tipo | string | Tipo de documento |
status | string | Estado |
motivoStatus | string | Motivo |
ambienteEmissao | string | Ambiente de emisión |
dataCriacao | string | Fecha de creación |
dataUltimaAlteracao | string | Última modificación |
| object | Pedido |
| object | Consumidor |
transporte | object | Transporte |
numero | string | Número de la nota |
serie | string | Serie |
dataEmissao | string | Fecha de emisión |
chaveAcesso | string | Clave de acceso |
dataAutorizacao | string | Fecha de autorización |
| object | Protocolo de autorización |
qrCode | string | Contenido del QR Code |
urlConsulta | string | URL de consulta por la clave |
linkDanfe | string | Enlace del cupón en PDF |
linkDownloadXml | string | Enlace del XML |
emitidaEmContingencia | bool | Emitida en contingencia |
alertas | array | Alertas de la autorización |
| array | Ítems |
valorTotal | number | Valor total de la nota |
terminal | string | Identificación de la caja |
statusEstado
Durante una cancelación en curso la nota sigue Autorizada.
| Valores | Significado |
|---|---|
| AguardandoAutorizacao | Aceptada, esperando a la SEFAZ |
| Autorizada | Autorizada por la SEFAZ |
| Negada | Rechazada por la SEFAZ, o falló en el procesamiento de la plataforma; motivo en motivoStatus |
| Cancelada | Cancelada |
| ContingenciaPendente | Emitida offline con la SEFAZ caída; la plataforma la transmite cuando vuelva |
tipoTipo del documento
| Valores | Significado |
|---|---|
| NFC-e | Factura electrónica de consumidor; siempre este valor |
ambienteEmissaoAmbiente de emisión
| Valores | Significado |
|---|---|
| Homologacao | Ambiente de prueba de la SEFAZ; la factura no tiene validez |
| Producao | Ambiente oficial |
pedido.presencaConsumidorPresencia del consumidor
| Valores | Significado |
|---|---|
| OperacaoPresencial | Venta presencial en la tienda; no envíe transportista |
| EntregaEmDomicilio | Venta no presencial con entrega; exige cliente con documento y dirección, y transporte.transportadora; el lugar de entrega queda en el estado del emisor |
| OperacaoPresencialForaDoEstabelecimento | Venta presencial fuera de la tienda, como feria o puesto ambulante; no envíe transportista |
pedido.pagamento.formas[].tipoTipo de pago
Devuelto de la emisión.
| Valores | Significado |
|---|---|
| Dinheiro | Efectivo; puede generar vuelto |
| Cheque | Cheque |
| CartaoDeCredito | Tarjeta de crédito; muchos estados exigen credenciadoraCartao |
| CartaoDeDebito | Tarjeta de débito; muchos estados exigen credenciadoraCartao |
| CreditoLoja | Crédito en la tienda, venta a plazo |
| ValeAlimentacao | Vale de alimentación; acepta credenciadoraCartao |
| ValeRefeicao | Vale de comida; acepta credenciadoraCartao |
| ValePresente | Vale regalo; acepta credenciadoraCartao |
| ValeCombustivel | Vale de combustible; acepta credenciadoraCartao |
| BoletoBancario | Boleto bancario; acepta credenciadoraCartao |
| DepositoBancario | Depósito bancario |
| PagamentoInstantaneoPix | Pix dinámico; muchos estados exigen credenciadoraCartao |
| TransferenciaBancaria | Transferencia bancaria; acepta credenciadoraCartao |
| ProgramaDeFidelidade | Programa de fidelidad o cashback |
| PagamentoInstantaneoPixEstatico | Pix estático: QR estático, clave Pix o datos de la cuenta |
| CreditoEmLoja | Saldo en tienda de un pago anterior o devolución |
| PagamentoEletronicoNaoInformado | Pago electrónico no informado; solo cuando una falla de hardware impide integrar el pago y la emisión offline |
| PagamentoInstantaneoPixAutomatico | Pix automático, cobro recurrente |
| TransferenciaTefBookTransfer | Transferencia TEF entre cuentas del mismo banco |
| PagamentoPosterior | Pago posterior; valor 0, la suma puede quedar por debajo del total y no hay vuelto |
| Outros | Otros; exige descricao |
cliente.endereco.ufEstado del consumidor
Devuelto de la emisión; siempre el estado del emisor.
| Valores | Significado |
|---|---|
| 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.modalidadeModalidad del flete
| Valores | Significado |
|---|---|
| SemFrete | Sin flete |
| PorContaDoEmitente | Flete por cuenta del vendedor |
| PorContaDoDestinatario | Flete por cuenta del comprador |
| PorContaDeTerceiros | Flete por cuenta de terceros |
| TransporteProprioPorContaDoRemetente | Transporte propio del vendedor |
| TransporteProprioPorContaDoDestinatario | Transporte propio del comprador |
itens[].cfopCFOP aceptados en la NFC-e
Devuelto de la emisión.
| Valores | Significado |
|---|---|
| 5101 | Venta de producción propia. ICMS sin ST: CST 00 / 20 / 40 / 41 / 90 o CSOSN 102 / 103 / 300 / 400 / 900 |
| 5102 | Reventa de mercadería de terceros. Mismos códigos sin ST que 5101 |
| 5103 | Venta de producción propia fuera del establecimiento. Mismos códigos sin ST que 5101 |
| 5104 | Reventa de mercadería de terceros fuera del establecimiento. Mismos códigos sin ST que 5101 |
| 5115 | Venta de mercadería recibida en consignación mercantil. Mismos códigos sin ST que 5101 |
| 5405 | Venta de mercadería con ICMS ya retenido por ST. CST 60 o CSOSN 500 |
| 5656 | Venta de combustible a consumidor final. Exige el bloque combustivel; CST 60 / 61 o CSOSN 500 |
| 5667 | Venta de combustible a consumidor final fuera del establecimiento. Exige el bloque combustivel; CST 60 / 61 o CSOSN 500 |
| 5910 | Obsequio o bonificación. Acepta los códigos con y sin ST |
| 5933 | Servicio gravado por el ISSQN. Exige impostos.issqn en lugar de icms y ncm = 00; la factura necesita al menos una línea de mercadería |
| Código | HTTP | |
|---|---|---|
| 10022006 | 404 | nfceId no encontrado en esta empresa. |
| 10003000 | 404 | empresaId no encontrado. |
