Exibir origem

Função: Método destinado a verificação do Status do Email de Distribuição de Documentos Eletrônicos (Modelos 55 e 57).

O serviço tem como filtro pré definido, apenas os documentos autorizados e emitidos dentro do período de 30 dias.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfs="http://webservices.totvs.com.br/nfsebra.apw">
  <soapenv:Header/>
  <soapenv:Body>
    <nfs:STATUSDISTRIBUICAODEDOCUMENTOS>
      <nfs:USERTOKEN>Character</nfs:USERTOKEN>
      <nfs:ID_ENT>Numérico</nfs:ID_ENT>  
      <nfs:STATUSDISTMAIL>
        <nfs:MODELO>Alfanumérico</nfs:MODELO>
        <nfs:SEQUENCIA>Numérico</nfs:SEQUENCIA>
        <!--Optional:-->
        <nfs:STATUS>Numérico</nfs:STATUS>
      </nfs:STATUSDISTMAIL>
    </nfs:STATUSDISTRIBUICAODEDOCUMENTOS>
  </soapenv:Body>
</soapenv:Envelope>

Parâmetro	Tipo	Tam	Pai	Observação
USERTOKEN	Alfanumérico	6	-	Token de bilhetagem para execução do serviço.
ID_ENT	Alfanumérico	6	-	Código da entidade retornado pelo WS SpedAdm/AdmEmpresas.
STATUSDISTMAIL	Estrutura	-	-	Tag Raiz.
MODELO	Alfanumérico	10	STATUSDISTMAIL	Modelo do documento eletrônico Modelos válidos: 55 (NFe). 57 (CTe).
SEQUENCIA	Numérico	1-16	STATUSDISTMAIL	Sequencia do retorno. Utilizado como marcador(paginação) de retorno da consulta. Default = 1
STATUS	Numérico	1	STATUSDISTMAIL	Status a ser filtrado no retorno da consulta. 0= Aguardando solicitação 1= Solicitação já realizada 2= Distribuição Realizada 3=Falha na Distribuição

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <STATUSDISTRIBUICAODEDOCUMENTOSRESPONSE xmlns="http://webservices.totvs.com.br/nfsebra.apw">
      <STATUSDISTRIBUICAODEDOCUMENTOSRESULT> 
        <CONTINUA>Lógico</CONTINUA>
        <DOCUMENTOS>
          <STATUSDOCMAIL>
            <DATA>Data</DATA>
            <DESCRICAO>AlfaNumérico</DESCRICAO>
            <DOC_ID>Alfanumérico</DOC_ID>
            <STATUS>Numérico</STATUS>
          </STATUSDOCMAIL> 
        </DOCUMENTOS>
      </STATUSDISTRIBUICAODEDOCUMENTOSRESULT>
    </STATUSDISTRIBUICAODEDOCUMENTOSRESPONSE>
  </soap:Body>
</soap:Envelope>

Parâmetro	Tipo	Tam	Pai	Observação
	Estrutura	-		Tag Raiz.
STATUSDISTRIBUICAODEDOCUMENTOSRESULT	Estrutura	-	STATUSDISTRIBUICAODEDOCUMENTOSRESPONSE	Tag Raiz.
CONTINUA	Lógico	-	STATUSDISTRIBUICAODEDOCUMENTOSRESULT	Indica se deve ser feita uma nova consulta para retorno, e próximos itens que contemplam a consulta. O limite de retorno para cada consulta são de 1000 registros. Esse retorno deverá ser utilizado para a definição do parâmetro "SEQUENCIA" informado na solicitação da consulta de status de distribuição.
DOCUMENTOS			STATUSDISTRIBUICAODEDOCUMENTOSRESULT	Estrutura da lista de informações dos documentos.
STATUSDOCMAIL	Estrutura	-	DOCUMENTOS	Lista de documentos.
DATA	Data	10	STATUSDOCMAIL	Data de registro do documento na base de dados do TSS.
DESCRICAO	Alfanumérico	-	RETSTATUSDISTMAIL	Detalhes do status do Email de distribuição do documento.
DOC_ID	Inteiro	02	RETSTATUSDISTMAIL	Id de identificação do documento no TSS.
STATUS	Inteiro	1-250	RETDOCUMENTSDIST	Status do Email de distribuição do documento.

Fault	Descrição
Invalid Token	O parâmetro USERTOKEN foi passado incorretamente.
001	Código da entidade inválida.
002	Código da entidade em branco.
003	Modelo inválido. Modelos permitidos: 55, 57
004	Status inválido. 1=Pendente; 2=Distribuído; 3=Falha na Distribuição

Código	Descrição
001	Aguardando solicitação para distribuição do Email
100	Enviado para fila de transmissão
200	Distribuído
300	Falha na distribuição
400	Documento não localizado ou com status inválido para distribuição de Email

Envio:

TSS > Método - StatusDistribuicaoDeDocumentos > image2019-6-18_16-19-48.png

Retorno:

TSS > Método - StatusDistribuicaoDeDocumentos > image2019-6-18_16-20-40.png