O processo da consulta é realizado conforme descrito abaixo.
1.É realizado a busca do documento através do protocolo, o qual encontra-se na tabela TBDOCPROTOCOL, caso o registro não exista na tabela de protocolo nem no Concentrador, o retorno será "Não foi encontrado nenhum documento com o protocolo informado".
2.Caso exista protocolo na tabela, é realizado a consulta na tabela de integração e se nela existir o retorno será o "Retorno final de integração", ou seja, será sempre o que houver registrado na tabela de integração. Caso contrário, será retornado "Documento em processamento".
3.Se a consulta for enviada com menos de 24h do processamento do documento, a API irá consultar o Concentrador, onde o status da chamada será o retorno da OUT. Se o Concentrador não encontrar o documento, será retornado "Documento em processamento".
9
A cada envio o número de protocolo é trocado, dessa forma para realizar uma consulta de nota é recomendável que o protocolo seja salvo antes do envio. Para consulta não é informado um Json, apenas é realizado uma chamada através da URL de consulta. |
Abaixo segue representação do fluxo da consulta, para o melhor entendimento.
Retorno de quando o concentrador encontra-se off-line |
{ "Response": { "Code": 559, "Description": "Falha de comunicação com o concentrador." } } |
Retorno quando não houver registro na tabela de protocolos nem no concentrador |
{ "Response": { "Code": 277, "Description": "Nao foi encontrado nenhum documento com o protocolo informado" } } |
✓ Somente será retornado "documento em processamento" se houver protocolo na TBDOCPROTOCOL, porém o documento ainda não encontra-se na tabela de integração.
Retorno documento em processamento |
{ "Response": { "Code": 562, "Description": "Documento em processamento." } } |
Retorno para erros internos da aplicação |
{ "Response": { "Code": 999, "Description": "Ocorreu um erro no processamento. Consulte o log para mais informações" } } |
Retorno para erros internos da aplicação |
{ "Response": { "Code": 999, "Description": "Ocorreu um erro no processamento. Consulte o log para mais informações" } } |
Retorno documento autorizado |
|
{ "Response": { "Code": 100, "Description": "Processamento realizado com sucesso" }, "Authorization": { "Digval": "FDq97SVSI3CB78X7PaYxlpURfuI=", "Code": 100, "AccessKey": "52190947508411022559655620000007341145020300", "DHRecbto": "2019-09-25T13:36:57-03:00", "NProt": "152190021231247", "XMotivo": "Autorizado o uso da NF-e" "CMsg": "200", "XMsg": "NOTA MS PREMIADA | DEZENAS: ( 11 13 19 23 25 31 37 47 ) | www.notamspremiada.ms.gov.br" }, "QRCode": "http://homolog.sefaz.go.gov.br/nfeweb/sites/nfce/danfeNFCe?p=52190947508411022559655620000007341145020300|2|2|1|0858B8F330265FC7107033EFB62F8FE01DC34885", "UrlSefazConsumer": "http://www.nfce.go.gov.br/post/ver/214413/consulta-nfc-e-homologacao" }
|
Retorno documento cancelado |
{ "Response": { "Code": 100, "Description": "Processamento realizado com sucesso" }, "Cancellation": { "Code": 135, "AccessKey": "13190942274696004262652530000111229953667567", "DHRecbto": "2019-09-23T10:39:39-03:00", "NProt": "113190007490461", "XMotivo": "Evento Registrado e viculado a NFe" } } |
Retorno documento inutilizado |
{ "Response": { "Code": 100, "Description": "Processamento realizado com sucesso" }, "Nullify": { "nNFIni": "11123", "nNFFin": "11123", "Code": 102, "AccessKey": "13194227469600426265253000011123000011123", "DHRecbto": "2019-09-23T10:57:30-03:00", "NProt": "113190007490431", "XMotivo": "Inutilizacao de numero homologado" } } |
Retorno documento rejeitado |
{ "Response": { "Code": 206, "Description": "NFCe rejeitada pela Sefaz" }, "SefazRejection": { "Code": 270, "Description": "Rejeicao: Codigo Municipio do Fato Gerador: digito invalido" } } |