Neste endpoint é possível consultar o retorno do processamento de uma NFS-e utilizando o nsNRec de uma emissão bem sucedida, bem como obter o XML e link para impressão.
URL
Produção: POST https://nfseapi.ns.eti.br/v1/{cidade}/emissao/status
Dados de entrada
| Campo | Ocorrência | Descrição | Tipo | Tamanho | Observação |
|---|---|---|---|---|---|
| X-AUTH-TOKEN | 1-1 | Token de acesso do usuário | String | Pode ser enviado no header | |
| CNPJ | 1-1 | CNPJ do emitente da NFS-e | String | 14 | |
| nsNRec | 1-1 | Número do protocolo de recebimento | Inteiro | ||
| IM | 1-1 | Inscrição municipal ligada ao CNPJ | String | 1-15 |
Exemplo de requisição
Requisição de status de processamento de CT-e
curl -X POST
\-H "Content-Type: application/json"
\-d '{"X-AUTH-TOKEN":"SEU_TOKEN","CNPJ":"99999999999999", "nsNRec":"123456", "IM": "000000"}'
\https://nfseapi.ns.eti.br/v1/canoas/emissao/status
Dados retornados
| Campo | Descrição | Cidades | Pai | Observação |
|---|---|---|---|---|
| status | Código de status do processamento da NS | TODAS | ||
| motivo | Descrição literal do status de processamento da NS | TODAS | ||
| cStat | Código de status do processamento da NFS-e na Prefeitura | TODAS | ||
| xMotivo | Descrição literal do status de processamento na Prefeitura | TODAS | Quando cStat diferente de 100, contem a mensagem de erro retornada pela Prefeitura | |
| chave | Chave da NFS-e autorizada pela Prefeitura | TODAS | Somente em cStat = 100 | |
| serie | Serie da NFS-e autorizada pela Prefeitura | TODAS | Somente em cStat = 100 | |
| nNF | Número da NFS-e autorizada pela prefeitura | TODAS | Somente em cStat = 100. Este número é retornado pela prefeitura, pode ser diferente do informado no documento | |
| nProt | Protocolo de autorização da NFS-e na Prefeitura | TODAS | Somente em cStat = 100 | |
| dhRecbto | Data e hora do recebimento da NFS-e pela Prefeitura | TODAS | Somente em cStat = 100 | |
| urlImpressao | URL para download do documento diretamente na Prefeitura | TODAS | Somente em cStat = 100 | |
| xml | XML de distribuição da NFS-e | TODAS | Somente em cStat = 100 | |
| erro | Objeto contendo o erro ocorrido | TODAS | erro | |
| cStat | Código de status do erro | TODAS | erro | |
| xMotivo | Descrição literal do erro | TODAS | erro |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"cStat": "100",
"xMotivo": "Documento Autorizado com Sucesso",
"chave": "74",
"serie": "0",
"nNF": "74",
"nProt": "GA4E66A5E4GA65AE654AEF6",
"dhRecbto": "2020-04-14T18:49:08-03:00",
"urlImpressao": "https://enfs-hom.abaco.com.br/canoas/servlet/wvalidarautenticidadenfse?CNPJ,VALOR,NNF",
"xml": "<?xml version=\"1.0\" encoding=\"utf-8\"?><CompNfse>...</CompNfse>"
}
Retorno com erro
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"cStat": "-1",
"xMotivo": "(E10)RPS:85 - RPS já informado.\r\nPara essa Inscrição Municipal/CNPJ já existe um RPS informado com o mesmo número, série e tipo.",
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | NF-e recebida com sucesso e enviada para Sefaz |
| -2 | Nao foi possivel carregar o status da NFS-e Verifique o campo xMotivo para identificar os campos incorretos |
| -400 | Campos obrigatórios não informados: {CAMPOS} |