WSConsultarStatus - Consulta ao status dos documentos na base do e-Forms
As consultas de status dos documentos enviados, para a base de processamento do e-Forms, são realizadas pelo web service WSConsultarStatus. Os status podem ser consultados pela chave de acesso ou através do protocolo de inserção do WSInserirDocumento. Caso seja usado o protocolo de consulta, o produto irá efetuar, primeiramente, uma pesquisa na base de protocolos de processamento para buscar as notas processadas e posteriormente, na base do e-Forms.
É possível consultar os seguintes tipos de documentos, conforme a tabela abaixo:
Tipo de processamento
|
NF-e
|
CT-e
|
CT-e OS
|
MDF-e
|
EMISSÃO
|
✓ |
✓ |
x
|
✓ |
RECEPÇÃO
|
✓ |
✓ |
✓ |
✓ |
O método utilizado na chamada deste Web Service é nomeado ConsultarStatus, como observa-se a seguir:
<XML retorno> ConsultarStatus(<XML consulta>)
|
Para efetuar o download do schema xsd clique aqui!
<eformsConsultarStatus 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>
<chaveprotocolo>
<chaveacesso></chaveacesso>
</chaveprotocolo>
<statusatual></statusatual>
<retornarchaveoriginalbloqueada></retornarchaveoriginalbloqueada>
</consulta>
</listaconsulta>
</eformsConsultarStatus>
|
Detalhamento do schema eformsConsultarStatus
|
eformsConsultarStatus
|
#
|
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
|
|
tipostatus
|
Status de documentos de entrada ou de saída
|
N
|
N
|
1
|
1
|
1 = status de documentos de entrada
2 = status de documentos de saída
(Caso não seja informada esta tag, o processamento será padrão para documentos de saída)
|
3
|
|
identificador
|
Identificador do job (JobKey)
|
C
|
N
|
1
|
1..60
|
Identificador da chave do Job onde foi processado a chave do documento ou protocolo a ser consultado.(Deve ser usado somente quando um mesmo documento fora processado em Jobs distintos).
|
4
|
|
listaconsulta
|
Lista de protocolos ou chaves de acesso que poderão ser consultadas.
|
G
|
S
|
1
|
|
|
5
|
4
|
consulta
|
Coleção de protocolos/chaves que poderão ser consultadas.
|
G
|
S
|
1..N
|
|
|
6
|
5
|
chaveprotocolo
|
Chave ou protocolo.
|
G
|
S
|
1
|
|
Este grupo somente poderá ter um protocolo ou uma chave de acesso.
|
7
|
6
|
chaveacesso
|
Chave de acesso a ser consultada.
|
C
|
S
|
1
|
44
|
|
8
|
6
|
protocolo
|
Protocolo de consulta.
|
N
|
S
|
1
|
1..14
|
A consulta quando realizada pelo protocolo, permite que sejam retornados todos os status referentes às chaves de acesso que foram processadas com o protocolo pesquisado.
|
9
|
5
|
statusatual
|
Status atual ou não.
|
N
|
N
|
1
|
1
|
1 = somente o status atual do documento constante na base de processamento (status finais de documentos, autorização, cancelamento, rejeições, etc...);
2 = status do documento durante o tempo de vida do mesmo na base de processamento;
3 = Apenas a última iteração (inserções em cold, impressões, etc..).
4 = Somente status de ped-bol.
OBS: Caso a tag não seja informada, o valor assumido será 1
|
10
|
5
|
autoajuste
|
Se estiver ativa, quando o retorno for “CSTAT = 999 – Erro não catalogado”
a aplicação e-Forms Web Services automaticamente deverá solicitar o reprocessamento deste documento.
|
N
|
N
|
1
|
1
|
0 = desativado
1 = ativado
Só será funcional com o valor 1 na tag statusatual.
|
11
|
5
|
retornarchaveoriginalbloqueada
|
Lista a chave original bloqueada caso exista para o documento.
|
N
|
N
|
1
|
1
|
0 = Não traz a chave original.
1 = Traz a chave original caso exista.
|
12
|
5
|
retornarmensagemsefaz
|
Retorna o código e a mensagem da SEFAZ para o emissor (Caso exista).
|
N
|
N
|
1
|
1
|
0 = Não retornar o código e a mensagem da SEFAZ (valor padrão, caso a tag não seja informada).
1 = Retornar código e a mensagem da SEFAZ.
|
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
|
|
|
Como retorno será apresentado uma lista das informações sobre os documentos encontrados na pesquisa, podendo ser: apenas o último status, apenas a última interação ou todas as interações.
Caso a opção "Integrar troca de chaves apenas em caso de autorização/denegação da contingência" no Job NF-e aba "Automatização - Geral" esteja desabilitada, a consulta não irá retornar a troca de chaves ocorrida na automatização do documento.
Para realizar a consulta por status do ped-bol, será necessario usar o campo identificador, chaveacesso e statusatual=4, sera retornado o status apenas quando houver o vinculo de sucesso.
|
Visualizar modelo do retorno da chamada