Através do serviço de Consulta Situação de NF3-e é possível obter a informação de qual o estado atual do NF3-e no banco de dados da Sefaz.
Esta funcionalidade é muito utilizada em casos onde é necessário verificar a existência e validade de um NF3-e, assim como obter informações sobre os eventos ocorridos com o mesmo (ex.: Cancelamento).
URL
Produção: POST https://nf3e.ns.eti.br/v1/nf3e/status
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 NF3-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 chNF3e |
| chNF3e | Chave de acesso do NF3-e | N | 1-1 | |
| tpAmb | Tipo do ambiente de autorização da NF3-e | N | 1-1 | 1 - Produção 2 - Homologação |
Exemplo de requisição
Consulta de situação
curl -X POST \
-H "Content-Type: application/json" \
-d '{"X-AUTH-TOKEN": "SEU_TOKEN", "licencaCnpj": "11111111111111", "chNF3e": "11111111111111111111111111111111111111111111", "tpAmb": "2"}'\
https://nf3e.ns.eti.br/v1/nf3e/status
Dados retornados
| Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | 1-1 | N | ||
| motivo | Descrição literal do status de processamento | 1-1 | A | ||
| retConsSitNF3e | Objeto contendo os dados do protocolo de autorização da NF3-e e todos os eventos vinculados. | 0-1 | O | Somente em status = 200 | |
| erro | Objeto contendo os dados de erro ocorrido durante o processamento | 0-1 | O | Somente em status = 200 | |
| cStat | Código de status do erro | 1-1 | erro | ||
| xMotivo | Descrição literal do erro | 1-1 | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"retConsSitNF3e": {
"tpAmb": "2",
"verAplic": "RS20191028094248",
"cStat": "101",
"xMotivo": "Cancelamento de NF3e homologado ",
"cUF": "43",
"protNF3e": {
"infProt": {
"Id": "NF3e143190000000010",
"tpAmb": "2",
"verAplic": "RS20191028094235",
"chNF3e": "11111111111111111111111111111111111111111111",
"dhRecbto": "2019-12-06T15:56:29-03:00",
"nProt": "143190000000010",
"digVal": "tWkjZX1gzoQenHclxF5J5XxhClE=",
"cStat": "100",
"xMotivo": "Autorizado o uso da NF3e "
},
"versao": "1.00"
},
"versao": "1.00"
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Consulta realizada com sucesso |
| -400 | Chave da NF3-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. |