WSConsultarSituacaoDocumento - Consultar status do documento na SEFAZ
Efetua, através do web service WSConsultarSituacaoDocumento, uma consulta na SEFAZ e retorna ao ERP o status do documento eletrônico ou do evento relacionado.
O web service automatiza um arquivo ped-ajuste para o e-Forms quando utilizado a tag <autoajuste>1</autoajuste>, o ped-ajuste faz uma consulta na SEFAZ através da chave do documento, caso o documento esteja na SEFAZ com a situação diferente da base de processamento, este faz a atualização do status do documento.
O método chamado para realização das consultas é denominado ConsultarSituacaoDocumento, como pode-se observar:
<XML retorno> ConsultarSituacaoDocumento(<XML consulta>)
|
O parâmetro <XML consulta> irá conter uma consulta com uma chave de acesso a ser consultada, sendo que o retorno irá apresentar as informações sobre os status dos documentos, ou dos eventos relacionados, na SEFAZ.
Para efetuar o download do schema xsd clique aqui!
<eformsConsultarSituacaoDocumento 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>
<tipoambiente></tipoambiente>
<chaveacesso></chaveacesso>
</eformsConsultarSituacaoDocumento>
|
Detalhamento do schema eformsConsultarSituacaoDocumento
|
eformsConsultarSituacaoDocumento
|
#
|
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
|
|
tipoambiente
|
Tipo de ambiente.
|
N
|
S
|
1
|
1
|
1 = Produção;
2 = Homologação.
|
3
|
|
chaveacesso
|
Chave de acesso do documento.
|
N
|
S
|
1
|
44
|
Chave de acesso do documento. Pelo modelo e unidade da federação que estão na chave de acesso identifica qual SEFAZ deverá ser consultada.
|
4
|
|
cnpjraiz
|
Indica se a pesquisa do certificado será feita através do CNPJ raiz.
|
C
|
N
|
1
|
8
|
CNPJ RAIZ.
|
5
|
|
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 6 <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 6 <codigoevento>.
|
6
|
|
codigoevento
|
Código do evento que será consultado.
|
N
|
N
|
1
|
6
|
Exemplos: 110110, 110111, 110115, 210210.
|
7
|
|
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".
|
8
|
|
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".
|
9
|
|
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".
|
10
|
|
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
|
3
|
0 = Não;
1 = Sim.
|
11
|
|
nomecertificado (tag deve ser informada apenas apartir da versão 4.8.2.0 do WS)
|
Nome do certificado digital
|
C
|
N
|
1
|
1..N
|
Informar o nome do certificado digital ou o nome amigável do certificado.
|
As tags versaonfe, versaocte, versaomdfe não são obrigatórias em todas as chamadas. Elas servem para direcionar a consulta para versão desejada. Não envia-lá fará com que o WebServices consulte todas as Conexões de Saída disponíveis para aquele tipo de documento, tipo de ambiente e unidade de federação.
|
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