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 e DSERTSS1-17397
País	( X ) Brasil ( ) Argentina ( ) México ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colômbia ( ) Outro _____________.

Índice:

Objetivo
Regras de Negócio
Web Services e Métodos do TSS

Objetivo

Demonstrar as implementações no Envio de DANFE ou DACTE do ERP por E-mail disparado pelo TSS.

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

Atualmente estes métodos atendem aos documentos NF-e (modelo 55) e CT-e (modelo 57)

Regras de Negócio

O Método de "StatusDistribuicaoDeDocumentos " foi criado para verificação do Status do Email de Distribuição de Documentos Eletrônicos (Modelos disponíveis: 55 e 57).

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

Legenda Status:

0 - Aguardando envio do E-MAIL do Documento Auxiliar (NF-e = DANFE ou CT-e = DACTE) do ERP
1 - Aguardando envio do E-MAIL TSS (XML ou XML e PDF)
2 - E-mail enviado com sucesso
3 - Erro no envio do E-mail

O Método 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" ou "MV_AUTDCTE", disponibilizado no método "CFGPARAMSPED" para o serviço "SPEDCFGNFE", o ERP poderá habilitar e 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 o ERP envie o arquivo impresso (PDF) para a distribuição;
Permitir a redistribuição dos Documentos (XML e DANFE ou DACTE) a qualquer momento conforme o documento enviado na DistribuicaodeDocumentos;
Permitir o envio da lista de destinatários para a distribuição.

Importante: Se o parâmetro NFEDISD estiver com o valor 01 (um) e AUTDIST estiver desativado, ou seja com o valor igual a 0 (zero), o TSS irá ficar aguardando a requisição do ERP para disparo do e-mail.

Cada modelo de documento eletrônico terá um parâmetro em específico para ser configurado em conjunto com o parâmetro NFEDISD.

Para NF-e, o parâmetro utilizado será o AUTDIST

NFEDISD	AUTDIST	XML	DANFE TSS (PDF)	DANFE ERP (PDF)
0	1	X	-	-
1	1	X	X	-
1	0	X	-	X

Para CT-e, o parâmetro será o AUTDCTE

NFEDISD	AUTDCTE	XML	DACTE TSS (PDF)	DACTE ERP (PDF)
0	1	X	-	-
1	1	X	X	-
1	0	X	-	X

MV_SMTPCTE

Para utilizar essa configuração para habilitar ou desabilitar a distribuição de e-mail para CT-e, o parâmetro MV_SMTPCTE precisa estar DESATIVADO

Web Services e Métodos do TSS

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

Serviço: SPEDCFGNFE

Método: CFGPARAMSPED

Este método deve ser utilizado para informar qual a configuração dos parâmetros de funcionamento do TSS.

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

<soap:Body>
	<USERTOKEN>STRING</USERTOKEN>
	<ID_ENT>STRING</ID_ENT>
	<USACOLAB>STRING</USACOLAB>
	<NUMRETNF>INTEGER</NUMRETNF>
	<AMBIENTE>INTEGER</AMBIENTE>
	<MODALIDADE>INTEGER</MODALIDADE>
	<VERSAONFE>STRING</VERSAONFE>
	<VERSAONSE>STRING</VERSAONSE>
	<VERSAODPEC>STRING</VERSAODPEC>
	<VERSAOCTE>STRING</VERSAOCTE>
	<USERNEOG>STRING</USERNEOG>
	<PASSWORD>BASE64BINARY</PASSWORD>
	<CONFALL>STRING</CONFALL>
	<DOCSCOL>STRING</DOCSCOL>
	<AMBNFECOLAB>INTEGER</AMBNFECOLAB>
	<AMBCTECOLAB>INTEGER</AMBCTECOLAB>
	<CFGPARAMDOC>
		<PARAMDOC>
			<CFGDOC>
				<DOCUMENTOAMBIENTE>INTEGER</DOCUMENTOAMBIENTE>
				<DOCUMENTOMODELO>INTEGER</DOCUMENTOMODELO>
			</CFGDOC>
			<CFGDOC>
				<DOCUMENTOAMBIENTE>INTEGER</DOCUMENTOAMBIENTE>
				<DOCUMENTOMODELO>INTEGER</DOCUMENTOMODELO>
			</CFGDOC>
		</PARAMDOC>
	</CFGPARAMDOC>
	<NFECANCEVENTO>BOOLEAN</NFECANCEVENTO>
	<NFEDISTRDANFE>STRING</NFEDISTRDANFE>
	<NFEENVEPEC>STRING</NFEENVEPEC>
	<AUTODISTR>STRING</AUTODISTR>
    <CFGAUTODIST>
      <PARAMDIST>
        <!--Zero or more repetitions:-->
        <CFGAUTO>
          <ENABLE>STRING</sped:ENABLE>
          <MODELO>STRING</sped:MODELO>
        </CFGAUTO>
      </PARAMDIST>
    </CFGAUTODIST>
	<CFGDOCMAIL>
		<DOCMAIL>
			<DETDOCMAIL>
				<ENVEMAIL>INTEGER</ENVEMAIL>
				<MODELO>INTEGER</MODELO>
			</DETDOCMAIL>
		</DOCMAIL>
	</CFGDOCMAIL>
</soap:Body>

Parâmetro	Tipo	Tam	Pai	Observação
USERTOKEN	Alfanumérico	06	-	Token de bilhetagem para execução do serviço.
ID_ENT	Alfanumérico	06	-	Código da entidade retornado pelo WS SpedAdm/AdmEmpresas.
USACOLAB	Alfanumérico	01	-	Indica se o TSS realizará a INTEGRAÇÃO com a NEOGRID (TOTVS COLABORAÇÃO). Caso seja passado Sim, indica que a integração deve ser realizada, caso contrário (Não) a integração não será feita.
NUMRETNF	Inteiro	03	-	Indica quantas notas retornarão da Integração com a NeoGrid a cada solicitação do TSS. Exemplo: Caso seja passado 10, sempre que o TSS chamar o Método de Retorno de Notas da Neogrid, ele retornará 10 notas. Observação: Caso a empresa utilize notas com muitos itens e gere um XML muito grande, este número deve ser reduzido para que o TSS suporte o retorno.
AMBIENTE	Inteiro	01	-	Informe 1 para produção, 2 para homologação ou 0 para saber a configuração atual do ambiente.
MODALIDADE	Inteiro	01	-	Modalidades da NF-e: 0-Configuração; 1-Normal; 2-Contingência off-line; 3-Contingência SCAN; 4-Ambiente Nacional; 5-EPEC; 6-SEFAZ Virtual; 7-Contingência FS-DA; 8-Contingência SVC-AN; 9-Contingência SVC-RS.
VERSAONFE	Alfanumérico	04	-	Informe: 0.00-Configuração; 9.99; 2.00; 3.10
VERSAONSE	Alfanumérico	04	-	Informe: 0.00-Configuração; 9.99; 1.00
VERSAODPEC	Alfanumérico	04		Informe: 0.00-Configuração; 9.99; 1.01
VERSAOCTE	Alfanumérico	04	-	Informe: 0.00-Configuração; 9.99 2.00 3.00
VERSAONF3E	Alfanumérico	04		0.00-Configuração; 9.99 1.00
USERNEOG	Alfanumérico		-	Usuário de acesso http, que será responsável pela comunicação do TSS com WS da NeoGrid.
PASSWORD	Binário		-	Senha do Usuário de acesso HTTP, que será responsável pela comunicação do TSS com WS da NeoGrid.
CONFALL	Alfanumérico		-	Sim – para habilitar e Não – para desabilitar. Habilita a confirmação de todos os Documentos recebidos da NeoGrid. Este parâmetro deve ser utilizado somente se houver muitos documentos retornando da NeoGrid, impedindo que novos documentos enviados pelo ERP retornem. Habilitando este parâmetro, o processo poderá ficar mais lento. Foi necessária a criação deste parâmetro pois, por meio do portal da Nota Fiscal Eletrônica e CTE da NeoGrid, é possível que solicitar manualmente o retorno das notas para o ERP e, ao chegar este retorno ao TSS, se a nota já estiver autorizada e confirmada, acaba bloqueando o retorno de novos documentos.
DOCSCOL	Alfanumérico		-	Informe, separando por vírgula, quais documentos devem ser processados pelo TOTVS Colaboração. Sendo: 0- Todos; 1- Emissão de NF-e; 2- Emissão de CT-e; 3- Emissão de NFS-e; 4- Nenhum; 5- Carta de correção; 6- MD-e; 7- MDF-e; Exemplo: Caso queira que a emissão de NF-e e Emissão de CT-e seja feita pelo TOTVS Colaboração, o conteúdo deste campo deve ser: 1,2
AMBNFECOLAB	INTEGER	01	-	Informe 1 para produção, 2 para homologação ou 0 para saber a configuração atual do ambiente.
AMBCTECOLAB	INTEGER	01	-	Informe 1 para produção, 2 para homologação ou 0 para saber a configuração atual do ambiente.
CFGPARAMDOC	Estrutura	Estrutura		--
PARAMDOC	Estrutura	Estrutura	CFGPARAMDOC	--
CFGDOC	Estrutura	Estrutura	PARAMDOC	--
DOCUMENTOAMBIENTE		-	CFGDOC	Configuração de ambiente do documento.
DOCUMENTOMODELO		-	CFGDOC	Modelo do documento.
NFECANCEVENTO	Booleano	-	-	Indica se o cancelamento será realizado por evento ou não.
NFEDISTRDANFE	Alfanumérico	01	-	Informa se no e-mail de distribuição do XML da NF-e ao destinatário do documento, será encaminhado o DANFE impresso em arquivo. Os valores possíveis são: 0 – Não enviar DANFE. 1 – Enviar DANFE.
NFEENVEPEC	Alfanumérico	01	-	Habilita o envio do evento EPEC para a NF-e versão 3.10 0- Não; 1- Sim Observação: Caso o parâmetro não seja informado, será considerado o valor 0- Não.
AUTODISTR	Alfanumérico	01	-	Indica se o TSS sera responsável pelo envio do documento (Ex: DANFE da nfe). Os valores possíveis são: 1 – O TSS será responsável pelo envio do documento. 0 – O TSS não será responsável pelo envio do documento ficando a cargo do ERP.
CFGDOCMAIL	Estrutura	Estrutura	-	--
DOCMAIL	Estrutura	Estrutura	CFGDOCMAIL	--
DETDOCMAIL	Estrutura	Estrutura	DOCMAIL	--
ENVEMAIL	Inteiro	01	DETDOCMAIL	Configuração de envio de e-mail para o modelo de documento: 0-Desabilitado envio de e-mail para os documentos do modelo informado na TAG MODELO deste grupo. 1- Habilitado envio de e-mail para os documentos do modelo informado na TAG MODELO deste grupo (comportamento padrão do produto). Obs.: Esta configuração somente é aplicada para a entidade informada ID_ENT
MODELO	Inteiro	02	DETDOCMAIL	Numero do modelo do documento a ser habilitado ou desabilitado para envio de e-mail. Modelos válidos: 57- Conhecimento de Transporte Eletrônico (CT-e)
CFGAUTODIST	Estrutura	Estrutura	-	--
PARAMDIST	Estrutura	Estrutura	CFGAUTODIST	--
CFGAUTO	Estrutura	Estrutura	PARAMDIST	Indica se o TSS será responsável pelo envio do documento eletrônico por e-mail (XML e DANFE ou DACTE) Essa configuração substituirá a AUTODISTR, que se tornará obsoleta.
ENABLE	Alfanumérico	01	CFGAUTO	Opções disponíveis: 1 - O TSS será responsável pelo envio de e-mail do documento (XML e documento auxiliar) 0 - O TSS não será responsável pelo envio do documento ficando a cargo do ERP.
MODELO	Alfanumérico	02	CFGAUTO	Informar o modelo do documento eletrônico que receberá a configuração para habilitar ou desabilitar o envio do documento eletrônico por e-mail Modelos válidos: 55 - NF-e 57 - CT-e

CFGAUTODIST

Essa estrutura foi criada com objetivo de realizar a configuração de distribuição de e-mail, tanto para o modelo 55 como modelo 57, substituindo a estrutura anterior AUTODISTR que atendia apenas ao modelo 55.

Diante disso, as informações passadas através do parâmetro CFGAUTODIST serão priorizadas sobre a do parâmetro AUTODISTR.

Caso ambos sejam preenchidos, somente o CFGAUTODIST será considerado.

Os parâmetros de saída do método são:

<soap:Body>

   <MSG>STRING</MSG>

</soap:Body>

Parâmetro

Tipo

Tam

Pai

Observação

MSG

Alfanumérico

255

-

Mensagem de configuração com sucesso, por parâmetro:

Exemplo1: Caso sejam passados todos os parâmetros:

001 - Configuração do Ambiente : Ok

002 - Configuração da Modalidade: Ok

003 - Configuração da Versão da NF-e: Ok

004 - Configuração da Versão da NFs-e: Ok

005 - Configuração da Versão do DPEC: Ok

006 - Configuração da versão do CT-e: Ok

007 - Configuração da Colaboração: Ok

008 - Configuração de Número de Retorno de Notas: Ok

009 - Configuração da Autenticação HTTP: Ok

010 - Confirmação de Todos os documentos Ativada.

019 - Configuração para executar a distribuição automática de envio de e-mail do modelo [57]: Ok
019 - Configuração para não executar a distribuição automática de envio de e-mail do modelo [55]: Ok

020 - Configuração para não envio de e-mail dos documentos modelo [57]: Ok

Exemplo 2: Caso sejam passados apenas os parâmetros USACOLAB e NUMRETNF e os demais em branco:

007 - Configuração da Colaboração: Ok

008 - Configuração de Número de Retorno de Notas: Ok

009 – Configuração de Documentos: OK.

010 - Confirmação de Todos documentos Ativada.

011 - Confirmação de Todos documentos Desativada.

012 - Configuração de Documentos: OK;

013 - Configuração do Ambiente de Recebimento de NF-e : Ok.

014 - Configuração do Ambiente de Recebimento de CT-e : Ok.

015 - Configuração de Cancelamento por Evento : Ok.

016 - Configuração para envio do DANFE por e-mail : Ok

017 - Não é possível desabilitar o cancelamento por evento;

018 - Configuração para envio da NF-e 3.10 na modalidade EPEC : Ok

019 - Configuração para executar a distribuição automática de envio de e-mail do modelo [57]: Ok
019 - Configuração para não executar a distribuição automática de envio de e-mail do modelo [55]: Ok

Serviço: SPEDCFGNFE

Método: GETAUTODIST

Este método deve ser utilizado para verificar quais são as entidades utilizadas pelo TSS no ERP, através de suas filiais;

Parâmetros de entrada:

<soap:Body>

<USERTOKEN>STRING</USERTOKEN>

<LISTFILIAIS>STRING</LISTFILIAIS>

</GETAUTODIST>

</soap:Body>

Parâmetros de Saída:

<soap:Body>

Parâmetro

Tipo

Tam

Pai

Observação

USERTOKEN

Alfanumérico

06

-

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

LISTFILIAIS

Alfanumérico

-

String de um JSON serializado contendo as filiais utilizadas pelo TSS no ERP.

Exemplo.:

[["99","01","","","01","TESTE ","MATRIZ ",2,"FF ",null,true,1,"","","FF","0","TOTVS S\/A","53113791000122",null,null,"TESTE ","53113791000122_111010945111_SP","NULL;NULL;"],
["99","02","","","02","TESTE ","TOTVS RS ",2,"FF ",null,true,2,"","","FF","0","TOTVS RS","53113791000122",null,null,"TESTE ","53113791000122_0018000568_RS","NULL;NULL;"],
["99","03","","","03","TESTE ","TOTVS SA SANTA CATARINA ",2,"FF ",null,true,3,"","","FF","0","TOTVS SA SANTA CATARINA","53113791001790",null,null,"TESTE ","53113791001790_255721161_SC",""],
["99","04","","","04","TESTE ","TOTVS COLABORACAO ",2,"FF ",null,true,4,"","","FF","0","TOTVS COLABORACAO SP","53113791000122",null,null,"TESTE ","53113791000122_111010945112_SP",""],
["99","05","","","05","TESTE ","PARANÁ ",2,"FF ",null,true,5,"","","FF","0","PARANÁ - GAZIN","77941490000155",null,null,"TESTE ","77941490000155_8420001062_PR",""]]

Exemplos:

Envio:

Retorno:

Soap Fault

Fault	Descrição
Invalid Token	O parâmetro USERTOKEN foi passado incorretamente.
020	Lista de filiais não informada.

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.
LISTADOCUMENTOS	Estrutura	-	DISTEMAIL	Tag 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.
RETRANSMITIR	Lógico	-	LISTADOCUMENTOS	Forçar envio do e-mail, independente do status de envio de e-mail atual.
TIPOCOMPRESSAO	Alfanumé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.
MODELO	Alfanumérico	10	DISTEMAIL	Modelo do documento eletrônico. Modelos válidos: 55 (NFe). Modelos válidos: 57 (CTe).

Soap Fault

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

Exemplos:

Envio:

Retorno:

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.
MODELO	Alfanumérico	10	STATUSDISTMAIL	Modelo do documento eletrônico Modelos válidos: 55 (NFe).
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 Fault

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
004	Status inválido. 1=Pendente; 2=Distribuído; 3=Falha na Distribuição

Exemplos:

Envio:

Retorno:

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

Páginas filhas

ER_DocumentoAuxiliar_ERP_Enviada_por_E_mail_NFE_CTE

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

Informações Gerais

Índice:

Objetivo

Regras de Negócio

Web Services e Métodos do TSS

Objetivo

Web Services e Métodos do TSS