Mudanças entre as edições de "Manuais:DANFEView/IntegracaoERP/ConsultarDocumentosAguardandoManifestacao"

De unimake
Ir para: navegação, pesquisa
(Criou página com '__NOTITLE__ = Integração: consultar a lista de documentos aguardando manifestação do destinatário = O sistema ERP pode solicitar ao DANFE View a lista de todos os docume...')
 
 
(7 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 14: Linha 14:
  
  
O XML de requisição deve ser gerado na pasta tmp\integracao.
+
O XML de requisição pode ter qualquer nome e deve ser gerado na pasta tmp\integracao.
  
Aconselha-se que cada arquivo de requisição tenha sempre um nome exclusivo para evitar confusões entre requisições e respostas, bem como confusão entre requisições simultâneas nas diversas estações da rede. O nome sugerido é no formato "manif-12345678901234567890123456789012345678901234.xml", ou seja, o prefixo "manif-" acrescido da chave de acesso do documento.
+
Aconselha-se que cada arquivo de requisição tenha sempre um nome exclusivo para evitar confusões entre requisições e respostas, bem como confusão entre requisições simultâneas nas diversas estações da rede.
  
 
Após ser lido, o arquivo XML da requisição é automaticamente removido pelo DANFE View, e um arquivo de resposta gerado na pasta tmp\integracao\res, com o mesmo nome do XML de requisição, apenas acrescentando o prefixo "ret-" ao seu nome.
 
Após ser lido, o arquivo XML da requisição é automaticamente removido pelo DANFE View, e um arquivo de resposta gerado na pasta tmp\integracao\res, com o mesmo nome do XML de requisição, apenas acrescentando o prefixo "ret-" ao seu nome.
Linha 23: Linha 23:
 
:::Se o XML de requisição for: C:\DANFEView\tmp\integracao\docsPendentes_12123123000112_20210601_13h00m00s.xml
 
:::Se o XML de requisição for: C:\DANFEView\tmp\integracao\docsPendentes_12123123000112_20210601_13h00m00s.xml
 
:::O XML de resposta será: C:\DANFEView\tmp\integracao\res\ret-docsPendentes_12123123000112_20210601_13h00m00s.xml
 
:::O XML de resposta será: C:\DANFEView\tmp\integracao\res\ret-docsPendentes_12123123000112_20210601_13h00m00s.xml
 
== TAGS do XML de envio  ==
 
  
 
{| class="wikitable"
 
{| class="wikitable"
Linha 41: Linha 39:
 
   <sucesso>1</sucesso>
 
   <sucesso>1</sucesso>
 
   <xObs>OK</xObs>
 
   <xObs>OK</xObs>
   <ret chaveAcesso="12345678901234567890123456789012345678901234">
+
   <ret nItem="1">
 
       <emit>   
 
       <emit>   
 
         <cnpj>01.123.123/0001/12</cnpj>
 
         <cnpj>01.123.123/0001/12</cnpj>
      <cpf>123.123.123-12</cpf>
+
        <cpf>123.123.123-12</cpf>
<IE>001234512345</IE>
+
        <IE>001234512345</IE>
 
         <nome>Nome do emitente</nome>
 
         <nome>Nome do emitente</nome>
<UF>001234512345</UF>
+
        <UF>SP</UF>
  </emit>   
+
      </emit>   
  <dEmi>AAAA-MM-DD</dEmi>
+
      <chaveAcesso>12345678901234567890123456789012345678901234</chaveAcesso>
  <numero>12345</numero>
+
      <dEmi>AAAA-MM-DD</dEmi>
  <tpNF></tpNF>
+
      <numero>123456789</numero>
  <valor>
+
      <tpNF>1</tpNF>
  <cSitConfSEFAZ></cSitConfSEFAZ>
+
      <valor>100.00</valor>
  <cSitConf></cSitConf>
+
      <cSitConfSEFAZ>0</cSitConfSEFAZ>
  <xJust></xJust>
+
      <cSitConf>0</cSitConf>
  <memorizado></memorizado>
+
      <xJust>Justificativa, quando cSitConf=Não realizada</xJust>
  <jaFezDownload></jaFezDownload>
+
      <erro>Erro na tentativa de envio da manifestação para a SEFAZ</erro>
  <dhInclusao></dhInclusao>
+
      <memorizado>0</memorizado>
  <erro></erro>
+
      <dhInclusao>AAAA-MM-DD HH:MM:SS</dhInclusao>
 
   </ret>
 
   </ret>
 
   ...
 
   ...
   <ret chaveAcesso="23456789012345678901234567890123456789011234">
+
   <ret nItem="2">
 
  ...
 
  ...
 
   </ret>
 
   </ret>
Linha 68: Linha 66:
 
</pre>
 
</pre>
  
A TAG <sucesso> pode conter:
+
{| class="wikitable"
* "0" - em caso de erro geral no processamento. Nesse caso, nenhum documento contido no XML de envio foi processado. Ex: XML de envio não foi reconhecido pelo DANFE View
+
|-
 +
|sucesso
 +
|
 +
 
 +
Pode conter:
 +
* "0" - em caso de erro geral no processamento. Nesse caso nenhum documento será retornado. Ex: XML de envio não foi reconhecido pelo DANFE View
 
* "1" - o lote foi processado.
 
* "1" - o lote foi processado.
  
A TAG <xObs> será preenchida com:
+
|-
 +
|xObs
 +
|Preenchida com:
 
* "OK", se sucesso=1, ou  
 
* "OK", se sucesso=1, ou  
 
* Mensagem de erro gerada pelo DANFE View no processamento da requisição, se sucesso=0.
 
* Mensagem de erro gerada pelo DANFE View no processamento da requisição, se sucesso=0.
  
Caso sucesso=1, a resposta conterá um grupo de TAGS <ret> para cada documento do XML de envio, com as TAGs:
+
|}
 +
 
 +
Caso sucesso=1, a resposta conterá um grupo de TAGS <ret> para cada documento encontrado na base de dados que aguardam por manifestação do destinatário definido no XML de envio, com as TAGs:
 +
 
 +
{| class="wikitable"
 +
 
 +
|-
 +
|emit
 +
|Dados do emitente do documento
 +
 
 +
|-
 +
|dEmi
 +
|Data de emissão
 +
 
 +
|-
 +
|numero
 +
|Número do documento
 +
 
 +
|-
 +
|tpNF
 +
|Tipo da Nota Fiscal
 +
 
 +
|-
 +
|valor
 +
|Valor total do documento
  
<cSitConf> - Status da manifestação desse documento, podendo ser:
+
|-
 +
|cSitConfSEFAZ
 +
|Status da manifestação desse documento na SEFAZ, podendo ser:
 
* "0" - Sem manifestação
 
* "0" - Sem manifestação
 
* "1" - Confirmada
 
* "1" - Confirmada
Linha 85: Linha 116:
 
* "4" - Ciência da operação
 
* "4" - Ciência da operação
 
* vazio - No caso de algum erro ter ocorrido ao localizar a chave de acesso na base de dados.
 
* vazio - No caso de algum erro ter ocorrido ao localizar a chave de acesso na base de dados.
 +
NOTA: essa TAG apresenta o status da última manifestação do destinatário enviada pelo DANFE View à SEFAZ com sucesso. Caso outra manifestação tenha sido enviada por outro sistema, mesmo que seja o DANFE View em outra instalação, ela não aparecerá aqui.
 +
 +
|-
 +
|cSitConf
 +
|Status da manifestação desse documento na DANFE View, podendo ser:
 +
* "0" - Sem manifestação
 +
* "1" - Confirmada
 +
* "2" - Desconhecimento
 +
* "3" - Operação não realizada
 +
* "4" - Ciência da operação
  
<xObsDoc> - Eventualmente poderá sem preenchida com:
+
NOTA: cSitConf é igual à cSitConfSEFAZ quando a manifestação do destinatário já foi enviada com sucesso à SEFAZ, ou é diferente quando uma manifestação já foi inserida no sistema mas ainda não foi enviada à SEFAZ, ou houve falha na tentativa de envio.
* Texto da justificativa, quando status=3;
+
 
* Mensagem de erro recebida da SEFAZ ao tentar enviar a manifestação.
+
|-
* Mensagem de erro gerada pelo DANFE View, por exemplo, ao não localizar a chave de acesso em sua base de dados.
+
|xJust
 +
|Justificativa, quando cSitConf=3
 +
 
 +
|-
 +
|erro
 +
|Erro recebido na última tentativa de envio da manifestação para a SEFAZ
 +
 
 +
|-
 +
|memorizado
 +
|O XML dsse documento já foi memorizado e está na base de dados?
 +
* 0 - Não
 +
* 1 - Sim
 +
 
 +
|-
 +
|dhInclusao
 +
|Data e hora da inclusão desse resumo do documento na base de dados.
 +
 
 +
Geralmente é a data/hora em que recebemos a resposta da consulta de documentos para manifestação do destinátio enviada à SEFAZ.
 +
 
 +
|}

Edição atual tal como às 09h52min de 10 de dezembro de 2021

Integração: consultar a lista de documentos aguardando manifestação do destinatário

O sistema ERP pode solicitar ao DANFE View a lista de todos os documentos que aguardam por manifestação do destinatário.

Para tanto basta gerar um XML conforme esse modelo:

<?xml version="1.0" encoding="utf-8"?>
<docsManifest>
   <dest>12.123.123/0001-12</dest>
</docsManifest>


O XML de requisição pode ter qualquer nome e deve ser gerado na pasta tmp\integracao.

Aconselha-se que cada arquivo de requisição tenha sempre um nome exclusivo para evitar confusões entre requisições e respostas, bem como confusão entre requisições simultâneas nas diversas estações da rede.

Após ser lido, o arquivo XML da requisição é automaticamente removido pelo DANFE View, e um arquivo de resposta gerado na pasta tmp\integracao\res, com o mesmo nome do XML de requisição, apenas acrescentando o prefixo "ret-" ao seu nome.

Exemplo:
Se o XML de requisição for: C:\DANFEView\tmp\integracao\docsPendentes_12123123000112_20210601_13h00m00s.xml
O XML de resposta será: C:\DANFEView\tmp\integracao\res\ret-docsPendentes_12123123000112_20210601_13h00m00s.xml
dest CNPJ ou CPF do destinatário dos documentos para o qual deseja a lista daqueles que aguardam por manifestação.


XML de resposta

<?xml version="1.0" encoding="utf-8"?>
<retDocsManifest>
   <sucesso>1</sucesso>
   <xObs>OK</xObs>
   <ret nItem="1">
      <emit>   
         <cnpj>01.123.123/0001/12</cnpj>
         <cpf>123.123.123-12</cpf>
         <IE>001234512345</IE>
         <nome>Nome do emitente</nome>
         <UF>SP</UF>
      </emit>   
      <chaveAcesso>12345678901234567890123456789012345678901234</chaveAcesso>
      <dEmi>AAAA-MM-DD</dEmi>
      <numero>123456789</numero>
      <tpNF>1</tpNF>
      <valor>100.00</valor>
      <cSitConfSEFAZ>0</cSitConfSEFAZ>
      <cSitConf>0</cSitConf>
      <xJust>Justificativa, quando cSitConf=Não realizada</xJust>
      <erro>Erro na tentativa de envio da manifestação para a SEFAZ</erro>
      <memorizado>0</memorizado>
      <dhInclusao>AAAA-MM-DD HH:MM:SS</dhInclusao>
   </ret>
   ...
   <ret nItem="2">
	  ...
   </ret>
</retDocsManifest>
sucesso

Pode conter:

  • "0" - em caso de erro geral no processamento. Nesse caso nenhum documento será retornado. Ex: XML de envio não foi reconhecido pelo DANFE View
  • "1" - o lote foi processado.
xObs Preenchida com:
  • "OK", se sucesso=1, ou
  • Mensagem de erro gerada pelo DANFE View no processamento da requisição, se sucesso=0.

Caso sucesso=1, a resposta conterá um grupo de TAGS <ret> para cada documento encontrado na base de dados que aguardam por manifestação do destinatário definido no XML de envio, com as TAGs:

emit Dados do emitente do documento
dEmi Data de emissão
numero Número do documento
tpNF Tipo da Nota Fiscal
valor Valor total do documento
cSitConfSEFAZ Status da manifestação desse documento na SEFAZ, podendo ser:
  • "0" - Sem manifestação
  • "1" - Confirmada
  • "2" - Desconhecimento
  • "3" - Operação não realizada
  • "4" - Ciência da operação
  • vazio - No caso de algum erro ter ocorrido ao localizar a chave de acesso na base de dados.

NOTA: essa TAG apresenta o status da última manifestação do destinatário enviada pelo DANFE View à SEFAZ com sucesso. Caso outra manifestação tenha sido enviada por outro sistema, mesmo que seja o DANFE View em outra instalação, ela não aparecerá aqui.

cSitConf Status da manifestação desse documento na DANFE View, podendo ser:
  • "0" - Sem manifestação
  • "1" - Confirmada
  • "2" - Desconhecimento
  • "3" - Operação não realizada
  • "4" - Ciência da operação

NOTA: cSitConf é igual à cSitConfSEFAZ quando a manifestação do destinatário já foi enviada com sucesso à SEFAZ, ou é diferente quando uma manifestação já foi inserida no sistema mas ainda não foi enviada à SEFAZ, ou houve falha na tentativa de envio.

xJust Justificativa, quando cSitConf=3
erro Erro recebido na última tentativa de envio da manifestação para a SEFAZ
memorizado O XML dsse documento já foi memorizado e está na base de dados?
  • 0 - Não
  • 1 - Sim
dhInclusao Data e hora da inclusão desse resumo do documento na base de dados.

Geralmente é a data/hora em que recebemos a resposta da consulta de documentos para manifestação do destinátio enviada à SEFAZ.