Download - TSS Manager Produto
TSS Manager
Índice
1 - Introdução ....................................................................................................................................................... 3
1.1 - Primeiro Acesso ................................................................................................................................. 4
1.2 - Licenciamento ................................................................................................................................................. 4
2 - Interface .......................................................................................................................................................... 5
2.1 - Inicial................................................................................................................................................................. 6
2.2 - Monitor ............................................................................................................................................................ 8
2.3 - Configurações.................................................................................................................................................. 11
2.4 - Ferramentas .................................................................................................................................................... 13
2.5 - Sobre ................................................................................................................................................................. 14
3 - EDI ................................................................................................................................................................... 14
Documentos Contemplados pelo EDI ................................................................................................................... 15
Arquivo XML ............................................................................................................................................................. 15
Web Service .............................................................................................................................................................. 16
3.1 – EDI - Importação ............................................................................................................................................ 22
3.2 – EDI - Transmissão ........................................................................................................................................... 23
3.3 – EDI - Exportação ............................................................................................................................................. 23
3.4 – EDI - Impressão .............................................................................................................................................. 24
3.5 – Configuração do EDI ...................................................................................................................................... 24
3.6 – Leiaute XML EDI ............................................................................................................................................. 25
XML de Envio .................................................................................................................................................. 25
XML de Retorno .............................................................................................................................................. 30
3.6.1 – Leiaute XML dos documentos .................................................................................................................. 33
TSS Manager
TSS Manager 3
1 - Introdução
O TSS Manager é uma ferramenta que foi desenvolvida para integrar os sistemas que efetuam transmissões de
documentos eletrônicos.
Ele está dividido em:
EDI.
Interface.
Através dessa ferramenta é possível emitir Nota Fiscal Eletrônica e seus respectivos eventos, tais como, Capa de Lote,
Imprimir DANFE e muitas outras funcionalidades que são executadas a partir da interface, mas, apenas algumas
podem ser feitas pelo EDI.
Para a utilização deste produto, deve ser adquirida a licença de uso junto à TOTVS por intermédio do executivo de
contas.
TSS Manager
TSS Manager 4
1.1 - Primeiro Acesso
Para utilizar a interface deve ser executado o smartclient disponibilizado pelo instalador do TSS.
É necessário digitar TSSManager no Programa Inicial e confirmar.
É exibida uma tela para informar usuário e senha padrão (para ambos, utilizar ADMIN em maiúsculo) e confirmar. A
tela seguinte é exibida para que essa senha seja alterada.
Para que seja possível acessar o sistema, o administrador deve cadastrar um usuário e os CNPJs que ele deve ter
acesso, pois, se esse procedimento não for realizado, no momento em que o usuário acessar o sistema ele é
notificado que não possui CNPJ.
A senha ADMIN não pode ser esquecida, pois, é a senha de administrador do sistema. Apenas ele pode gerenciar os
acessos dos usuários.
1.2 - Licenciamento
Para utilizar o TSS Manager é necessário possuir a licença de uso do produto.
As licenças válidas são:
On Demand: licença utilizada para a integração via TSS Manager EDI. Com ela, é possível ter acesso ilimitado a
interface sem restrição de usuários e, também, é utilizada para a emissão do documento via EDI, dessa forma, no
momento em que o documento for enviado com sucesso ao TSS é “debitada“ uma licença. Exemplo: com uma
aquisição de 500 licenças On Demand, ao enviar um documento com sucesso para o TSS, é “debitada“ uma licença
e sobram 499 para utilização.
Observação: é necessário consultar o contrato do produto adquirido para obter detalhes do licenciamento e
regras de utilização.
Usuário: na aquisição do produto TSS Manager sem o EDI, é liberada uma licença de uso por usuário e o acesso à
interface do produto é limitado por conexão de usuário.
Observação: apenas com a licença de usuário não é permitida a utilização do EDI.
Sem as licenças não é possível fazer o acesso ao sistema, pois, é obrigatório que o License Server esteja em
funcionamento com elas aplicadas.
Após a configuração do License Server é necessário configurar o License Client que executará a aplicação.
TSS Manager
TSS Manager 5
Configuração do License Server
O License Server é um server padrão disponibilizado nos binários da TOTVS e nele é configurado, em seu arquivo .ini, a
chave [LICENSESERVER] em que são definidas as opções enable (1 habilitado e 0 desabilitado) e o port em que o
License Server está em funcionamento.
Na Central de Downloads da TOTVS é possível baixar o instalador:
[LICENSESERVER]
enable=(1 é habilitado e 0 desabilitado)
port=(porta que o License Server será executado)
Configuração do License Client
No server utilizado para executar os JOBs de EDI e/ou acessar a interface, deve ser configurado, em seu arquivo .ini, a
chave License Client:
[LicenseClient]
server=(ip onde o server do License Server está executando)
port=(porta que o License Server será executado)
Utilização do arquivo de licenças e o harlock
O arquivo de licenças totvslic.key deve ser colocado na pasta localizada no arquivo .ini do server do License Server
junto com o hardlock (token de segurança das licenças do produto) que deve ser colocado no USB ou porta serial da
máquina que o server do License Server esta executando.
2 - Interface
A interface do TSS Manager possibilita visualizar, monitorar e, também, obter informações do que é processado pelo
TSS. Ela é dividida em menus:
Inicial.
Monitor.
Configurações.
Ferramentas.
Sobre.
Todas as telas possuem um browse/grid com legendas do semáforo, disponível na primeira e/ou segunda coluna. Para
analisá-las, basta dar um duplo clique na legenda do semáforo desejado que para que as informações sejam exibidas.
Para atualizar a tela é necessário clicar no ícone .
TSS Manager
TSS Manager 6
2.1 - Inicial
O menu Inicial oferece uma visão dinâmica e está dividido em sub-menus:
NF-e.
EDI.
Ambos apresentam um grid com suas respectivas informações e, quando acessados, exibem os dados do dia.
São disponibilizados filtros pré-estabelecidos de Tempo, CNPJ/CPF e Status do processamento do documento, dessa
forma, é possível exibir dados de até 1 dia anterior ao atual.
Também são fornecidos algumas funcionalidades básicas que o usuário pode executar de acordo com o sub-menu que
estará navegando.
2.1.1 – Inicial / NF-e
O sub-menu NF-e exibe de uma forma simples e usual as últimas notas fiscais eletrônicas emitidas pelo TSS.
Com o filtro pré-estabelecido é possível filtrar as informações exibidas no grid divididos em:
Tempo: que possui as opções de Hoje e Desde Ontem.
CNPJ/CPF: exibe os CNPJs e CPFs configurados no acesso do usuário logado.
Status: possui as opções de Todos, Com Falha, Cancelados e Autorizados.
No grid são apresentados os documentos que se encaixam no filtro definido.
Na parte inferior possui alguns detalhes da NF-e que está posicionada e as informações são apresentadas conforme
navegação no grid. Os detalhes exibidos para NF-e referem-se ao ambiente em que a NF-e foi emitida, Chave da NF-e
e Valor Total.
Em Ações Relacionadas estão disponíveis as opções:
Visualizar: exibe uma tela com os dados do XML da NF-e. Ela é separada de maneira que as informações ficam
agrupadas de acordo com seu assunto.
Exportar XML: exporta o XML da NF-e em um arquivo que deve ser salvo no diretório escolhido.
Enviar e-mail: envia o e-mail para o destinatário desejado com alguns dados da NF-e como chave, número série e,
também, com os anexos DANFE e/ou XML da NF-e.
Consulta NF: faz a consulta da situação da NF-e pela chave na SEFAZ e retorna as informações obtidas pela
consulta.
Status SEFAZ: consulta o status da SEFAZ da NF-e selecionada no grid.
Histórico: mostra todo o histórico de transação entre o TSS e SEFAZ da NF-e.
Digitador: possibilita que seja digitada uma NF-e em uma interface.
Na tela do sub-menu NF-e também estão disponíveis as opções:
TSS Manager
TSS Manager 7
Imprimir DANFE: gera em arquivo o documento fiscal DANFE das notas que estão autorizadas ou que foram
enviadas em contingência.
Importar: pode ser importado um XML de uma NF-e (modelo padrão da SEFAZ) para que o TSS transmita para a
SEFAZ.
A área Detalhes contempla as seguintes informações:
Ambiente: o ambiente em que a nota foi enviada para a SEFAZ (Homologação ou Produção).
Chave: chave da nota.
Valor Total: valor total da nota.
2.1.2 – Inicial / EDI
O sub-menu EDI exibe de uma forma simples e usual os últimos documentos que foram enviados para o EDI do TSS
Manager.
Com o filtro pré-estabelecido é possível filtrar as informações exibidas no grid divididos em:
Tempo: que possui as opções de Hoje e Desde Ontem.
CNPJ/CPF: exibe os CNPJs e CPFs configurados no acesso do usuário logado.
Status: possui as opções de Todos, Com Falha, Transmitido, Exportado e Impresso.
No grid são apresentados os documentos que se encaixam no filtro definido. A parte inferior possui alguns detalhes
do documento do EDI e as informações são apresentadas conforme navegação no grid.
As ações disponíveis são:
Importar: pode ser importado um XML no modelo estipulado pela TOTVS para que os serviços do EDI processem o
documento.
Histórico: mostra todo o histórico de transação entre o EDI e o TSS.
A área Detalhes contempla as seguintes informações:
Arquivo Importado. Nome do arquivo importado pelo EDI. Apenas quando o EDI for utilizado em modo de
Arquivo. Exemplo: ENVIO MT4.XML.
Identificação. Identificação enviada dentro do arquivo do EDI. Exemplo: 000000027.
Caminho da importação. Nome do caminho de importação utilizado pelo EDI. Apenas quando o EDI for utilizado
em modo de Arquivo. Exemplo: \Importar\.
Vias impressas. Número de vias que serão impressas do documento. Exemplo: 2.
Arquivo exportado. Nome do arquivo exportado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo.
Exemplo: ENVIO MT4.XML.
Informações. Quando existe alguma rejeição este campo informa maiores detalhes dessa rejeição. Exemplo: “Já
existe na base de dados o identificador "000000175" para o mesmo CNPJ e modelo informado”.
TSS Manager
TSS Manager 8
Caminho da exportação. Nome do caminho de exportação utilizado pelo EDI. Apenas quando o EDI for utilizado
em modo de Arquivo. Exemplo: \Exportar\rejeitado\04215721000765\
2.2 - Monitor
O menu Monitor fornece um monitoramento mais detalhado com mais filtros que permite refinar uma busca com
mais precisão.
Assim como no menu Inicial o Monitor tem as ações que são executadas de acordo com o registro selecionado no
grid, entretanto, seu diferencial está em algumas ações que podem ser executadas em mais de um registro do grid,
como por exemplo, gerar o DANFE de mais de um registro de uma única vez.
No canto superior do monitor existe um ícone para que seja possível forçar a atualização dos dados na tela.
Todos os grids do Monitor são de múltipla seleção e dividido em sub-menus:
NF-e.
EDI.
Evento.
CL-e.
Manifesto.
2.2.1 – Monitor / NF-e
O Monitor de NF-e exibe a mesma estrutura de dados que a NF-e no menu Inicial com o diferencial de que mais
ações podem ser executadas. Em Ações Relacionadas estão disponíveis as opções:
Visualizar: exibe uma tela com os dados do XML da NF-e. Ela é separada de maneira que as informações ficam
agrupadas de acordo com seu assunto.
Exportar XML: exporta o XML da NF-e em um arquivo que deve ser salvo no diretório escolhido.
Enviar E-mail: envia o e-mail para o destinatário desejado com alguns dados da NF-e como chave, número série e,
também, com os anexos DANFE e/ou XML da NF-e.
Validar Schema: possibilita a validação do schema do XML da NF-e.
Histórico: mostra todo o histórico de transação entre o TSS e SEFAZ da NF-e.
Status SEFAZ: consulta o status da SEFAZ da NF-e selecionada no grid.
Parâmetros: através dos parâmetros é possível reconfigurar o filtro do Monitor.
Consulta NF: faz a consulta da situação da NF-e pela chave na SEFAZ e retorna as informações obtidas pela
consulta.
Cancelar: processa o cancelamento da NF-e emitida para que o TSS transmita o cancelamento para SEFAZ.
Capa de Lote: possibilita que seja feita a capa de lote transmitindo para a SEFAZ.
TSS Manager
TSS Manager 9
Evento: cria o evento de carta de correção.
Digitador: possibilita que seja digitada uma NF-e na interface.
Na tela do sub-menu NF-e também estão disponíveis as opções:
Imprimir DANFE: gera em arquivo o documento fiscal DANFE das notas que estão autorizadas ou foram
enviadas em contingência.
Importar: pode ser importado um XML de uma NF-e (modelo padrão da SEFAZ) para que o TSS transmita para a
SEFAZ.
A área Detalhes contempla as seguintes informações:
Ambiente: Ambiente que o documento foi enviado. Exemplo: Homologação.
Chave: Chave da Nota Fiscal. Exemplo: 42120953113791001790552000000000151999999848.
Valor total: Valor total da Nota Fiscal Exemplo: 1,00.
Eventos. Exibe os eventos e ao clicar no mesmo apresenta se foi enviado evento ou não para aquele documento.
Exemplo: CARTA DE CORREÇÃO.
2.2.2 – Monitor / EDI
O Monitor de EDI exibe a mesma estrutura de dados que o EDI exibido no menu Inicial. Em Ações Relacionadas está
disponível a opção Importar que permite importar um XML no modelo estipulado pela TOTVS para que os serviços do
EDI processem o documento.
Na tela do sub-menu EDI também estão disponíveis as opções:
Histórico: mostra todo o histórico de transação entre o EDI e o TSS.
Parâmetros: através dos parâmetros é possível reconfigurar o filtro do Monitor.
A área Detalhes contempla as seguintes informações:
Arquivo Importado. Nome do arquivo importado pelo EDI. Apenas quando o EDI for utilizado em modo de
Arquivo. Exemplo: ENVIO MT4.XML.
Identificação. Identificação enviada dentro do arquivo do EDI. Exemplo: 000000027.
Caminho da importação. Nome do caminho de importação utilizado pelo EDI. Apenas quando o EDI for utilizado
em modo de Arquivo. Exemplo: \Importar\.
Vias impressas. Número de vias que serão impressas do documento. Exemplo: 2.
Arquivo exportado. Nome do arquivo exportado pelo EDI. Apenas quando o EDI for utilizado em modo de Arquivo.
Exemplo: ENVIO MT4.XML.
Informações. Quando existe alguma rejeição este campo informa maiores detalhes dessa rejeição. Exemplo: “Já
existe na base de dados o identificador "000000175" para o mesmo CNPJ e modelo informado”.
TSS Manager
TSS Manager 10
Caminho da exportação. Nome do caminho de exportação utilizado pelo EDI. Apenas quando o EDI for utilizado
em modo de Arquivo. Exemplo: \Exportar\rejeitado\04215721000765\
2.2.3 – Monitor / Eventos
O Monitor de Eventos monitora todos os eventos enviados pelo TSS para SEFAZ. As informações do evento são
exibidas de acordo com o que foi selecionado e, caso seja escolhido o de Carta de Correção, é apresentada a correção
enviada para SEFAZ.
Os eventos contemplados pelo monitor de eventos são:
Carta de Correção.
Manifestação do Destinatário.
Em Ações Relacionadas estão disponíveis as opções:
Visualizar: exibe as informações do evento enviado de acordo com seu tipo.
Histórico: mostra todo o histórico de transmissão do evento como data, hora, status etc.
Na tela do sub-menu Eventos também estão disponíveis as opções:
Transmitir: conduz os eventos selecionados que estão com status de aguardando transmissão.
Parâmetros: permite reconfigurar o filtro do monitor.
2.2.4 – Monitor / CL-e
O Monitor de Capa de Lote – CL-e monitora todas as capas de lote enviadas.
Em Ações Relacionadas estão disponíveis as opções:
Imprimir: gera em arquivo no formato .pdf o DACLE que é o documento fiscal da capa de lote.
Parâmetros: permite reconfigurar o filtro do monitor.
Alterar: altera os dados da capa de lote antes da transmissão. Capas que já foram transmitidas não podem ser
alteradas, a não ser, que estejam com algum erro acusado pela SEFAZ.
Excluir: cancela a capa de lote que ainda não foi transmitida ou que esteja com erro.
Na tela do sub-menu CL-e também estão disponíveis as opções:
Transmitir: conduz as capas selecionadas que estão com status de aguardando transmissão.
Visualizar: exibe as informações da capa de lote selecionada. Dados do carro, carreta, placa, notas que compõem a
capa e outros.
TSS Manager
TSS Manager 11
2.2.5 – Monitor / Manisfesto
O Monitor de Manifestação do Destinatário permite executar o evento de manifestar as opções Confirmada a
Operação, Desconhecimento da Operação, Operação não Realizada e Ciência da Operação nas notas emitidas para
seus CNPJs, além, de monitorar suas manifestações.
Como a manifestação é tratada como um evento, deve ser utilizado o Monitor de Eventos disponível para visualizar o
status do que foi enviado para SEFAZ.
Em Ações Relacionadas estão disponíveis as opções:
Manifestar: executa o envio do evento de manifestação para a SEFAZ das notas selecionadas no browse.
Parâmetros: através dos parâmetros é possível reconfigurar o filtro do monitor.
Sincroniza: sincroniza as notas emitidas para os CNPJs selecionados.
Na tela do sub-menu Manifesto também estão disponíveis as opções:
Histórico: visualiza as informações da manifestação.
Baixar Zip: faz o download do XML da nota.
2.3 - Configurações
O menu Configurações fornecer uma interface de configuração de entidade e seus parâmetros, certificado digital, EDI
e outros. Ele está dividido em sub-menus:
Entidades.
Geral.
Central de Notificações.
Toda configuração do produto está abaixo deste menu.
2.3.1 – Configurações - Entidades
Fornece acesso total para manipular a entidade e visualizar informações como, por exemplo, os dados do certificado
que está configurado para ela.
Pode ser alterado dados secundários de seu cadastro como Razão Social, Telefone e outras.
Dessa forma, toda configuração de entidade torna-se um processo simples e fácil de ser executado, pois, a interface
proporciona um entendimento rápido.
Toda entidade que for incluída, automaticamente, fica disponível para acesso no TSS Manager.
Em Ações Relacionadas estão disponíveis as opções:
Status SEFAZ: faz a verificação do status SEFAZ da entidade.
TSS Manager
TSS Manager 12
Alterar: alterar a entidade.
Incluir: inclui uma nova entidade.
Visualizar: exibe as informações das entidades.
Na tela do sub-menu Entidades também estão disponíveis as opções:
Certificado: exibe os dados do certificado configurado como status e data de validade, emissor e outras.
Configurar: permite configurar todos os processos do TSS como versão de NF-e, Capa de Lote, Evento, certificado
Digital, TSS Portal, envio de e-mail etc.
As alterações da configuração de entidade implicam em todo sistema e em qualquer processo que essa entidade
estiver envolvida.
A configuração da entidade está dividida em:
Geral: configura processos como o e-mail utilizado na notificação da SEFAZ, envio de e-mail feito pelo TSS
Manager que utiliza o e-mail configurado como remetente e outras ações que podem utilizar esse tipo de
comunicação. Também, é possível configurar o TSS Portal. Para isso, é necessário colocar a URL de onde o portal
está configurado que no momento em que é enviado e-mail para o destinatário da NF-e ele pode acessar o portal
e verificar as NF-e emitidas para ele.
NF-e: permite configurar o ambiente que a emissão da NF-e está processando, a modalidade, versão, o certificado
digital utilizado para a entidade e a versão da contingência DPEC.
Eventos: o evento pode ser configurado tanto na carta de correção quanto na manifestação do destinatário. As
configurações disponíveis são as versões e horários.
Capa de Lote: possui apenas a configuração da versão utilizada.
EDI: a configuração do EDI para entidade considera apenas se a impressão é feita direto na impressora ou arquivo,
seu caminho para o local da impressão e se deve ser feita em frente e verso.
2.3.2 – Configurações / Geral
Configura parâmetros que são de utilização geral do TSS que não tem dependência com a entidade que está
processando.
O TSS possui apenas configuração geral para o EDI:
Tipo de Integração: seleciona o tipo de integração que o EDI deve processar; arquivo XML ou Web Service. Com
essa configuração, os JOBs do EDI fazem o tratamento adequado para cada tipo de integração.
Diretório de Exportação: apresenta o caminho onde os arquivos do EDI são exportados. Eles são o retorno do
processamento do arquivo originalmente importado.
Diretório de Importação: apresenta o caminho onde existem os arquivos em que o EDI deve ler e processar o
documento.
TSS Manager
TSS Manager 13
Exporta Arquivos em pastas Estruturadas: caso seja selecionada a opção SIM, o EDI exporta os arquivos em pastas
separadas (Autorizada e Rejeitada) e dentro de cada uma existem pastas com o CNPJ da entidade processada.
2.3.3 – Configurações - Central de Notificações
A Central de Notificações comunica um determinado evento através de e-mail.
No TSS Manager existem algumas notificações que podem ser configuradas para ser processadas:
Vencimento Certificado Digital: permite configurar a partir de quantos dias, antes da data do vencimento do
certificado digital, a Central de Notificações deve enviar um e-mail para os endereços cadastrados com
informações sobre os dias que restam para o certificado expirar. Também é possível enviar e-mail com
informações dos certificados que já estão expirados.
Status SEFAZ: permite configurar a SEFAZ, modelo e ambiente desejado para que a Central de Notificações faça a
consulta do status SEFAZ e envie um e-mail.
Licença On Demand: permite configurar a partir de quantas licenças On Demand a Central de Notificações pode
enviar e-mail para notificar que a licença está se esgotando.
Para configurar a Central de Notificações são utilizadas as opções:
Configurar E-mail: deve ser configurado o servidor de e-mail SMTP que é utilizado para fazer a conexão e os dados
do e-mail que é utilizado para ser o remetente da notificação. Essa configuração é obrigatória para utilizar a
Central de Notificações e devem ser preenchidos os campos Servidor SMTP, Conta de e-mail, E-mail e Senha,
assim como, marcar as opções necessárias entre Autenticação, Conexão SSL e Conexão TLS.
Configurar Notificação: configura a notificação onde é informada se está habilitada ou não para o processamento,
e-mail do destinatário, assunto tratado, informações adicionais, a recorrência que será executada e a configuração
específica para a notificação.
A utilização dessa funcionalidade deixa automática a notificação de algumas informações relevantes para o
funcionamento do sistema. Para configurar o serviço/JOB da Central de Notificações é necessário colocar no arquivo
.ini do server o JOB TSSNOTIFYCENTER.
2.4 - Ferramentas
O menu Ferramentas possui as seguintes funcionalidades:
Inutilizar: permite enviar um lote de notas de uma determinada série para a entidade selecionada. Deve ser
informada a justificativa e clicar em Inutilizar para que os dados sejam enviados.
TSS Manager
TSS Manager 14
Toda configuração de inutilização como versão, ambiente (homologação ou produção) e modalidade são
considerados da entidade selecionada. Para alterar a configuração dessa entidade conforme desejado, é
necessário clicar na própria tela e em Parâmetros.
Status SEFAZ: possibilita a verificação do status de qualquer SEFAZ desejada, tanto de NF-e quanto de CT-e.
Alem disso, é possível visualizar as URLs utilizadas pelo TSS para a comunicação com a SEFAZ e, também, um link
rápido para o portal da NF-e ou do CT-e na internet.
Consulta Chave: permite consultar qualquer chave de NF-e emitida para a entidade selecionada. Essa
funcionalidade faz a consulta na SEFAZ e retorna informações tal como status da SEFAZ, motivo, Protocolo etc.
2.5 - Sobre
Ao acionar essa funcionalidade, é aberta uma tela com informações de versão do TSS, build do binário, Sistema
Operacional, Número do Hardlock e se o License Server está ativo.
É exibida uma tela com informações e um link que direciona para a Documentação do produto e a comunidade da
área responsável pelo produto na rede social da TOTVS, o By You.
3 - EDI
O EDI é um canal de comunicação que visa a integração de qualquer sistema com o TSS. Dessa forma, qualquer ERP
pode emitir documentos eletrônicos como Nota Fiscal Eletrônica, Eventos da SEFAZ, Nota Fiscal de Serviço, Capa de
Lote e Conhecimento de Transporte.
Os Jobs que devem ser adicionados no INI para utilização do EDI estão descritos no item Configuração do EDI.
Para que a integração ocorra, o EDI do TSS Manager deve receber o documento que pode ser disponibilizado de
algumas formas:
Arquivo XML.
Web Service.
Os processos que compõem o EDI são:
Importação.
Transmissão.
Exportação.
Impressão.
TSS Manager
TSS Manager 15
FLUXO DE PROCESSAMENTO DO EDI
Após a importação com sucesso pelo EDI, o arquivo é transmitido para que o TSS processe o documento
eletronicamente, enquanto isso, o processo de Exportação verifica se o arquivo transmitido já tem um retorno para
ser exportado.
A impressão é feita apenas quando o documento enviado está autorizado para uso.
Exemplo: NF-e foi autorizada na SEFAZ.
Toda configuração do EDI deve ser feita através da interface do TSS Manager em dois locais.
Configurações / Geral
Configurações / Entidades.
Selecione a opção Configurar e, em seguida, a pasta de EDI (essa configuração deve ser entidade por entidade).
A impressão é feita no processo paralelo com a exportação, pois, é feita a verificação do status do documento para que
seja impresso assim como a exportação.
Documentos Contemplados pelo EDI
Os documentos atendidos pelo TSS Manager na integração feita através do EDI são:
Nota Fiscal Eletrônica: o leiaute do documento a ser enviado deve ser o mesmo padrão da SEFAZ.
o Envio.
o Cancelamento.
o Inutilização.
Carta de Correção: o leiaute do documento a ser enviado deve ser conforme descrito no item Leiaute XML dos
documentos.
Capa de lote eletrônica: o leiaute do documento a ser enviado deve ser conforme descrito no item Leiaute XML
dos documentos.
Arquivo XML
A integração com arquivo XML acontece quando o sistema cria o arquivo em uma pasta configurada para leitura que é
feita através de processos do EDI. Esse XML tem um leiaute padrão disponibilizado pela TOTVS.
Importação Transmissão Exportação
Impressão
TSS Manager
TSS Manager 16
Quando o processo verifica a existência de um ou mais arquivos, ele automaticamente importa para o TSS Manager
com o objetivo de começar o processo de integração e envio do documento.
O retorno desse processamento ocorre no momento em que o EDI gera um arquivo de exportação, também, com um
leiaute definido pela TOTVS em uma pasta configurada para exportação, assim, o sistema pode ler o arquivo
exportado e alimentar sua base com as informações deste retorno.
Web Service
A integração do EDI via Web Service é a melhor, segura e mais rápida forma de enviar os documentos de um sistema
para o TSS Manager processar o documento. Para isso, é necessário que o sistema utilizado para controlar o envio dos
documentos seja preparado para integrar com o Web Service do EDI, de acordo com o seguinte padrão:
Web Service: TSSManagerEDI. Esse é o Web Service responsável pela integração do sistema com o EDI do TSS
Manager.
Métodos:
SendMessageEDI
Este método deve ser utilizado para que seja enviado ao TSS Manager EDI o documento que será processado e
enviado eletronicamente.
Estrutura:
Parâmetros de entrada:
<SENDMESSAGEEDI> <USERTOKEN>Alfanumérico</USERTOKEN> <MESSAGES> <MESSAGES> <!--Zero or more repetitions:--> <MESSAGE> <ID>Alfanumérico</ID> <XML>Base64</XML> </MESSAGE> </MESSAGES> </MESSAGES> </SENDMESSAGEEDI>
TSS Manager
TSS Manager 17
Parâmetro Tipo Tam Pai Observação
USERTOKEN Alfanumérico 006 SENDMESSAGEEDI Token de bilhetagem para execução do serviço.
MESSAGES Tag Raiz -- SENDMESSAGEEDI Tag Raiz das mensagens.
MESSAGE Tag Raiz -- MESSAGES Tag Raiz da Mensagem.
ID Alfanumérico unbouded MESSAGE
ID de identificação da mensagem. Utilizado apenas para controle do envio e retorno da mensagem (não é gravada na base de dados).
XML Base64 1-500KB MESSAGE
XML com o documento a ser importado no EDI (Verificar item “Leiaute XML EDI” deste documento).
O elemento ID é utilizado apenas para controle do envio e retorno da requisição, dessa forma, não é feito nenhum
controle por parte do EDI que, simplesmente, o devolve juntamente com as demais informações no retorno do
método.
Parâmetros de saída:
<SENDMESSAGEEDIRESPONSE> <SENDMESSAGEEDIRESULT> <DOCS> <DETDOC> <CODE>Numeric</CODE> <ID>AlfaNumerico</ID> <MESSAGE>AlfaNumerico</MESSAGE>
<RESULT>Boolean</RESULT> </DETDOC> </DOCS> </SENDMESSAGEEDIRESULT> </SENDMESSAGEEDIRESPONSE>
TSS Manager
TSS Manager 18
Parâmetro Tipo Tam Pai Observação
DOCS Tag Raiz -- SENDMESSAGEEDIRESU
LT Retorno dos documentos.
DETDOC Tag Raiz -- DOCS Informações do processamento do documento.
CODE Numérico 02 DETDOC Código de retorno do processamento de gravação do arquivo.
ID Alfanumérico unbouded DETDOC ID de Identificação da mensagem.
MESSAGE Alfanumérico 0-250 DETDOC Descrição do código de retorno.
RESULT Boolean 3-5 DETDOC
Resultado lógico do processamento: True =gravado com sucesso.
False=gravação não realizada, documento rejeitado.
ReceiveDocEDI
Este método retorna os documentos que já podem ser exportados para o sistema e que ainda não foram aprovados
pelo método de confirmação do Web Service.
Estrutura:
Parâmetros de entrada:
<RECEIVEDOCEDI> <USERTOKEN>Alfanumérico</USERTOKEN> <CPFCNPJ>Numérico</CPFCNPJ> <MODELO>Alfanumérico</MODELO> <MAXRET>Numérico</MAXRET> </RECEIVEDOCEDI>
TSS Manager
TSS Manager 19
Parâmetro Tipo Tam Pai Observação
USERTOKEN Alfanumérico 006 RECEIVEDOCEDI Token de bilhetagem para execução do serviço.
CPFCNPJ Numérico 11-14 RECEIVEDOCEDI CPF/CNPJ do remetente do documento ao EDI.
MODELO Alfanumérico 02 RECEIVEDOCEDI
Modelo do documento:
55=nfe.
110110=Carta de Correção
Cle=Capa de Lote
MAXRET Numérico unbouded RECEIVEDOCEDI
Número máximo de documentos que devem ser retornados na solicitação.
O parâmetro MAXRET é opcional, porém, é recomendada sua utilização para melhorar a performance ou até uma
possível perda do retorno dependendo do volume de notas regressadas.
Parâmetros de saída:
<SENDMESSAGEEDIRESPONSE> <RECEIVEDOCEDIRESULT> <RETDOCS> <RETDETDOC> <IDENTIFICACAO>000000004</IDENTIFICACAO> <XML>String</XML> </RETDETDOC> </RETDOCS> </RECEIVEDOCEDIRESULT>
</SENDMESSAGEEDIRESPONSE>
TSS Manager
TSS Manager 20
Parâmetro Tipo Tam Pai Observação
RETDOCS Tag Raiz -- RECEIVEDOCEDIRESULT Documentos retornados.
RETDETDOC Tag Raiz -- RETDOCS Dados do documento.
IDENTIFICACAO String 50 RETDETDOC Identificação do documento.
XML Base64 1-500KB RETDETDOC
XML de retorno com o documento importado no EDI (Verificar item “Leiaute XML EDI” deste documento).
ConfirmDocEDI
Confirma que o sistema recebeu do método de retorno do EDI do documento e que não precisa mais ser retornado.
Caso o documento não seja confirmado, toda vez que for utilizado o método de retorno o documento é retornado
mesmo que o sistema já o tenha recebido anteriormente.
Estrutura:
Parâmetros de entrada:
<CONFIRMDOCEDI> <USERTOKEN>Alfanumérico</spod:USERTOKEN> <CPFCNPJ>Numérico</CPFCNPJ> <MODELO>Alfanumérico</spod:MODELO> <CONFIRM> <CONFIRMDOC> <!--Zero or more repetitions:--> <CONFIRMDOC> <IDENTIFICACAO>Alfanumérico</IDENTIFICACAO> </CONFIRMDOC> </CONFIRMDOC> </CONFIRM> </CONFIRMDOCEDI>
TSS Manager
TSS Manager 21
Parâmetro Tipo Tam Pai Observação
USERTOKEN Alfanumérico 006 CONFIRMDOCEDI Token de bilhetagem para execução do serviço.
CPFCNPJ Numérico 11-14 CONFIRMDOCEDI CPF/CNPJ do remetente do documento ao EDI.
MODELO Alfanumérico 02 CONFIRMDOCEDI
Modelo do documento:
55=nfe.
110110=Carta de Correção.
Cle=Capa de Lote
CONFIRM Tag Raiz -- CONFIRMDOCEDI Documentos que devem ser confirmados.
CONFIRMDOC Tag Raiz -- CONFIRM
Tag com as informações do documento que deve ser confirmado.
IDENTIFICACAO Alfanumérico 50 CONFIRM Identificação do documento.
Parâmetros de saída:
<CONFIRMDOCEDIRESPONSE> <CONFIRMDOCEDIRESULT> <RETCONFIRMDOC> <RETCONFIRMDOC> <CONFIRM>Boolean</CONFIRM> <IDENTIFICACAO>String</IDENTIFICACAO> </RETCONFIRMDOC> </RETCONFIRMDOC> </CONFIRMDOCEDIRESULT> </CONFIRMDOCEDIRESPONSE>
TSS Manager
TSS Manager 22
Parâmetro Tipo Tam Pai Observação
RETCONFIRMDOC Tag Raiz -- CONFIRMDOCEDIRESULT Documentos enviados na solicitação.
CONFIRM Tag Raiz --
Resultado da confirmação: True=realizada a confirmação do recebimento.
False=confirmação não realizada.
IDENTIFICACAO String 50 RETDETDOC Identificação do documento.
3.1 – EDI - Importação
O processo de importação é a primeira frente de entrada do EDI. Este processo faz as primeiras validações como
estrutura do XML, validação de schema, existência da empresa na base de dados etc.
Este JOB é único e pode ter apenas um serviço no ar processando para evitar concorrência de processamento.
Após feita toda a validação, caso todas as informações estejam corretas, é marcado um flag no registro que foi
importado informando que ele está apto para ser transmitido. No caso de ter uma rejeição na importação, esse registro
importado é exportado com a mensagem ou motivo da rejeição.
FLUXO
ERP
Gera arquivo na pasta para importação
EDI
Efetua a leitura do
arquivo e o importa
TSS Manager
TSS Manager 23
3.2 – EDI - Transmissão
A transmissão é o processo responsável pelo envio ao TSS dos documentos válidos importados.
O processo de transmissão pode ser parametrizado por entidade, sendo assim é possível que um server de
processamento rode apenas uma determinada entidade ou até um range de entidade.
Essa parametrização deve ser feita no arquivo de configuração do server .ini.
Para todo o processo do EDI é possível realizar a parametrização das entidades. No arquivo de configuração do server
.ini é necessário adicionar a seguinte informação: TSSENTEDI=000001-000009
3.3 – EDI - Exportação
O processo de exportação é a resposta do processamento ao sistema que enviou o documento.
No caso do arquivo XML em disco, o processo seleciona o registro que está na base e gera um arquivo XML na pasta
designada na configuração feita no TSS Manager. Esse arquivo tem um leiaute padrão definido pela TOTVS.
Assim que é gerado o arquivo exportado nessa pasta, o sistema deve ler este arquivo para então importar as
informações para dentro de sua base e, assim, atualizar as informações do processo.
EDI
Faz a transmissão para o TSS do documento importado
TSS
Processa o documento
enviando para o órgão responsável
TSS Manager
TSS Manager 24
3.4 – EDI - Impressão
A impressão pode ser realizada apenas para os documentos autorizados e é necessário informar a quantidade de vias
que devem ser impressas.
O documento selecionado poderá ser impresso direto na impressora ou solicitado para ser gerado um arquivo .PDF,
conforme a configuração do TSS Manager.
3.5 – Configuração do EDI
A configuração dos serviços do EDI é feito de maneira simples. Para isso, deve ser criado no arquivo de configuração
do server .ini os JOBS do EDI.
TSS
Retorna o conteúdo do
processamento do documento
EDI
Faz a leitura da resposta do
processamento e exporta
ERP
Busca o retorno
exportado pelo EDI para inserir
os dados na base
EDI
Faz a impressão do documento na impressora ou em arquivo de acordo com o configurado
TSS Manager
TSS Manager 25
Em situações que apresentam muitas entidades para processarem um volume muito alto de documentos, pode ser
adicionado outro server para rodar o mesmo serviço, porém, o Job de Importação deve estar operacional apenas em
um Server.
Exemplo: uma empresa emite por dia 10.000 documentos eletrônicos de uma única entidade. Podem ser criados dois
servers com o mesmo JOB/Serviço rodando para que o processamento seja mais dinâmico, sempre lembrando que
para o processo de importação essa operação não pode ser executada.
JOBS/SERVIÇOS
A integração de arquivos pelo TSS Manger EDI é realizada através de serviços (JOBS) e cada um deles com sua
finalidade:
TSSEDIImp: job responsável pela importação e validação dos arquivos que devem ser processados. Assim que
iniciado, ele importa para o TSS Manager EDI os arquivos disponibilizados no diretório de importação pela
aplicação do cliente, conforme configurado. O processamento de importação está dividido em duas etapas:
1) Gravação: nenhuma validação é realizada, simplesmente, é feita a gravação do arquivo na base de dados do
TSS Manager.
2) Validação: após a gravação é realizada a validação da estrutura do arquivo e nas informações importantes para
realização do processamento como, por exemplo, o CNPJ que deve ter o seu cadastro habilitado na base do TSS
Manager EDI, caso contrário, é imediatamente rejeitado e disponibilizado na pasta de arquivos exportados
pelo job de exportação.
TSSEDITrans: job responsável pela transmissão do arquivo importado para a fila de processamento. Caso sejam
encontradas inconsistências de informações no documento, o arquivo é rejeitado e transferido para o diretório de
exportação.
TSSEDIExp: job responsável pela exportação dos arquivos processados.
TSSEDIPrt: job responsável pela impressão dos documentos autorizados.
Os documentos são processados apenas através dos serviços descritos. Dessa forma, é imprescindível que suas
configurações sejam feitas.
3.6 – Leiaute XML EDI
Para que o documento seja enviado para o EDI processá-lo é necessário seguir um leiaute de XML, de maneira que, o
retorno também contempla um leiaute próprio.
XML de Envio
Estrutura de schema:
TSS Manager
TSS Manager 26
<tssedienvio>
<emissor>
<cpfcnpj>
<prioridade>
<modelo>
<tipo>
<prtvias>
<xml>
<identificacao>
<inutilizar>
<serie>
<numero>
XML que deve ser validado:
# Nome Tipo Pai Ocorrência Observação
1 tssedienvio tctssedienvio 1-1
TSS Manager
TSS Manager 27
Formatos padrões utilizados:
Formato Observação
Date (date)
Formato: AAAA-MM-DD, onde:
AAAA = ano com 4 caracteres.
MM = mês com 2 caracteres.
DD = dia com 2 caracteres.
Data / Hora (datetime)
Formato AAAA-MM-DDTHH:mm:SS, onde:
AAAA = ano com 4 caracteres.
MM = mês com 2 caracteres.
DD = dia com 2 caracteres.
T = separando a data da hora.
HH = Hora com 2 Caracteres.
mm = minuto com 2 caracteres.
SS = segundos com 2 caracteres.
1. Tipos Simples
Tabela com a lista dos tipos simples que são utilizados como tipos de dados. Está dividida em 4 colunas:
Campo: nome do tipo simples.
Tipo: tipo primitivo de dados utilizados pelo campo:
o C: Caractere.
o N: Número.
Descrição: apresenta informações sobre o campo.
Tam.: tamanho do campo:
o Quando for caracteres o tamanho define a quantidade máxima de caracteres que o texto pode ter.
o Quando for numérico o tamanho pode ser representado das seguintes formas:
Número inteiro: define o total de dígitos existente no número. Exemplo: “15” significa que número
pode ter, no máximo, 15 dígitos.
Número fracionário: define o total de dígitos e quantos deles são designados para a parte fracionária.
Exemplo: “15,2” significa que o número pode ter, no máximo, 15 dígitos sendo 2 deles a identificação
da parte fracionária. A parte fracionária não é obrigatória quando assim definido.
o Quando for data, não há definição de tamanho.
Leiaute com as validações dos Tipos Simples e Complexos:
TSS Manager
TSS Manager 28
Tipos Simples
Nome Tipo Descrição Tamanho
tsprioridade N
Prioridade de processamento do documento: 0 – Normal
1 – Alta
1
tsmodelo C
Modelo do documento que está sendo processado: 55 – Nota Fiscal Eletrônica. 56 – Nota Fiscal de Serviço Eletrônica. 57 – Conhecimento de Transporte Eletrônico.
110110 – Carta de Correção Eletrônica.
CLE – Capa de Lote Eletrônica.
6
tstipo N
Tipo do processamento: 1 – Remessa. 2 – Cancelamento.
3 – Substituição (NFS-e).
1
tsprtvias N Número de vias de impressão do documento autorizado.
2
tsxml C XML do documento. 400KB
tsidentificacao C Identificação de controle do usuário. 50
tsserie C Série do documento. 3
tsnumero N Número do documento. 9
tscpfcnpj C CPF/CNPJ. 14
2. Tipos Complexos
A seguir serão detalhadas as tabelas de cada tipo composto e seus campos. A tabela está dividida da seguinte
forma:
(1)
(2)
Nome Tipo Ocorrência Descrição
(3) (4) (5) (6) (7)
(4) (5) (6) (7)
1) Nome do tipo complexo.
2) Descrição do tipo complexo.
3) Identifica se a sequencia de campos faz parte de uma escolha (Choice). Não utilizado neste Layout.
4) Nome do campo que faz parte do tipo complexo.
5) Tipo do campo (pode ser um tipo simples ou complexo).
6) Quantas vezes o campo se repete na estrutura de dados:
TSS Manager
TSS Manager 29
Formato: “x-y” onde “x” é a quantidade mínima e “y” a quantidade máxima. Se a quantidade máxima for
indefinida, será utilizado “N” no lugar do “y”;
7) Descrição do campo.
tctssedienvio
(uma única ocorrência)
Nome Tipo Ocorrência Descrição
emissor tcemissor 1-1 Agrupa informações sobre o emissor do documento.
prioridade tsprioridade 1-1 Indica se o arquivo terá prioridade no processamento.
modelo tsmodelo 1-1 Modelo do documento contido no arquivo.
tipo tstipo 1-1 Indica o tipo de processamento a ser realizado.
prtvias tsprtvias 1-1
Número de vias que será impresso do documento contido pelo processamento da impressão automática.
xml tsxml 1-1 XML do documento contido.
identificacao tsidentificacao 1-1 Identificação de controle do usuário.
inutilizar tcinutilizar 0-1 Informações sobre uma inutilização.
tcemissor
(uma única ocorrência)
Nome Tipo Ocorrência Descrição
cpfcnpj tscpfcnpj 1-1 CPF/CNPJ do emissor do documento.
tcinutilizar
(uma única ocorrência)
Nome Tipo Ocorrência Descrição
serie tsserie 1-1 Série a ser inutilizada.
numero tsnumero 1-1 Número a ser inutilizado.
TSS Manager
TSS Manager 30
Estrutura de tags do XML:
Estrutura de tags
Nome Pai Descrição
tssedienvio -- Tag raíz do XML.
emissor tssedienvio Tag que agrupará informações sobre o emissor do documento.
cpfcnpj emissor CPF/CNPJ do emissor do documento.
prioridade tssedienvio
Prioridade de processamento do documento: 0 – Normal.
1 – Alta.
modelo tssedienvio
Modelo do documento que esta sendo processado. 55 – Nota Fiscal Eletrônica. 56 – Nota Fiscal de Serviço Eletrônica. 57 – Conhecimento de Transporte Eletrônico.
110110 – Carta de Correção Eletrônica.
CLE – Capa de Lote Eletrônica.
tipo tssedienvio
Tipo do processamento: 1 – Remessa. 2 – Cancelamento. 3 – Substituição (NFS-e).
4 – Inutilização.
prtvias tssedienvio Número de vias de impressão do documento autorizado.
xml tssedienvio XML do documento.
Deve ser enviado dentro de uma declaração CDATA.
identificacao tssedienvio Identificação do sistema gerador do XML.
inutilizar tssedienvio Tag raíz de inutilização.
serie inutilizar Série do documento a ser inutilizado.
numero inutilizar Número do documento a ser inutilizado.
XML de Retorno
Estrutura de tags do XML:
TSS Manager
TSS Manager 31
<tssediretorno> <cnpj/> <cpf/> <docid/> <docxml/> <retxml/> <status/>
<docautorizado/> <descricao/> <detalhe/> <impdata/> <imphora/> <modelo/> <doctipo/> <identificacao/> <inutilizar/> <serie/>
<numero/>
TSS Manager
TSS Manager 32
Estrutura de tags
Nome Pai Descrição
tssediretorno -- Tag raíz do XML.
cnpj tssediretorno CNPJ do documento processado.
cpf tssediretorno CPF do documento processado.
docid tssediretorno ID do documento processado pelo EDI.
docxml tssediretorno XML do documento importado pelo EDI.
retxml tssediretorno XML de retorno do documento.
status tssediretorno Status do documento no EDI.
docautorizado tssediretorno
Status da autorização do documento: 0=Não autorizado.
1=autorizado.
descricao tssediretorno Descrição do status.
detalhe tssediretorno Detalhe do status.
impdata tssediretorno Data de importação do arquivo no EDI.
imphora tssediretorno Hora de importação do arquivo no EDI
modelo tssediretorno
Modelo do documento processado: 55 – Nota Fiscal Eletrônica. 56 – Nota Fiscal de Serviço Eletrônica. 57 – Conhecimento de Transporte Eletrônico.
110110 – Carta de Correção Eletrônica.
CLE – Capa de Lote Eletrônica.
doctipo tssediretorno
Tipo do processamento: 1 – Remessa. 2 – Cancelamento. 3 – Substituição (NFS-e).
4 – Inutilização.
identificacao tssediretorno Identificação do sistema que gerou o arquivo enviado para o EDI.
inutilizar tssediretorno Tag raíz de inutilização.
serie inutilizar Série do documento a ser inutilizado.
numero inutilizar Número do documento a ser inutilizado.
TSS Manager
TSS Manager 33
3.6.1 – Leiaute XML dos documentos
O XML do documento é o XML que será enviado na tag <XML> contida na estrutura do EDI.
Este XML deve ser enviado dentro de uma declaração CDATA.
Exemplo: <![CDATA[ xml ]]>
CARTA DE CORREÇÃO
<envEvento>
<eventos>
<detEvento>
<tpEvento>110110</tpEvento>
<chNFe>Chave da NFe com 44 posições</chNFe>
<xCorrecao>Correção que será enviada</xCorrecao>
</detEvento>
</eventos>
</envEvento>
Estrutura de tags
Nome Pai Descrição
envEvento -- Tag raíz do XML.
eventos envEvento -
detEvento eventos -
tpEvento detEvento Tipo do evento da carta de correção.
110110.
chNFe detEvento Chave da NF-e com 44 posições que será enviada a carta de correção.
xCorrecao detEvento Correção que será enviada com no mínimo 15 posições.
TSS Manager
TSS Manager 34
CAPA DE LOTE ELETRÔNICA
<CLe>
<transportador>
<CNPJ>99999999000191</CNPJ>
<xNome>TESTE</xNome>
<xFant>TESTE</xFant>
</transportador>
<mdTransp>
<rodoviario>
<pVeic>DDF2334</pVeic>
<cUFVeic>SP</cUFVeic>
</rodoviario>
</mdTransp>
<cUFOrigem >SC</cUFOrigem>
<cUFDestino>SP</cUFDestino>
<det>
<chvAcesso> 42121253113791001790551110001002301998997692 </chvAcesso>
</det>
</CLe>
TSS Manager
TSS Manager 35
Estrutura de tags
Nome Pai Descrição
CLe -- Tag raíz do XML.
transportador CLe Dados do transportador
CNPJ transportador CNPJ do transportador
xNome Transportador Nome do transportador
xFant transportador Nome fantasia do transportador.
mdTransp CLe
Modalidade do transporte:
rodoviário.
outro.
rodoviario mdTransp Dados do transporte rodoviário
pVeic rodoviario Placa do veículo
cUFVeic rodoviário UF do veículo
cUFOrigem CLe UF de origem da entrega
cUFDestino CLe UF de destino da entrega
det CLe Grupo com as chaves das notas
chvAcesso det Chave da nota
NOTA FISCAL ELETRÔNICA
Deve ser seguido o manual de integração da SEFAZ.