Função: Este método é destinado ao monitoramento das remessas de NF-e e CT-e recebidas pelo ERP e enviadas para o NeoGrid para validação e retornos recebidos do NeoGrid, para sinalização ao usuário do recebimento de NF-e e CT-e pelo NeoGrid. Este método retorna um máximo de 500kbytes de informação. Caso o lote solicitado gere um valor maior 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 e, sempre que houver, existirão dados a transmitir, se não houver retorno, não haverá mais dados.

 

 

<soap:Body>

<USERTOKEN>STRING</USERTOKEN>

<ID_ENT>STRING</ID_ENT>

<CNPJDESTINICIAL>STRING</CNPJDESTINICIAL>

<CNPJDESTFINAL>STRING</CNPJDESTFINAL>

<DATADE>DATE</DATADE>

<DATAATE>DATE</DATAATE>

<FLAGCOLAB>INTEGER</FLAGCOLAB>

<STATUSDOC>STRING</STATUSDOC>

<MODELO>STRING</MODELO>

<XMLNFECHV>BASE64BINARY</XMLNFECHV>

</soap:Body>

 

Parâmetro

Tipo

Tam

Pai

ObseObservaçã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.

CNPJDESTINICIAL

Alfanumérico

014

-

CNPJ/CPF do fornecedor da NF-e.

CNPJDESTFINAL

Alfanumérico

014

-

CNPJ/CPF do fornecedor da NF-e.

DATADE

Data

 

-

Data de processamento do Arquivo XML da NF-e.

DATAATE

Data

 

-

Data de processamento do Arquivo XML da NF-e.

FLAGCOLAB

Inteiro

001

-

Flag de Exportação. (Ver Observação 1)

1STATUSDOC

inteiro

001

-

Status dos documentos a serem retornados. (Ver Observação 3)

MODELO

Alfanumérico

006

 

Modelo do documento eletrônico.

XMLNFECHV

Binário

1-500k

-

XML com a lista de Ids (Chaves) que devem ser consultadas na tabela SPED060. Quando for informado o XML de Ids no XMLNFECHV, os atributos de CNPJDESTINICIAL, CNPJDESTFINAL, DATADE E DATAATE serão desconsiderados mesmos se informados.

Os atributos FLAGCOLAB, STATUSDOC E MODELO continuam funcionando da mesma forma. (Ver exemplo do XML na Observação 2)

 

<soap:Body>

<MONITORTOTVSCOLAB>

<MONITORTCNFE>

<CANCELADO>STRING</CANCELADO>

<CNPJFOR>STRING</CNPJFOR>

<ID>STRING</ID>

<MODELO>STRING</MODELO>

<MOTIVODOCSEFAZ>STRING</MOTIVODOCSEFAZ>

<STATUS>STRING</STATUS>

<STATUSDOCSEFAZ>STRING</STATUSDOCSEFAZ>

<XMLCANCPROC>STRING</XMLCANCPROC>

<XMLCANCREC>STRING</XMLCANCREC>

<XMLNFEPROC>STRING</XMLNFEPROC>

<XMLNFEREC>STRING</XMLNFEREC>

</MONITORTCNFE>

</MONITORTOTVSCOLAB>

</soap:Body>

 

ParâmetroTipoTamPaiObservação
MONITORTOTVSCOLABEstrutura ---
MONITORTCNFEMatriz[n]-Monitor-
CANCELADOAlfanumérico-MONITORTCNFE-
CNPJFORAlfanumérico014MONITORTCNFECNPJ do Fornecedor.
IDAlfanumérico1-250MONITORTCNFEIdentificação da NF-e.
MODELOAlfanumérico1- 6MONITORTCNFEModelo do documento eletrônico.
MOTIVODOCSEFAZ Alfanumérico1-250MONITORTCNFEMotivo do documento na SEFAZ.
STATUS Alfanumérico    001MONITORTCNFE

Status de transmissão da NF-e:

1 - Documento recebido;

2 - Documento transmitido;

3 - Documento não processado;

4 - Documento processado;

5 - Documento rejeitado.

STATUSDOCSEFAZAlfanumérico003MONITORTCNFECódigo do status do documento na SEFAZ.
XMLCANCPROCBinário1-500kMONITORTCNFXML da NF-e cancelada validada.
XMLCANCRECBinário1-500kMONITORTCNFEXML da NF-e Cancelada recebida.
XMLNFEPROCBinário1-500kMONITORTCNFEXML da NF-e validada.
XMLNFERECBinário1-500kMONITORTCNFEXML da NF-e recebida.
FaultDescrição
Invalid TokenO parâmetro USERTOKEN foi passado incorretamente.
1Código da entidade inválida.
2Código da entidade em branco.
3Entidade não configurada para utilizar TOTVS COLABORAÇÃO.

Conteúdos possíveis sobre o Atributo flagColab: 

0 – Retorna sempre os primeiros registros encontrados, limitando à 500Kb.

1 – Retorna os primeiros registros, limitando à 500Kb, e seta estes registros com STATUS que não serão mais alterados pelo TSS (3 - Documento não processado; 4 - Documento processado e 5 - Documento rejeitado) como já exportados, para que na próxima chamada do método sejam retornados registros que ainda não foram exportados.

2- Retorna sempre os primeiros registros, mas seta todos os registros como não exportados.

Vazio – assume a mesma funcionalidade que o conteúdo 0.

 

Exemplo:

Existem as notas de 1 à 65 para serem retornadas. Somando os bites de todas as notas serão 800 Kb (800000bites). Dessa forma, não seria possível retornar todas as notas na mesma chamada. Então, existem as seguintes opções:

  • FlagColab = 0
    Serão retornadas sempre as notas de 1 a 32, cuja soma é 450kb. Não importa quantas vezes seja chamado o método, sempre que for passado 0 haverá o retorno das notas de 1 a 32.
     
  • FlagColab = 1
    Serão retornadas na primeira chamada as notas 1 a 32; na segunda chamada as notas de 33 a 65; e na terceira chamada não existirá mais retorno.
     
  • FlagColab = 2
    Serão retornadas sempre as notas de 1 a 32, cuja soma é 450kb. Não importa quantas vezes seja chamado o método, sempre que for passado a opção 2, teremos o retorno das notas de 1 a 32. A diferença do conteúdo 2 para o 0 é que no 2 o TSS seta todas as notas que estavam marcadas como Exportadas para Não Exportadas, podendo assim chamar novamente o método com o FlagColab = 1, que teremos todos os retornos novamente.
     
  • FlagColab = Vazio
    Tem a mesma funcionalidade que FlagColab=0.

Exemplo que deve ser enviado no atributo XMLNFECHV:

 

<NOTAS>

<NFESID>

                       <CHV>42111053113791000637550000000002020168504909</CHV>

                </NFESID>

<NFESID>

                               <CHV>21101110312991000100550130000000341002222252</CHV>

                </NFESID>

<NFESID>

                               <CHV>21101110312991000100550130000000141002222233</CHV>

                </NFESID>

</NOTAS>

Parâmetro StatusDoc:

Define filtro para os Status que serão considerados para o retorno. Caso seja informado mais de um Status, os valores deverão ser delimitados por “,”.

Exemplo:

Caso sejam informados os Status “4,5”, serão retornados apenas os documentos autorizados e rejeitados. Caso não informado,o valor default será todos os registros.