Este serviço é utilizado para consultar o status de processamento de um NF3-e enviado anteriormente para processamento pelo método de Emissão de NF3-e.
URL
Produção: POST https://nf3e.ns.eti.br/v1/nf3e/issue/status
Dados de entrada
Campo | Ocorrência | Tipo | Pai | Descrição |
---|---|---|---|---|
X-AUTH-TOKEN | 1-1 | A | Token de acesso da Software House | |
CNPJ | 1-1 | N | CNPJ do emitente do NF3-e | |
nsNRec | 1-1 | N | Número do protocolo de recebimento |
Exemplo de requisição
Requisição de status de processamento de NF3-e
curl -X POST \
-H "Content-Type: application/json" \
-d '{"X-AUTH-TOKEN":"SEU_TOKEN", "CNPJ": "11111111111111", "nsNRec": 1}' \
https://nf3e.ns.eti.br/v1/nf3e/issue/status
Dados retornados
Campo | Descrição | Ocorrência | Tipo | Pai | Ovservação |
---|---|---|---|---|---|
status | Código de status do processamento | 1-1 | N | ||
motivo | Descrição literal do status de processamento | 1-1 | A | ||
chNF3e | Chave da NF3-e | 1-1 | N | ||
cStat | Código de status do processamento do NF3-e na Sefaz | 0-1 | N | Somente em status = 200 | |
xMotivo | Descrição literal do status de processamento na Sefaz | 0-1 | A | Somente em status = 200 | |
nProt | Número do protocolo de autorização do NF3-e na Sefaz | 0-1 | N | Somente em cStat = 100 | |
dhRecbto | Data e hora do recebimento do NF3-e pela Sefaz | 0-1 | D | Somente em status = 200 | |
consultarNSNRec | NSNRec do mesmo documento autorizado ou pendente de consulta | 0-1 | N | Este campo pode aparecer em status = 200 e cStat = 539, se tivermos um nsNRec pendente de consulta ou do mesmo documento autorizado. Caso recebas este campo, consulte novamente o status de processamento com o valor dele. | |
xml | XML de distribuição da NF3-e | 0-1 | A | Somente em cStat = 100 | |
erro | Objeto contendo as informações de erro caso a consulta não possa ser realizada com sucesso Detalhamento no Quadro Abaixo | 0-1 | O | Somente em status diferente de 200 |
Detalhamento do Objeto erro
Campo | Descrição | Ocorrência | Tipo | Pai |
---|---|---|---|---|
cStat | Código de status do erro | 1-1 | N | |
xMotivo | Descrição literal do erro | 1-1 | A |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"chNF3e": "43191207364617000135660000000000101834241950",
"cStat": "100",
"xMotivo": "Autorizado o uso da NF3e ",
"nProt": "143190000000010",
"dhRecbto": "2019-12-06T15:56:29-03:00",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><nf3eProc versao=\"1.00\" xmlns=\"http://www.portalfiscal.inf.br/nf3e\"><NF3e><infNF3e versao=\"1.00\" Id=\"NF3e43191207364617000135660000000000101834241950\">...</nf3eProc>"
}
Retorno com erro
{
"status": -2,
"motivo": "Nao foi possivel carregar o status da NF3-e",
"erro": {
"cStat": 0,
"xMotivo": "Documento não localizado em nosso banco de dados"
}
}
Códigos de retorno
Código | Descrição |
---|---|
200 | Consulta realizada com sucesso |
-2 | Não foi possível carregar o status de processamento do NF3-e Verifique o objeto erro para maiores informações |