WSConsultarDFe - Consulta de lista de documentos destinados

Anterior
Próximo
Feedback
Imprimir

WSConsultarDFe - Consulta de lista de documentos destinados

Através do web service WSConsultarDFe, o ERP efetua uma consulta na SEFAZ que retorna um documento ou uma lista dos documentos destinados ao requisitante. Podendo consultar através do NSU ou da chave de acesso. É contemplado apenas o modelo NF-e.

 

<XML retorno> ConsultarDFe (<XML consulta>)

 

Adequado o software de acordo com a NT 2014.002 de NF-e que trata do Web Service de Distribuição de Documentos Fiscais Eletrônicos (DF-e).

Este web service permite que o ator da NF-e tenha acesso aos documentos fiscais eletrônicos (DF-e) e informações resumidas que não tenham sido gerados por ele e que sejam de seu interesse. Pode ser consumido por qualquer ator de NF-e, Pessoa Jurídica ou Pessoa Física, que possua um certificado digital de PJ ou PF. No caso de Pessoa Jurídica, a empresa será autenticada pelo CNPJ base e poderá realizar a consulta com qualquer CNPJ da empresa desde que o CNPJ base consultado seja o mesmo do certificado digital.

 

Este web service provê algumas opções customizadas na chamada, caso os parâmetros sejam informados, para o processamento de documentos retornados pela SEFAZ:

 

integrarDoc: permite que os documentos retornados pelo DF-e sejam depositados em diretório do Entry Job em que foi informado a chave do Job (identificador), para que os documentos sejam apresentados no e-Monitor e sejam devidamente armazenados no módulo Cold.

 

ignorarCnpjRaiz: remove da lista de retorno os documentos em que o CNPJ raiz do emitente é o mesmo CNPJ raiz do destinatário, no caso de documentos enviados de uma filial para outra, onde o ERP já possui o documento de envio e não precisa armazenar o documento também pelo destinatário.

 

Para efetuar o download do schema xsd clique aqui!

Exemplo XML de Consulta

 

<eformsConsultarDFe xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.nddigital.com.br/connector">

 <versao> </versao>

 <distDFeInt versao="1.00">

         <tpAmb> </tpAmb>

         <cUFAutor> </cUFAutor>

         <CNPJ> </CNPJ>

 </distDFeInt>

</eformsConsultarDFe>

 

Detalhamento do Schema eformsConsultarDFe

 

eformsConsultarDFe

#

pai

Campo

Descrição

Tipo

Obrigatório

Ocorrências

Tamanho

Observações

1

 

versao

Versão do schema.

C

S

1

4

Versão do schema.

2

 

identificador

JobKey (Chave do Job) que será utilizado para capturar as configurações.

C

S

1

1..60

 

3

 

integrarDoc

Opção de define se o procNfe ou ProcEvento será disponibilizado para o EntryDocuments

N

N

1

 1

0 = Não envia documento para o Entry

1 = Envia documento para Entry

4

 

ignorarCnpjRaiz

Opção para ignorar retornos da SEFAZ em que o CNPJ raiz do emitente é o mesmo da chamada deste web service.

N

N

1

1

0 = Retorna todos os documentos

1 = Ignora os do mesmo CNPJ raiz

5

 

distDFeInt

 

G

S

1

 

 

6

5

tpAmb

Tipo de ambiente

N

S

1

1

1 = produção

2 = homologação

7

5

cUFAutor

Código da UF do autor

N

S

1

2

Vide tabela do IBGE

8

5

CNPJ

CNPJ do interessado no DF-e

N

S

1

14

CNPJ do interessado no DF-e

Se esta tag for informada, a tag CPF não pode aparecer.

9

5

CPF

CPF do interessado no DF-e

N

S

1

11

CPF do interessado no DF-e

Se esta tag for informada, a tag CNPJ não pode aparecer.

10

5

distNSU

Grupo para distribuir DF-e de interesse.

G

N

1

 

Se esta tag for informada no XML, a tag consNSU não pode aparecer.

11

10

ultNSU

Último NSU recebido pelo ator.

N

S

1

1..15

Caso seja informado com “zero”, ou com um NSU muito antigo, a consulta retornará unicamente as notas fiscais que tenham sido recepcionadas nos últimos 3 meses. A utilização desta tag altera a sequência de NSU no banco de dados.

 

12

5

consNSU

Grupo para consultar um DF-e a partir de NSU especifico

G

N

1

 

Se esta tag for informada no XML, a tag distNSU não pode aparecer.

13

12

NSU

Número sequencial único

N

S

1

1..15

Esta consulta será utilizada quando identificado pelo interessado um NSU faltante, o WS retornará o documento ou informara que o NSU é inexistente no Ambiente nacional.

14

5

consChNFe

Grupo para consultar um DF-e a partir da chave

G

N

1

 

Se esta tag for informada no XML, a tag distNSU e consNSU não podem aparecer.

15

14

chNFe

Número da chave

N

S

1

44

Será retornado do DF-e o proc do documento quando houver a ciência da operação, o resumo quando não houver, e uma mensagem da SEFAZ no caso de falha na consulta.

 

Legenda do schema Web Services        Legenda do schema Web Services

 

 

Visualizar modelo do retorno da chamada