WSConsultarSituacaoAssincrono - Consulta assíncrona de documentos na SEFAZ
O web service WSConsultarSituacaoAssincrono realiza consultas de forma assíncrona na SEFAZ. A cada consulta será retornado um número de protocolo ao usuário, o qual é usado posteriormente para visualizar o resultado da consulta com o status do documento na SEFAZ, a consulta será processada pelo serviço “NDDigital e-Forms Web Doc Situation Service”
Para realizar as consultas, este web service utiliza as configurações de saída do e-Forms, que devem estar ligadas a algum Job do e-Forms.
<XML retorno> ConsultarSituacaoAssincrono(<XML consulta>)
|
O parâmetro <XML consulta> irá conter os dados do documento a ser consultado na SEFAZ, conforme abaixo:
Para efetuar o download do schema xsd clique aqui!
<eformsConsultarSituacaoDocumentoAssinc 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>
<listaconsulta>
<consulta>
<versao></versao>
<tipoambiente></tipoambiente>
<chaveacesso></chaveacesso>
</consulta>
</listaconsulta>
</eformsConsultarSituacaoDocumentoAssinc>
|
Exemplo XML de Consulta ao Protocolo
|
<eformsConsultarSituacaoDocumentoAssinc 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>
<protocolo></protocolo>
</eformsConsultarSituacaoDocumentoAssinc>
|
Detalhamento de Schema ConsultarSituaçãoAssíncrono
|
ConsultarSituaçãoAssincrono
|
#
|
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
|
|
listaconsulta
|
|
G
|
S
|
1
|
|
Se esta for utilizada, a tag <protocolo> não deve ser utilizada.
|
3
|
2
|
consulta
|
Consultas a serem realizadas
|
G
|
S
|
1...N
|
|
|
4
|
3
|
versao
|
Versão do schema
|
C
|
S
|
1
|
4
|
Versão do schema.
|
5
|
3
|
tipoambiente
|
Tipo de ambiente
|
N
|
S
|
1
|
1
|
1 = Produção
2 = Homologação
|
6
|
3
|
chaveacesso
|
Chave de acesso para consulta.
|
N
|
S
|
1
|
44
|
|
7
|
3
|
cnpjraiz
|
Indica se a pesquisa do certificado será feita através do CNPJ raiz.
|
C
|
N
|
1
|
8
|
CNPJ RAIZ
|
8
|
3
|
tipopesquisa
|
Indica se devem ser consultados documentos NF-e, CT-e, MDF-e ou eventos.
|
N
|
N
|
1
|
1
|
1= NF-e, CT-e e MDF-e (autorizações/cancelamentos);
2= Eventos – Com esta opção a tag (8) <codigoevento> é obrigatória, caso contrário será enviado ao ERP o XML que a SEFAZ retornar, sem nenhum tratamento;
3= Todos os status do documento na SEFAZ (autorizações/cancelamentos e eventos) – Com esta opção, não deve ser informada a tag (8) <codigoevento>.
|
9
|
3
|
codigoevento
|
Código do evento que será consultado
|
N
|
N
|
1
|
6
|
Exemplos: 110110, 110111, 110115, 210210.
|
10
|
3
|
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
|
3
|
versaocte
|
C
|
N
|
1
|
3
|
Informar o valor "2.0" para 2.00 ou "3.0" para 3.00, caso não seja informada será utilizado por padrão "3.0".
|
12
|
3
|
versaomdfe
|
C
|
N
|
1
|
3
|
Informar o valor "1.0" para 1.00 ou "3.0" para 3.00, caso não seja informada será utilizado por padrão "3.0".
|
13
|
3
|
autoajuste
|
Automatiza o envio de um arquivo ped-ajuste para o e-Forms caso seja necessário corrigir o status de um documento na base de dados.
|
N
|
N
|
1
|
|
1 = Sim;
2 = Não.
|
14
|
|
protocolo
|
Protocolo retornado pela consulta anterior. Usado para visualizar o resultado.
|
N
|
S
|
1
|
|
Informar o número do protocolo retornado na consulta.
Se esta for utilizada, a tag <listaconsulta> não deve ser utilizada.
|
 Legenda do schema Web Services
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