Função: Método utilizado para consultar a situação atual da NF-e, CT-e, MDF-e e NFC-e na base de dados da SEFAZ de origem. Este método deve ser utilizado quando houver necessidade de consultar a situação da NFe por exigência da SEFAZ de origem, durante a fase de homologação. Em condições normais de uso, torna-se desnecessária a sua utilização.


 
<soap:Body>
<USERTOKEN>STRING</USERTOKEN>
<ID_ENT>STRING</ID_ENT>
<NFECONSULTAPROTOCOLOID>STRING</NFECONSULTAPROTOCOLOID>
</soap:Body>
</soap:Envelope>


Parâmetro

Tipo

Tam

Pai

Observação

USERTOKEN

Alfanumérico

006

-

Token de bilhetagem para execução do serviço.

ID_ENT

Alfanumérico

006

-

Código da entidade retornado pelo WS SpedAdm/AdmEmpresas.

NFECONSULTAPROTOCOLOID

Alfanumérico

1-250

-

Id de identificação do XML da NFe com o ERP. Este número será sempre informado ou solicitado pelo TOTVS Services Sped para fornecer informações sobre o status atual da NFe. É recomendado para o ERP enviar o número da chave de acesso da NFe, caso utilize uma base de dados 100% volátil. Deve ser passado um conteúdo neste parâmetro ou no parâmetro CCHVNFE.


<NFEPROTOCOLO>

<AMBIENTE>INTEGER</AMBIENTE>

<CODRETNFE>STRING</CODRETNFE>

<DIGVAL>STRING</DIGVAL>

<ID>STRING</ID>

<MSGRETNFE>STRING</MSGRETNFE>

<PROTOCOLO>STRING</PROTOCOLO>

<RECBTO>DATE</RECBTO>

<VERSAO>STRING</VERSAO>

<WS01CONSUMOINDEVIDO>

         <OBSERVACAO>STRING</OBSERVACAO>

         <TENTATIVAS>STRING</TENTATIVAS>

      </WS01CONSUMOINDEVIDO>

</NFEPROTOCOLO>


Parâmetro

Tipo

Tam

Pai

Observação

NFEPROTOCOLO

Estrutura

-

-

AMBIENTE

Inteiro

1

NFEPROTOCOLO

Ambiente de processamento da NF-e. Produção ou homologação.

CODRETNFE

Alfanumérico

3

NFEPROTOCOLO

Código do retorno de processamento da NF-e retornado pela SEFAZ.

DIGVAL

Alfanumérico


NFEPROTOCOLO

Digito de validação.

ID

Alfanumérico

1-250

NFEPROTOCOLO

Id de identificação do XML da NF-e com o ERP.

MSGRETNFE

Alfanumérico

1-250

NFEPROTOCOLO

Mensagem de retorno de processamento da NFe retornado pela SEFAZ.

PROTOCOLO

Alfanumérico

15

NFEPROTOCOLO

Número do protocolo da NF-e para cancelamento, inutilização e autorização.

RECBTO

Data

-

NFEPROTOCOLO

Data de processamento. 

VERSAO

-

1-20

NFEPROTOCOLO

Versão em que foi processada a NF-e.
WS01CONSUMOINDEVIDOEstrutura-

NFEPROTOCOLO

Estrutura referente a Consumo Indevido.
OBSERVACAOAlfanumérico200WS01CONSUMOINDEVIDOMensagem de retorno do TSS caso ocorra o atingimento do máximo de tentativas de execução do método em questão.
TENTATIVASAlfanumérico5WS01CONSUMOINDEVIDORetorna a contagem de tentativas de execução do método em questão.
FaultDescrição
Invalid TokenO parâmetro USERTOKEN foi passado incorretamente.
001Código da entidade inválida.
002Código da entidade em branco.
003Falha de execução da consulta na SEFAZ.
004Nota fiscal eletrônica não encontrada.