Função: Método destinado ao monitoramento das remessas de NFe, CTe, MDFe e NFCe e retornos recebidos da SEFAZ para sinalização ao usuário. Este método retorna um máximo de 500kbytes de informação. Caso o lote solicitado gere um valor maior do que este, o sistema limitará o retorno em 500kbytes e a aplicação deve verificar que há itens faltantes e realizar nova chamada até não haver mais itens. Uma opção eficiente é verificar se houve retorno. Sempre que houver, existirá dados a transmitir, isto é, se não houver retorno, não haverá mais dados.



<soap:Body>

<USERTOKEN>STRING</USERTOKEN>

<ID_ENT>STRING</ID_ENT>

<IDINICIAL>STRING</IDINICIAL>

<IDFINAL>STRING</IDFINAL>

<MODELO>STRING</MODELO>

</soap:Body>


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.

IDINICIAL

Alfanumérico

1-250

-

Número de identificação inicial da NF-e que deverá ser retornada.

IDFINAL

Alfanumérico

1-250

-

Número de identificação final da NF-e que deverá ser retornada.

MODELO

Alfanumérico

002

-

Modelo da nota a ser monitorada.

Os valores possíveis são:

55 – NF-e;

57 – CT-e;

58 – MDF-e

65 – NFC-e

Por padrão serão retornadas todas as notas.


 

<soap:Body> 
<MONITOR> 
<MONITORNFE> 
<AMBIENTE>INTEGER</AMBIENTE> 
<ERRO> 
<LOTENFE> 
<CODENVLOTE>STRING</CODENVLOTE> 
<CODRETNFE>STRING</CODRETNFE> 
<CODRETRECIBO>STRING</CODRETRECIBO> 
<DATALOTE>DATE</DATALOTE> 
<HORALOTE>STRING</HORALOTE> 
<LOTE>INTEGER</LOTE> 
<MSGENVLOTE>STRING</MSGENVLOTE> 
<MSGRETNFE>STRING</MSGRETNFE> 
<MSGRETRECIBO>STRING</MSGRETRECIBO> 
<RECIBOSEFAZ>INTEGER</RECIBOSEFAZ> 
</LOTENFE> 
</ERRO> 
<FRENTE_VERSO>STRING</FRENTE_VERSO>
<ID>STRING</ID>
<MODALIDADE>INTEGER</MODALIDADE>
<MODELO>STRING</MODELO>
<NUMERO_VIAS>INTEGER</NUMERO_VIAS>
<PATHIMPRESSAO>STRING</PATHIMPRESSAO>
<PROTOCOLO>STRING</PROTOCOLO>
<RECOMENDACAO>STRING</RECOMENDACAO>
<TEMPODEESPERA>STRING</TEMPODEESPERA> 
<TEMPOMEDIOSEF>INTEGER</TEMPOMEDIOSEF>

<WS01CONSUMOINDEVIDO>

            <OBSERVACAO>STRING</OBSERVACAO>

            <TENTATIVAS>STRING</TENTATIVAS>

         </WS01CONSUMOINDEVIDO>
</MONITORNFE> 
</MONITOR>
</soap:Body>   


ParâmetroTipoTamPaiObservação
MonitorEstrutura---
MonitorNFeMatriz[n]-Monitor-
AMBIENTEInteiro001MonitorNFeAmbiente de operação da NF-e.
ERROEstrutura-MonitorNFe-
LOTENFEMatriz[n]-ERRO-
CODENVLOTEAlfanumérico 003LOTENFECódigo de envio do lote da NF-e retornado pela SEFAZ.
CODRETNFEAlfanumérico003LOTENFECódigo do retorno de processamento da NF-e retornado pela SEFAZ.
CODRETRECIBOAlfanumérico003LOTENFECódigo do retorno de processamento do lote.
DATALOTEData-LOTENFEData de geração do Lote.
HORALOTEAlfanumérico008LOTENFEHora de geração do Lote.
LOTEAlfanumérico015LOTENFENúmero do lote de transmissão.
MSGENVLOTEAlfanumérico1-250LOTENFEMensagem de envio do lote da NF-e retornada pela SEFAZ.
MSGRETNFEAlfanumérico1-250LOTENFEMensagem de retorno de processamento da NF-e retornado pela SEFAZ.
MSGRETRECIBOAlfanumérico1-250LOTENFEMensagem de retorno da SEFAZ após o processamento do lote.
RECIBOSEFAZInteiro015LOTENFENúmero do recibo de entrega na SEFAZ.
FRENTE_VERSOAlfanumérico
MonitorNFeIndica impressão frente e verso.
IDAlfanumérico1-250MonitorNFeIdentificação da NF-e.
MODALIDADEInteiro001MonitorNFeCódigo da modalidade de operação.
MODELOAlfanumérico002MonitorNfe

Modelo da nota retornada.

Os valores possíveis são: 55 – NF-e; 57 – CT-e; 58 – MDF-e; 65 – NFC-e.

NUMERO_VIASInteiro-MonitorNfeNúmero de vias impressas.
PATHIMPRESSAOAlfanumérico1-100MonitorNfeDiretório de impressão.
PROTOCOLOAlfanumérico0-15MonitorNFeNúmero do protocolo da NF-e para cancelamento, inutilização e autorização.
RECOMENDACAOAlfanumérico1-250MonitorNFeMensagem do sistema sobre os procedimentos que o usuário deverá tomar.
TEMPODEESPERAAlfanumérico005MonitorNFeTempo decorrido desde a última colocação da NF-e no TOTVS Service Sped.
TEMPOMEDIOSEFInteiro004MonitorNFeTempo médio de processamento informado pela SEFAZ na transmissão do Lote da NF-e.
WS01CONSUMOINDEVIDOEstrutura-

MonitorNFe

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.


Observações quanto ao MODELO:

1) A entrada do método deverá conter um novo parâmetro opcional dizendo qual o modelo de nota a ser monitorada.

2) Caso o parâmetro não seja enviado, retornarão todas as notas independentes do modelo.

3) O retorno do método deverá conter uma propriedade obrigatória para cada nota retornada, informando qual o modelo dela.

FaultDescrição
Invalid TokenO parâmetro USERTOKEN foi passado incorretamente.
001Código da entidade inválida.
002Código da entidade em branco.
003Limite de notas excedido. Máximo permitido 200 notas.