WSBuscarDocumentoEX - Download de documentos do e-Cold e SEFAZ
O web service WSBuscarDocumentoEX realiza download de documentos eletrônicos de entrada, um documento por vez, consultando-os pela chave de acesso. São contemplados os modelos NF-e e CT-e para buscas na base do Cold, e apenas para NF-e na SEFAZ através do web service de distribuição DF-e.
Caso o documento não esteja autorizado, não será feito o download mas sim retornado mensagem referente ao status do mesmo.
A consulta na SEFAZ ocorre apenas se o documento não for encontrado no Cold, e seja informado na chamada através da tag consultarSEFAZ.
Para realizar as consultas, este web service utiliza algumas configurações do Entry Job como o certificado e as conexões de saída. Sendo assim, é necessário informar, na tag <identificador>, o JobKey do Entry Job que será utilizado para fazer o download dos documentos.
O retorno da chamada irá trazer o proc do documento quando encontrado no Cold ou na SEFAZ, podendo ser convertido para TXT conforme a utilização da tag <tiporetorno>. Em casos que não sejam encontrados nenhum documento, para consultas apenas do Cold, irá trazer uma mensagem informando que não consta na base do Cold, e consultando também na SEFAZ irá trazer o status (cStat) e mensagem (xMotivo) retornados da SEFAZ.
<XML retorno> BuscarDocumentoEX (<XML consulta>)
|
O parâmetro XML consulta irá conter os dados que irão filtrar a busca da NF-e no banco do e-Cold e na SEFAZ, conforme abaixo:
Para efetuar o download do schema xsd clique aqui!
<eformsBuscarDocumentoEx xmlns="http://www.nddigital.com.br/connector" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<versao></versao>
<autenticacao>
<usuario></usuario>
<senha></senha>
<conexaoid></conexaoid>
</autenticacao>
<tipoambiente></tipoambiente>
<chaveacesso></chaveacesso>
<consultarSEFAZ></consultarSEFAZ>
<cnpj></cnpj>
<identificador></identificador>
<tiporetorno></tiporetorno>
</eformsBuscarDocumentoEx>
|
Detalhamento do Schema eformsBuscarDocumentoEx
|
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
|
|
consultarSEFAZ
|
Define se a consulta ocorrerá na SEFAZ, quando o documento não for encontrado no e-Cold.
|
N
|
S
|
1
|
1
|
1 = Não consulta na SEFAZ;
2 = Consulta na SEFAZ.
|
9
|
|
cnpj
|
CNPJ do destinatário do documento.
|
N
|
S
|
1
|
14
|
|
10
|
|
identificador
|
JobKey (Chave do Job) do Entry Job que será utilizado para capturar as configurações.
|
C
|
S
|
1
|
1..60
|
|
11
|
|
tiporetorno
|
Define se o retorno será em “TXT” ou “XML”
|
C
|
N
|
1
|
1
|
Preencher com “TXT” para retornos em .TXT, e com “XML” para retornos em .XML – usando letras maiúsculas.
Caso não seja informada, será pego o formato de integração através do job informado na tag <identificador>.
|
Legenda
|
Item pai
|
Número do item que agrupa este elemento.
|
|
Campo
|
Nome do campo conforme está no schema.
|
|
Descrição
|
Descrição rápida dos campos.
|
|
Tipo
|
Tipo de dado no campo.
|
N = Numérico
C = Alfanumérico
D = Data no formato AAAA-MM-DD HH:MM:SS
G = Grupo que conterá outros elementos filhos
|
Obrigatório
|
Indica se o campo é obrigatório ou não
|
S = Obrigatório
N = Não é obrigatório
|
Ocorrência
|
Indica a quantidade de ocorrências possíveis de determinado elemento
|
1 = Apenas 1 vez
1..N = Pode ser de 1 a vários elementos
0..N = Pode ser de nenhum a vários elementos
|
Tamanho
|
Indica o tamanho aceitável do campo
|
1 = Apenas 1 caractere ou número
1..N = Entre 1 caractere ou número ou vários até o valor final definido
|
Observação
|
Observações adicionais sobre o campo
|
|
|
Visualizar modelo do retorno da chamada
