WSBuscarDocumento - Buscar documentos em múltiplas bases

Anterior
Próximo
Feedback
Imprimir

WSBuscarDocumento - Buscar documentos em múltiplas bases

O web service WSBuscarDocumento realiza pesquisas de documentos eletrônicos NF-e, CT-e e CT-eOS, através de consultas síncronas. Ele busca as informações dos documentos em diferentes locais. Este processo é realizado em três passos distintos, são eles:

 

Acesso ao web service da SEFAZ para verificar o status do documento na Secretaria da Fazenda;

Se o documento existir, a consulta é feita na base local do e-Cold, para retornar os dados consultados;

Se a documento não existir no e-Cold, a busca é realizada na base de dados da SEFAZ utilizando o Robô NDD.

 

 

Se o status do documento for cancelado na Secretaria da Fazenda, a busca pelo documento é feita apenas no e-Cold.

 

Caso o documento esteja cancelado, será necessário informar o parâmetro (a tag <retornarSeNFeCancelada>).

As consultas realizadas são armazenadas em uma tabela específica, denominada TBSTATISTICSCONSULT, que receberá as estatísticas das pesquisas efetuadas. O método utilizado nas chamadas a este web service é nomeado ConsultarDocumento, como exposto abaixo:

 

<XML retorno> ConsultarDocumento(<XML consulta>)

 

O parâmetro <XML consulta> irá conter os dados para buscar um documento eletrônico existente no e-Cold ou na base de dados da SEFAZ, conforme abaixo:

 

Para efetuar o download do schema xsd clique aqui!

Exemplo XML de Consulta

 

<eformsBuscarDocumento 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>

 <autenticacao>

         <usuario></usuario>

         <senha></senha>

         <conexaoid></conexaoid>

 </autenticacao>

 <tipoambiente></tipoambiente>

 <chaveacesso></chaveacesso>

 <retornarSeNFeCancelada></retornarSeNFeCancelada>

</eformsBuscarDocumento>

 

Detalhamento do Schema eformsBuscarDocumento

 

eformsBuscarDocumento        

#

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

 

autenticacao

Autenticação do usuário na base do e-Cold.

G

S

1

 

O acesso ao e-Cold fica restrito, portanto para que se possa consultá-lo, é necessário que sejam passadas as informações de acesso e conexão.

3

2

usuario

Nome do usuário.

C

S

1

1..100

Nome do usuário, conforme cadastrado na base do e-Forms.

4

2

senha

Senha do usuário.

C

S

1

1..100

Senha do usuário, conforme cadastrado na base do e-Forms.

5

2

conexaoid

Identificador da conexão e-Cold.

N

S

1

1..14

ID da conexão e-Cold configurada no e-Connector que será consultada.

6

 

tipoambiente

Tipo do ambiente.

N

S

1

1

1 = Produção;

2 = Homologação.

7

 

chaveacesso

Chave de acesso do documento.

N

S

1

44

Chave de acesso sem o literal NFe.

8

 

retornarSeNFeCancelada

Retornar se a NF-e estiver cancelada.

N

S

1

1

Opção para retornar ou não o documento, quando estiver cancelado. 1 = sim, 2 = não.

9

 

cnpjraiz

Indica se a pesquisa do certificado será feita através do CNPJ raiz.

C

N

1

8

CNPJ RAIZ.

OBS: Essa opção se torna obrigatória quando possuir mais de um certificado no ambiente e quando a opção ''utilizar CNPJ raiz'' tiver sido marcada na instalação.

10

 

versaonfe

Indica a versão do documento para seleção da URL de consulta.

C

N

1

4

Informar o valor "3.10" ou "4.00", caso não seja informada será utilizado por padrão "4.00".

11

 

utilizarRobo

Indica se a consulta será encaminhada ao robô, caso não exista no cold.

N

N

1

1

Opção para buscar ou não o documento no robô, quando não existir no cold. 0 = sim, 1 = não.

 

 

 

Visualizar modelo do retorno da chamada