Consulta de Situação de NFCe

Consulta Situação da NFC-e

Através do serviço de Consulta Situação da NFC-e é possível obter a informação de qual o estado atual da NFC-e no banco de dados da Sefaz.

Esta funcionalidade é muito utilizada em casos onde é necessário verificar a existência e validade de uma NFC-e, assim como obter informações sobre o evento de cancelado, caso esteja vinculado.

URL

Produção: POST https://nfce.ns.eti.br/v1/nfce/status

Dados de entrada

Campo	Descrição	Ocorrência	Tipo	Observação
X-AUTH-TOKEN	Token de acesso	1-1	N
chNFe	Chave de acesso da NF-e	1-1	N
tpAmb	Ambiente de autorização da NFC-e	1-1	N	1 - Produção 2 - Homologação

Exemplo de requisição

Requisição Consulta de Situação da NFC-e

curl -X POST \
    -H "Content-Type: application/json" \
    -d '{
        "X-AUTH-TOKEN":"SEU_TOKEN",
        "chNFe":"44444444444444444444444444444444444444444444",         
        "tpAmb": 2
}' \
    http://nfce.ns.eti.br/v1/nfce/status

Dados retornados

Campo	Descrição	Pai	Tipo	Ocorrência	Observação
status	Código de status do processamento		N
motivo	Descrição literal do status de processamento		A
nfeProc	Objeto com os dados da NFC-e		O	0-1	Somente em status = 100
cStat	Código do status da NFC-e na Sefaz	nfeProc	N	1-1
xMotivo	Descrição literal do status da NFC-e na Sefaz	nfeProc	A	1-1
chNFe	Chave da NFC-e	nfeProc	N	1-1
dhRecbto	Data e hora de recebimento pela Sefaz	nfeProc	D	1-1	Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00
nProt	Número do protocolo de autorização da NFC-e	nfeProc	N	1-1
digVal	Digest Value	nfeProc	A	1-1
retEvento	Objeto com dados do evento de cancelamento da NFC-e		O	0-1	Somente em status = 100 e NFC-e cancelada
cStat	Código do status do evento da NFC-e na Sefaz	retEvento	N	1-1
xMotivo	Descrição literal do status do evento da NFC-e na Sefaz	retEvento	A	1-1
chNFeCanc	Chave do cancelamento da NFC-e	retEvento	N	1-1
dhRegEvento	Data e hora do registro do evento	retEvento	D	1-1	Padrão Sefaz AAAA-MM-DDTHH:MM:SS + UTC Ex.: 2016-06-13T15:04:10-02:00
nProt	Número do protocolo do evento	retEvento	N	1-1

Exemplos de retorno

Retorno com sucesso

{
    "status": 100,
    "motivo": "Situacao da NFC-e obtida com sucesso",
    "nfeProc": {
        "cStat": "100",
        "xMotivo": "Autorizado o uso da NF-e",
        "chNFe": "43200907364617000135650000000185111000102435",
        "dhRecbto": "2020-09-04T09:35:07-03:00",
        "nProt": "143200000861157",
        "digVal": "MKScEolQ0No18y/4tFiW/JWADpY=",
        "verAplic": "RSnfce201911290852"
    }
}

cStats Retornados

De acordo com o código de cStat principal, que é retornado no objeto nfeProc, é possível definir a situação do documento.
Abaixo segue uma tabela com os valores que podem ser retornados, podendo haver outros retornos conforme a necessidade da Sefaz.

Código	Retorno
100	Documento autorizado

Códigos de retorno

Códigos	Descrição
100	Situação da NFC-e obtida com sucesso
-100	Não foi possível obter a situação da NFC-e Verifique os campos nfeProc.cstat e nfeProc.xMotivo para identificar o motivo
-997	Campos obrigatórios não informados O campo motivo terá maiores informações
-999	Erro interno ao processar a requisição O campo motivo terá maiores informações

NS NFCe