Consulta Situação de NF-e

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

Esta funcionalidade é muito utilizada em casos onde é necessário verificar a existência e validade de uma NF-e, assim como obter informações sobre os eventos ocorridos com a mesma (ex.: alteração de valores por Cartão de Correção Eletrônica).

URL

Produção: POST https://nfe.ns.eti.br/nfe/stats

Dados de entrada

Campo	Descrição	Tipo	Ocorrência	Observação
X-AUTH-TOKEN	Token de acesso do usuário	A	0-1
licencaCnpj	CNPJ da licença interessada em consultar a situação da NF-e	N	0-1	Utilizado para identificar o certificado digital que deverá ser utilizado Se não for enviado, o CNPJ será extraído da chave enviada no campo chNFe
chNFe	Chave de acesso da NF-e	N	1-1
tpAmb	Tipo do ambiente de autorização da NF-e 1 - Produção 2 - Homologação	N	1-1
versao	Versão da NF-e	A	0-1	Valor padrão: 4.00

Exemplo de requisição

Consulta de situação

curl -X POST \
    -H "Content-Type: application/json" \
    -d '{
         "X-AUTH-TOKEN": "SEU_TOKEN", 
         "licencaCnpj": "07364617000135", 
         "chNFe": "43161107364617000135550000000099461000094833", 
         "tpAmb": "2", 
         "versao": "4.00"
        }'\
    https://nfe.ns.eti.br/nfe/stats

Dados retornados

Campo	Descrição	Observação
status	Código de status do processamento
motivo	Descrição literal do status de processamento
retConsSitNFe	Objeto contendo os dados do protocolo de autorização da NF-e e todos os eventos vinculados.	Somente em status = 200
erro	Objeto contendo os dados de erro ocorrido durante o processamento	Somente em status = -6 ou -999
erro.cStat	Código de status do erro
erro.xMotivo	Descrição literal do erro

Exemplo de retorno

Retorno com sucesso (cStat 100 = Autorizada )

{
    "status": 200,
    "motivo": "Consulta realizada com sucesso",
    "retConsSitNFe": {
        "tpAmb": "2",
        "verAplic": "RS201809061124",
        "cStat": "100",
        "xMotivo": "Autorizado o uso da NF-e",
        "cUF": "43",
        "dhRecbto": "2020-09-03T10:54:16-03:00",
        "protNFe": [
            {
                "infProt": {
                    "Id": "ID143200000787484",
                    "tpAmb": "2",
                    "verAplic": "RS202008281347",
                    "chNFe": "43200907364617000135550000000518401004621869",
                    "dhRecbto": "2020-09-03T10:53:36-03:00",
                    "nProt": "143200000787484",
                    "digVal": "VBJVDHDVbPA1qoH/1RBC+wIBIU4=",
                    "cStat": "100",
                    "xMotivo": "Autorizado o uso da NF-e"
                },
                "versao": "4.00"
            }
        ],
        "versao": "4.00"
    }
}

cStats Retornados

De acordo com o código de cStat principal, que é retornado no objeto retConsSitNFe, é 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
101	Documento cancelado
110	Documento denegado

Códigos de retorno

Campo	Descrição
200	Consulta realizada com sucesso
-400	Chave da NF-e ou Tipo do Ambiente não informados
-3	Chave de acesso inválida
-6	Erro ao realizar a consulta. Verifique o objeto erro para identificar o motivo.

NS NFe

URL