English
Español
Retorno por arquivo XML
Quando uma filial estiver configurada para retornar a situação dos documentos via arquivo XML serão gerados os retornos na pasta Retorno dentro do diretório da filial. O sistema que irá realizar a leitura desses arquivos deve remover os mesmos após seu uso, caso não sejam removidos o eDocs realizará a remoção de acordo com o tempo configurado em Configuração > Geral > Avançado > Intervalo de execução > Tempo em dias de permanência dos arquivos de retorno ao ERP.
Dados do retorno via arquivo XML
| ID | Campo | Descrição | Pai | Tipo | Ocorrência | Observação |
|---|---|---|---|---|---|---|
| 0 | SituacaoDocumento | Situação de documentos eletrônicos | ||||
| 1 | TipoAmbiente | Ambiente de emissão do documento | 0 | Número | 1-1 | Produção = 1 Homologação = 2 |
| 2 | TipoDocumento | Tipo do documento | 0 | Número | 1-1 | Nota Fiscal de Produto = 1
Nota Fiscal de Serviço = 2 Conhecimento de Transporte = 3 Manifesto Eletrônico de Documentos Fiscais = 5 eSocial = 7 Nota Fiscal de Consumidor Eletrônica = 8 Cupom fiscal eletrônico = 9 EFD-Reinf = 10 GNRE = 11 Conhecimento de Transporte Outros Serviços - 12 PAF-ECF Bloco X = 13 |
| 3 | DataConsulta | Data da geração/consulta da situação do documento | 0 | Data | 1-1 | |
| 4 | DetalhesCritica | 0 | Gerado para eSocial com detalhes da rejeição | |||
| 4.1 | Codigo | Código da rejeição | 4 | Número | 1-1 | |
| 4.2 | Localizacao | Localização da tag com problema | 4 | Texto | 1-1 | |
| 4.3 | Mensagem | Mensagem do problema | 4 | Texto | 1-1 | |
| 5 | Documento | Dados de identificação do documento | 0 | 1-1 | ||
| 5.1 | ChaveDocumento | Chave/identificador do documento | 4 | Texto | 1-1 | |
| 5.2 | Serie | Série do documento | 4 | Texto | 0-1 | |
| 5.3 | Numero | Número do documento | 4 | Número | 0-1 | |
| 5.4 | CnpjEmissor | CNPJ do emissor do documento | 4 | Número | 1-1 | CNPJ da filial emissora, ou do empregador no caso de eSocial |
| 5.5 | NúmeroNfse | Número da NFS-e após emissão | 4 | Número | 0-1 | O número da NFS-e só estará disponível depois que o documento estiver com a situação "Emitida". |
| 5.6 | ChaveDocumentoContingencia | Chave do documento quando em contingência | 4 | Texto | 0-1 | Só existirá para documentos que alteram a chave ao entrar em contingência, para os demais não será retornado valor. |
| 5.7 | NumeroFinal | Número de término da faixa de inutilização. | 4 | Número | 0-1 | Só será informado quando for uma inutilização para NFC-e. |
| 5.8 | DigestValue | Informado somente para alguns documentos quando necessário. | 4 | Texto | 0-1 | Hash da assinatura do documento |
| 5.9 | IdentificadorGerador | Identificador do software gerador do XML. | 4 | Texto | 0-1 | Mesma informação passada na requisição de integração do documento, utilizado para vincular a resposta ao documento. |
| 6 | Situacao | Situação do documento | 0 | Número | 1-1 | Ver tabela de situações |
| 7 | ProtocoloAutorizacao | Número do protocolo de autorização, número do recebido ou código de verificação de acordo com tipo de documento | 0 | Texto | 0-1 | Só retornado quando o documento for autorizado |
| 8 | DataAutorizacao | Data e hora de autorização ou rejeição do documento | 0 | Data | 0-1 | Data e hora que a entidade responsável retornou o resultado do processamento do documento. |
| 9 | Eventos | Situação dos eventos associados ao documento | 0 | 0-1 | Para documentos que possuem eventos vinculados (Ex.: Cancelamento de NF-e, Carta de correção de CT-e, etc...) será retornado a situação de cada evento. | |
| 9.1 | SituacaoEvento | Situação de eventos associados a um documento | 8 | 1-N | ||
| 9.1.1 | TipoEvento | Tipo do evento | 8.1 | Texto | 1-1 | 110111 = Cancelamento
110110 = Carta de correção 110112 = Encerramento 110114 = Inclusão de condutor 110140 = EPEC 111500 = Pedido de prorrogação 1° prazo 111501 = Pedido de prorrogação 2° prazo 111502 = Cancelamento de pedido de prorrogação 1° prazo 111503 = Cancelamento de pedido de prorrogação 2° prazo 210200 = Confirmação da Operação (Manifestação do destinatário) 210210 = Ciência da Operação (Manifestação do destinatário) 210220 = Desconhecimento da Operação (Manifestação do destinatário) 210240 = Operação não Realizada (Manifestação do destinatário) 411500 = Resposta ao pedido de prorrogação 1° prazo 411501 = Resposta ao pedido de prorrogação 2° prazo 411502 = Resposta ao cancelamento de pedido de prorrogação 1° prazo 411503 = Resposta ao cancelamento de pedido de prorrogação 2° prazo 550027 = Registro de saída de NF-e S5001 - Evento totalizador do eSocial S5002 - Evento totalizador do eSocial S5011 - Evento totalizador do eSocial S5012 - Evento totalizador do eSocial |
| 9.1.2 | Sequencia | Indica a seqüência do evento | 8.1 | Número | 1-1 | O valor será zero para eventos do eSocial |
| 9.1.3 | Situacao | Situação do evento | 8.1 | Número | 1-1 | Ver tabela de situações |
| 9.1.4 | ProtocoloAutorizacao | Número do protocolo de autorização ou código de verificação de acordo com tipo de documento | 8.1 | Texto | 0-1 | |
| 9.1.5 | DataAutorizacao | Data e hora de autorização do documento | 8.1 | Data | 0-1 | |
| 9.1.6 | XmlAutorizado | XML autorizado do evento | 8.1 | Texto | 0-1 | |
| 9.1.7 | Codigo | Código da rejeição, quando existir | 8.1 | Número | 0-1 | |
| 9.1.7 | Mensagem | Mensagem da rejeição | 8.1 | Texto | 0-1 | |
| 9.1.8 | DataRecepcao | Data e hora de Recepção do documento pelo SEFAZ | 0 | Data | 0-1 | |
| 9.1.9 | DetalhesCritica | 0 | Gerado com detalhes da rejeição | |||
| 10 | Cancelamento | Situação do cancelamento associado ao documento | 0 | 0-1 | Somente se não usar cancelamento como evento | |
| 10.1 | Situacao | Situação do documento | 9 | Número | 1-1 | Ver tabela de situações |
| 10.2 | ProtocoloAutorizacao | Número do protocolo de autorização ou código de verificação de acordo com tipo de documento | 9 | Texto | 0-1 | |
| 10.3 | DataAutorizacao | Data e hora de autorização do documento | 9 | Data | 0-1 | |
| 11 | XmlAutorizado | Arquivo XML autorizado do documento | 0 | Texto | 0-1 | Retorna sempre o arquivo XML do documento autorizado. Ele não é gerado para documentos que não estejam autorizados. Emissão de NF-e em contingência EPEC: retorna o arquivo XML do evento EPEC autorizado. Emissão de NFC-e em contingência "Offline - Operada pelo eDocs": retorna o arquivo XML da nota com as alterações de contingência (QR Code gerado, dados de entrada em contingência adicionados no XML e etc.). |
Tabela de situações
| Código | Descrição | Observações |
|---|---|---|
| 1 | Autorizado | Indica que o documento foi autorizado/registrado/emitido/aceito pela entidade responsável. |
| 2 | Rejeitado | Indica que o documento não foi autorizado/registrado/emitido/aceito pela entidade responsável. |
| 3 | Cancelado | Indica que o documento foi cancelado na entidade responsável. |
| 4 | Denegado | Indica a denegação do documento. A denegação ocorre quando a entidade responsável não autoriza que a operação que o documento se refere se realize. |
| 5 | Inutilizado | Indica a inutilização do número para determinada série, indicando que esta numeração não poderá ser utilizada. |
| 6 | Encerrado | Indica que um MDF-e foi encerrado. |
| 7 | Situação Não Determinada | Ocorre quando o documento está em uma situação não final, ou seja, algum processamento está sendo realizado e ainda não foi possível determinar a situação final. |
| 8 | Emitido em contingência | Ocorre para os documentos que possuem contingência, quando o documento é emitido em contingência e ainda não foi conciliado. |
| 12 | Inclusão de condutor | Ocorre para eventos de Inclusão de condutor e indica que a inclusão foi realizada. |
| 13 | Deferido | Ocorre para eventos de Pedido de Prorrogação de ICMS, indica que o pedido foi deferido. |
| 14 | Indeferido | Ocorre para eventos de Pedido de Prorrogação de ICMS, indica que o pedido foi indeferido. |
| 15 | Deferido parcialmente | Ocorre para eventos de Pedido de Prorrogação de ICMS, indica que o pedido foi deferido parcialmente. |
English
Español
