Este documento é material de especificação dos requisitos de manutenção, trata-se de conteúdo extremamente técnico. |
---|
Especificação | |||
Produto | TSS | Módulo | NF-e |
Segmento Executor | Serviços | ||
Chamado/ISSUE | |||
País | ( X ) Brasil ( ) Argentina ( ) México ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colômbia ( ) Outro _____________. |
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:
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:
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
Para CT-e, o parâmetro será o AUTDCTE
Aviso | ||
---|---|---|
| ||
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 |
Serão utilizados os métodos dos Web Services abaixo:
Serviço: SPEDCFGNFE
Este método deve ser utilizado para informar qual a configuração dos parâmetros de funcionamento do TSS.
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
<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
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.
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
-
--
Estrutura
Estrutura
CFGDOCMAIL
--
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
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)
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.
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.
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
Aviso | ||
---|---|---|
| ||
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. |
Bloco de código | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
<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
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>
Parâmetro
Tipo
Tam
Pai
Observação
USERTOKEN
Alfanumérico
06
-
Token de bilhetagem para execução do serviço.
Âncora objetivo objetivo
Possibilitar que o TSS envie para o ERP o arquivo PDF da Carta de Correção Eletrônica (CC-e), como também, o envio por e-mail do arquivo PDF anexado após a sua autorização.
Regras de Negócio Âncora regras_negocio regras_negocio
Para realizar o processo de exportação, tanto no formato XML como no formato PDF, foi criado um método NFEEXPEVENTO.
Sua estrutura de recebimento é:
USERTOKEN - usar TOTVS
ID_ENT - Código da entidade retornado pelo WS SpedAdm/AdmEmpresas.
CHVINICIAL - Chave da NF-e inicial para o processamento.
CHVFINAL - Chave da NF-e final para o processamento.
TIPO - Tipo de exportação. Valores aceito: 0 - Todos / 1 - XML / 2 - PDF
Sua estrutura de retorno é:
NFEEXPEVENTORESULT - Estrutura de retorno principal
RETEXPEVENTO - Estrutura de retorno de cada nota
CHAVE - Chave do documento
ID_EVENTO - Id do evento
PDF - Arquivo PDF encodado em base64
XML - XML do evento
Caso a requisição esteja com a tag TIPO igual a 0 (todos) ou 2 (PDF), somente será aceito uma única chave, devido ao tempo de processo e também o fluxo de tráfegos de dados.
O arquivo PDF será retornado na tag PDF encodado em base64, para que seja possível realizar a gravação por parte do requisitante.
Para realizar o processo de envio por e-mail foi criado o parâmetro MV_CCEPDF, onde caso seja realizada a configuração através do método CFGCCE, será anexado o PDF juntamente com o XML após a autorização do evento.
O método CFGCCE é utilizado para realizar a configuração necessária da Carta de Correção da NF-e, assim foi criado em sua estrutura de recebimento a tag opcional:
ENVIACCEPDF - Indica se será enviado por e-mail o arquivo PDF da carta de correção, após a autorização do evento. Valores aceito: 1 - Sim / 2 - Não
E incluído em sua estrutura de retorno a tag:
CCEPDF - Retorna mensagem de configuração do envio da cartão de correção no formato PDF.
"Envio de CCE em PDF configurado com sucesso."
"Envio de CCE em PDF não configurado."
Após configurado o parâmetro MV_CCEPDF, onde 1 indica que será enviado anexado ao e-mail e 2 indica que não será enviado, ou seja, somente será enviado o XML do evento.
Poderá ser realizado a configuração do envio através das interfaces TSSMANAGER e TSSINTERFACE.
Poderá ser realizado o envio através das interfaces TSSMANAGER e TSSMONITOR.
Documentação de como realizar os processos acima: Configuração de parâmetros e Envio da Carta de correção em PDF
Nota | ||||
---|---|---|---|---|
| ||||
Somente está disponível para o evento 110110 - Carta de Correção da NFe. |
Web Services e Métodos do TSS Âncora servicos_metodos servicos_metodos
Serão utilizados os métodos dos Web Services abaixo:
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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
Serviço: NFESBRA
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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.
DOCUMENTOS
Estrutura
-
LISTADOCUMENTOS
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.
Base64Binary
-
LISTADOCUMENTOS
PDF a ser utilizado na distribuição via e-mail.
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 do documento eletrônico.
Modelos válidos: 55 (NFe).
Modelos válidos: 57 (CTe).
|
Soap Fault
Modelo inválido. Modelos permitidos: 55
Exemplos:
Envio:
Retorno:
Serviço: NFESBRA
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
|
|
Parâmetro
Tipo
Tam
Pai
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 do documento eletrônico
Modelos válidos: 55 (NFe).
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
Descrição
Modelo inválido. Modelos permitidos: 55
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. |
---|