Informações Gerais 

Í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 serão implementados inicialmente para a 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 (Modelo 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 da DANFE 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 ", disponibilizado MV_AUTDCTE", disponibilizado no método "CFGPARAMSPED" para o serviço "SPEDCFGNFE", os ERP´s poderão  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  seguintes demandas:

• Permitir que os ERP´s enviem 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 setado 1 com o valor 01 (um) e AUTDIST estiver desativado igual á , 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

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>

<GETAUTODIST>

<USERTOKEN>STRING</USERTOKEN>

<LISTFILIAIS>STRING</LISTFILIAIS>

</GETAUTODIST>

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

1

-

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

1

-

Informe 1 para produção, 2 para homologação ou 0 para saber a configuração atual do ambiente.

MODALIDADE

Inteiro

1

-

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

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.

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

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. 

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

<soap:Body>

   <MSG>STRING</MSG>

</soap:Body>

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

1

-

Informe 1 para produção, 2 para homologação ou 0 para saber a configuração atual do ambiente.

AMBCTECOLAB

INTEGER

1

-

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

1

-

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

Alfanumerico

1

-

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.

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.

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

<soap:Body>

<MSG>STRING</MSG>

</soap:Body>

</soap:Envelope>

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>

<GETAUTODIST>

<USERTOKEN>STRING</USERTOKEN>

<LISTFILIAIS>STRING</LISTFILIAIS>

</GETAUTODIST>

</soap:Body>

Parâmetros de Saída:

<soap:Body>

<GETAUTODISTRESPONSE xmlns="http://webservices.totvs.com.br/spedcfgnfe.apw">
<GETAUTODISTRESULT>
<CFGAUTODIST>
<EMPRESA>99</EMPRESA>
<ENABLE>true</ENABLE>
<ENTIDADE>000003</ENTIDADE>
<FILIAL>01</FILIAL>
</CFGAUTODIST>
</GETAUTODISTRESULT>
</GETAUTODISTRESPONSE>
</soap:Body>

Exemplos:

Envio: 

Retorno:

Soap Fault

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>

Soap Fault

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>

Exemplos:

 Envio:

Retorno: