Páginas filhas
  • ER_DocumentoAuxiliar_ERP_Enviada_por_E_mail_NFE_CTE

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

 Este documento é material de especificação dos requisitos de manutenção, trata-se de conteúdo extremamente técnico.                                                             

  

Informações Gerais 

Especificação

Produto

TSS

Módulo

NF-e 

Segmento Executor

Serviços

Chamado/ISSUE

DSERTSS1-12326

País

( X ) Brasil  (  ) Argentina  (  ) México  (  ) Chile  (  ) Paraguai  (  ) Equador

(  ) USA  (  ) Colômbia   (  ) Outro _____________.

Indice:

  • Objetivo

  • Regras de Negócio

  • Web Services

  • Monitoramento

  • Web Services e Métodos do TSS

Objetivo

Demonstrar as implementações no Envio de DANFE do ERP por E_mail.

Este documento tem por objetivo a definição das especificações e critérios técnicos necessários para a implementação dos eventos "StatusDistribuicaoDeDocumentos" e "DistribuicaoDeDocumentos"

Atualmente estes eventos serão implementados inicialmente para a NF-e (modelo 55).



Regras de Negócio

     O Evento de "StatusDistribuicaoDeDocumentos " foi criado para verificação do Status do Email de Distribuição de Documentos Eletrônicos (Modelo 55).

        O serviço carrega apenas os documentos autorizados e emitidos dentro do período de 30 dias para os Status 1, 2 e 3.


       O Evento de "DistribuicaoDeDocumentos " foi criado para o envio de E-mail de Distribuição dos Documentos Eletrônicos processados pelo TSS. Através da utilização dos parâmetros "MV_AUTDIST",

    disponibilizado no método "CFGPARAMSPED" para o serviço "SPEDCFGNFE", os ERP´s poderão desabilitar a distribuição automática feita pelo TSS.

      Quando o parâmetro estiver desabilitado, o TSS aguarda que o ERP faça a solicitação da distribuição.


        Este serviço visa atender as seguintes  demandas:

  •     Permitir que os ERP´s enviem o arquivo impresso (PDF)  para a distribuição;
  •    Permitir a redistribuição dos Documentos (XML e DANFE) a qualquer momento;
  •    Permitir o envio da lista de destinatários para a distribuição.

Web Services e Métodos do TSS

Serão utilizados os métodos dos Web Services abaixo:


Serviço: NFESBRA

  • Método: DISTRIBUICAODEDOCUMENTOS

      Método destinado ao envio de E-mail de Distribuição dos Documentos Eletrônicos processados pelo TSS. Através da utilização do parâmetro "MV_AUTDIST" disponível no método "CFGPARAMSPED" para o serviço "SPEDCFGNFE",
os ERP´s poderão desabilitar a distribuição automática feita pelo TSS.


Os parâmetros de entrada do método são:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nfs="http://webservices.totvs.com.br/nfsebra.apw">
<soapenv:Header/>
<soapenv:Body>
<nfs:DISTRIBUICAODEDOCUMENTOS>
<nfs:USERTOKEN>?</nfs:USERTOKEN>
<nfs:ID_ENT>?</nfs:ID_ENT>
<nfs:DISTEMAIL>
<nfs:LISTADOCUMENTOS>
<!--Zero or more repetitions:-->
<nfs:DOCUMENTOS>
<!--Optional:-->
<nfs:EMAIL>?</nfs:EMAIL>
<nfs:NFE_ID>?</nfs:NFE_ID>
<!--Optional:-->
<nfs:PDF>cid:1076726658018</nfs:PDF>
<!--Optional:-->
<nfs:RETRANSMITIR>?</nfs:RETRANSMITIR>
<!--Optional:-->
<nfs:TIPOCOMPRESSAO>?</nfs:TIPOCOMPRESSAO>
</nfs:DOCUMENTOS>
</nfs:LISTADOCUMENTOS>
<nfs:MODELO>?</nfs:MODELO>
</nfs:DISTEMAIL>
</nfs:DISTRIBUICAODEDOCUMENTOS>
</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.

DISTEMAIL

Estrutura

-

 -

Tag Raiz.

LISTADOCUMENTOSEstrutura-DISTEMAILTag Raiz.

DOCUMENTOS

Estrutura

-

LISTADOCUMENTOS


EMAIL

Alfanumérico

250

LISTADOCUMENTOS

Contas de e-mail. Separar endereço(s) por ponto-e-vírgula. Ex: [email protected];nfe2@totvs.com.br.

NFE_ID

Alfanumérico

-

LISTADOCUMENTOS

ID da nota fiscal eletrônica.

PDF

Base64Binary

-

LISTADOCUMENTOS

PDF a ser utilizado na distribuição via e-mail.

RETRANSMITIRLógico-LISTADOCUMENTOSForçar envio do e-mail, independente do status de envio de e-mail atual.
TIPOCOMPRESSAOAlfanumérico
LISTADOCUMENTOS

Tipo de compressão a ser utilizado. Fixo "zip".

Obs. Caso informado, o nome do arquivo deverá ser o Id documento informado no parâmetro NFE_ID da requisição.

MODELOAlfanumérico10DISTEMAIL

Modelo do documento eletrônico.

Modelos válidos: 55 (NFe).


Soap Fault


FaultDescrição
Invalid TokenO parâmetro USERTOKEN foi passado incorretamente.
001Código da entidade inválida.
002Código da entidade em branco.
003

Modelo inválido. Modelos permitidos: 55


Exemplos: 

Envio:                                                                                                                                         

Image Modified

 Retorno:

Image Modified


Serviço: NFESBRA

  • Método: STATUSDISTRIBUICAODEDOCUMENTOS

     Método destinado a verificação do Status do Email de Distribuição de Documentos Eletrônicos (Modelo 55).

Os parâmetros de entrada do método são:

<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.

MODELOAlfanumérico10STATUSDISTMAIL

Modelo do documento eletrônico

Modelos válidos: 55 (NFe).

SEQUENCIANumérico1-16STATUSDISTMAIL

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 Fault


Fault

Descrição

Invalid TokenO parâmetro USERTOKEN foi passado incorretamente.
001Código da entidade inválida.
002Código da entidade em branco.
003

Modelo inválido. Modelos permitidos: 55

004

Status inválido. 1=Pendente; 2=Distribuído; 3=Falha na Distribuição


Exemplos:

 Envio:

Image Added


Retorno:

Image Added


 Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico.