Melhoria na integração dos sistemas TOTVS Educacional, TOTVS Processo Seletivo, TOTVS Gestão Bibliotecária e o BackOffice do Protheus (Financeiro), por meio da mensagem única.
Atualmente é realizada por tabelas intermediárias, sendo que os módulos da linha RM realiza as consultas em determinadas tabelas do módulo do Protheus, sendo necessário uma nova conexão para que a linha RM consuma as informações na base do Protheus.
Definição de Mensagem Única – TotvsMessage
Com o objetivo de padronizar as integrações com os produtos, foi definida a utilização da diretriz para os projetos de integração que todos os produtos devem trabalhar com a mensagem XML única, evitando desta forma, o processo de transformação de mensagens.
Neste cenário, temos o seguinte quadro:
Qualquer um dos produtos são executados com o mesmo XML para uma mesma entidade, ou seja, caso um arquivo XML corresponde a mensagem de clientes, pode ser enviado para qualquer um dos produtos que suporte o recebimento desta entidade, como no diagrama abaixo:
A mensagem única torna uniforme a execução destes arquivos XML pelos aplicativos, principalmente para a capacidade de rastreamento.
Todos os processos devem respeitar o fluxo normal de troca de mensagens no padrão de Mensagem Única TOTVS.
Este fluxo pode ocorrer nos seguintes sentidos:
Para mais informações sobre o fluxo dos dados internos ao TBC, vide documentação: TOTVS Business Connect
Assim como definido no protocolo de comunicação de mensagens únicas, a comunicação pode ser efetuada de duas formas:
Ao término do processamento da mensagem por parte do sistema de destino, este envia outra mensagem de retorno ao sistema de origem com status do processamento. Lembrando que as mensagens assíncronas podem ser processadas (status pendente) ou reprocessadas (status erro) manualmente por meio do monitor da fila de integração.
As entidades e os pontos de integração que fazem parte desta integração são:
Entidade | Pontos de Integração |
Lançamentos a receber – TOTVS Educacional |
|
Lançamentos a receber – TOTVS Processo Seletivo |
|
Lançamentos a receber – TOTVS Gestão Bibliotecária |
|
Lançamentos a pagar – TOTVS Gestão Financeira |
|
Patrimônios |
|
Classe de Valor |
|
Item contábil |
|
Moeda – TOTVS Gestão Financeira |
|
Centro de Custo – TOTVS Gestão Financeira |
|
Produto – TOTVS Gestão de Estoque, compras e faturamento |
|
Cliente/Fornecedor – TOTVS Gestão Financeira |
|
Natureza Financeira – TOTVS Gestão Financeira |
|
Banco – TOTVS Gestão Financeira |
|
Operações que envolvem lançamentos a receber – TOTVS Gestão Financeira |
|
Bolsa / Desconto condicial – TOTVS Educacional |
|
Os itens abaixo estão fora de escopo desta integração:
Atenção: Para instalar qualquer módulo da linha RM, é necessário instalar da Biblioteca RM o pacote que contém a maioria dos arquivos necessários para o funcionamento de todos os módulos, inclusive do TBC.
(Mais detalhes acesso o documento Orientações para instalar BibliotecaRM)
Para que a integração possa funcionar, deve-se verificar se a tag DefaultDB, que informa o Alias que será utilizado para acesso a base de dados, existe no arquivo de configuração do Host (RM.Host.Service.exe.config ou RM.Host.exe.config):
<add key=”DefaultDB” value=”<ALIAS_DO_BANCO_RM>
em que a variável <ALIAS_DO_BANCO_RM> será o nome do alias cadastrado para acesso ao banco de dados.
Exemplo:
Para o funcionamento da integração, somente um servidor (Host), deve estar configurado para ler a fila de mensagens únicas. Esse requisito deve ser atendido para que as mensagens do tipo assíncronas possam ser processadas em sequência. |
Para verificar se o webservice está funcionando, abra o endereço abaixo no navegador:
Endereço: http:// localhost:8051/EAIService/
A porta 8051 é padrão no sistema e caso seja alterada na tag HttpPort no arquivo de configuração do Host, precisa ser alterada no link acima.
Caso o serviço do Host (RM.Host.Service.exe ou RM.Host.exe) não esteja rodando e/ou a porta não esteja correta, a mensagem abaixo poderá ser exibida:
Se o Host utilizado for o RM.Host.Service.exe será necessário a execução do comando abaixo, para liberação da porta configurada na tag “HttpPort”, via prompt de comando:
netsh http add urlacl url=http://+:8051/ user=NetworkService
netsh http delete urlacl url=http://+:8051/
netsh http show urlacl Caso contrário, a mesma página de erro acima será exibida. |
Com a utilização do webservice pelo Host, o endereço que será utilizado pelo EAI do Protheus precisará conter a informação de PortName:
http://localhost:8051/EAIService/IConWSEAIService
Esse endereço aberto no browser (navegador web), irá exibir uma página em branco. Para o teste pelo navegador acesse o link anterior. |
Uma segunda opção, como alternativa de configuração para utilização do EAI é o conjunto de ferramentas denominada TBC – TOTVS Business Connect, que possui esse mesmo webservice em seu instalador e necessita de uma configuração no IIS do Windows.
Para mais informações da instalação do TBC, consulte os documentos de apoio abaixo:
Conversor da integração para adequação a mensageria única
Caso seja utilizada a integração entre Educacional e Protheus via conexão de banco de dados, é executado o conversor para adequação das tabelas a estrutura utilizada pela integração por mensageria única, no RM Atualizador.
Premissas para a execução do conversor:
Deve ser executado o assistente Aproveitar valores em contas correntes em: TOTVS Educacional / Financeiro/Contábil / Assistentes, para que sejam zeradas as contas correntes dos alunos.
Pós execução do conversor:
É alterada a parametrização do TOTVS Educacional em TOTVS Educacional / Integração / Financeiro / Cobrança Retroativa, para não utilizar o recurso de conta corrente.
Deve ser executado o sincronizador para criação do De/Para dos registros existentes da integração via banco de dados, que está em: Módulo Integração / Ferramentas / Conversão / Converter Integração
Após a criação dos De/Para, deve ser executada no Protheus a carga inicial das mensagens ClassValue (Classe de Valor) e AccountingItem (Item Contábil) para que seja atualizado os dados no TOTVS Educacional.
As Naturezas Financeiras associadas aos serviços educacionais no anexo de dados financeiros da integração com o Protheus devem ser atualizadas, pois após a conversão será utilizado o cadastro de Natureza Orçamentária Financeira no módulo de Gestão Financeira.
Habilitar parametrização dos produtos para integração
Após a instalação dos produtos RM e a conversão, caso tenha sido necessária, deve ser realizada a habilitação da integração com o Protheus nos produtos:
1) Ative a integração com Protheus em Módulo Educacional / Configurações / Parâmetros / 15.05 Integração / 15.05.07 Protheus / Utiliza integração com Protheus;
2) Marque o Novo (mensageria única) no campo Modelo de integração.
1) Ative a integração com Protheus em Módulo Gestão Bibliotecária / Parâmetros/Configurações / Parâmetros do sistema / 14.09 Integração / 14.09.05 Protheus / Utiliza integração com Protheus;
2) Marque o Novo (mensageria única) no campo Modelo de integração.
1) Ative a integração com Protheus em Módulo Processo Seletivo / Parâmetros / Parâmetros do sistema / Aba Integração / Utiliza integração com Protheus;
2) Marque o Novo (mensageria única) no campo Modelo de integração.
- Na parametrização do TOTVS Educacional, o preenchimento dos dados de conexão somente é necessário caso o modelo de integração seja o antigo. - Os campos para informação do modelo de integração é necessária somente na versão 11.83. - A partir da 12.1 é utilizada somente a integração por mensageria única, não necessitando das informações de banco de dados e modelo de integração. |
Atualização de sistema não necessariamente quer dizer atualização de versão de mensagem, cada integração tem suas versões de mensagens já definidas.
Uma alteração na versão da mensagem pode impactar em toda a integração, pois é desenvolvida uma lógica para cada versão.
Caso exista alguma atualização do TOTVS Educacional para correções relacionadas à integração, é necessária a exclusão da integração e a reinstalação deve ser realizada pelo Configurador. É importante verificar antes de excluir as informações dos parâmetros de integração e as configurações do webservice de destino, pois os valores são apagados também.
Importante:
|
Instalação do Protheus V12 e configuração do AppServer e Dbaccess
Acesse os documentos de apoio abaixo para instalação e configuração.
Configurações do EAI
Para a configuração do EAI no Protheus, siga os procedimentos abaixo:
Exemplo: http://12.50.90.211:81/MensagemUnicaWS.
Mensagem Única | Rotina | Mensagem | Envia | Recebe | Método | Operação | Canal | Alias |
Sim | FINA010 | FINANCIALNATURE | Sim | Não | Assíncrono | Todas | EAI | SED |
Sim | FINA040 | ACCOUNTRECEIVABLEDOCUMENT | Sim | Sim | Assíncrono | Todas | EAI | SE1 |
Sim | FINA070 | ACCOUNTRECEIVABLEDOCUMENTDISCHARGE | Sim | Sim | Síncrono | Atualização | EAI | - |
Sim | FINA070 | REVERSALOFACCOUNTRECEIVABLEDOCUMENTDISCHARGE | Sim | Não | Síncrono | Exclusão | EAI | - |
Sim | FINA130 | BANK | Sim | Não | Assíncrono | Todas | EAI | SA6 |
Sim | FINA280 | FINANCINGTRADING | Sim | Não | Síncrono | Atualização | EAI | - |
Sim | FINA280 | REVERSALOFFINANCINGTRADING | Sim | Não | Síncrono | Exclusão | EAI | - |
Sim | FINA460 | FINANCINGTRADING | Sim | Não | Síncrono | Atualização | EAI | - |
Sim | FINA460 | REVERSALOFFINANCINGTRADING | Sim | Não | Síncrono | Exclusão | EAI | - |
Sim | FINI070A | UPDATECONTRACTPARCEL | Sim | Não | Síncrono | Todas | EAI | - |
Sim | FINI150A | OURNUMBERBANKING | Sim | Não | Síncrono | Todas | EAI | - |
Sim | MATA010 | ITEM | Sim | Não | Assíncrono | Todas | EAI | SB1 |
Sim | MATA020 | CUSTOMERVENDOR | Sim | Sim | Síncrono | Todas | EAI | SA2 |
Sim | MATA030 | CUSTOMERVENDOR | Sim | Sim | Síncrono | Todas | EAI | SA1 |
Sim | MATA070 | BANK | Sim | Não | Assíncrono | Todas | EAI | SA6 |
Sim | QIEA030 | UNITOFMEASURE | Sim | Não | Assíncrono | Todas | EAI | SAH |
Sim | MATA035 | STOCKGROUP | Sim | Não | Assíncrono | Todas | EAI | SBM |
Sim | ATFA012 | ASSETS | Sim | Não | Assíncrono | Todas | EAI | SN1 |
Sim | FINA050 | ACCOUNTPAYABLEDOCUMENT | Não | Sim | Assíncrono | Todas | EAI | SE2 |
Sim | CTBA140 | CURRENCY | Sim | Não | Assíncrono | Todas | EAI | CTO |
Sim | CTBA030 | COSTCENTER | Sim | Não | Assíncrono | Todas | EAI | CTT |
Sim | INTXATU01 | INTERNALIDLOAD | Não | Sim | Assíncrono | Todas | EAI | - |
Sim | APCFG060 | WHOIS | Sim | Sim | Assíncrono | Todas | EAI | - |
O adapter WHOIS é utilizado para testar a conectividade entre a integração no sentido RM para o Protheus. E seu retorno são os adapters cadastrados no Protheus. É necessário o adapter estar cadastro no Protheus, e no RM é necessário a execução do configurador (Módulo Integração -> Menu Integração -> Ferramentas -> Configurar) para que o adapter seja inserido a integração. |
Clique no símbolo destacado no canto superior direito da tela, para o cadastro automático dos agentes:
Clique no símbolo destacado na parte inferior para adicionar um novo agendamento:
Preencha o campo Rotina com a rotina FWEAI e informe as empresas para as quais o agendamento será válido:
Defina a data e horário para a execução do agendamento e a recorrência, para isto, clique no símbolo destacado na parte superior, conforme as necessidades existentes:
Confirme a inclusão do agendamento:
Carga Inicial
Para utilização da rotina de carga inicial dos dados, acesse o documento Carga inicial dos dados de cadastro.
(Mais detalhes sobre configuração acesso o documento Configuração EAI Protheus)
Para a configuração e instalação da integração do TOTVS Educacional x BackOffice Protheus, siga os passos abaixo:
1º Passo:
Carregue o Assistente de Configuração do TBC (Módulo Integração / Ferramentas / Configurar);
Informe o usuário e a senha do banco de dados com permissão para executar os scripts de configuração da integração.
2º Passo:
([X]) Marque a integração do TOTVS Educacional x BackOffice Protheus por meio do processo;
3º Passo:
Execute o processo para realizar a instalação da integração;
4º Passo:
Após a instalação, configure o endereço do WebService do EAI do TOTVS Protheus para a integração TOTVS Educacional x BackOffice Protheus, disponível em Módulo TBC (Integração) / Mensagem Única / Integrações;
5º Passo:
Ative a integração TOTVS Educacional x BackOffice Protheus, disponível em Módulo TBC (Integração) / Mensagem Única / Integrações;
Informe os campos abaixo, para configuração da integração:
URL WEB SERVICE:
Informe o endereço do WebService Protheus para envio de mensagens.
Utilize o formato http://[servidor]:[porta]/EAIService.apw.
Para verificar se o WS Protheus está disponível, digite o endereço no navegador.
Na página apresentada procure pelo texto EAISERVICE.
USUÁRIO AUTENTICAÇÃO:
Informe o nome do usuário para autenticação pelo WebService.
SENHA AUTENTICAÇÃO:
Informe a senha para autenticação pelo WebService.
Configurar ( RM e Protheus ) para utilizar a Integração, campos complementares, parâmetros e cadastros obrigatórios.
Acesso documento de apoio Configurações da Integração - Mensagem única TOTVS Educacional e Protheus
O grupo TOTVS representado por suas marcas irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.
Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.
O suporte aos recursos da Integração será de responsabilidade de todas as linhas, sendo assim as equipes de suporte dos produtos RM Conector e Backoffice Protheus estarão aptas a fazer a primeira análise e quando necessário, repassar para a equipe mais adequada em cada caso.
Observação: Este modelo de suporte está sendo revisado pela TOTVS.
Integração Financeira – TOTVS Educacional x BackOffice Protheus | ||
TOTVS Gestão Financeira | Mensagens | TOTVS Protheus |
TOTVS Educacional | Mensagens | TOTVS Protheus |
TOTVS Gestão Estoque, Compras e Faturamento | Mensagens | TOTVS Protheus |
|
TOTVS Gestão Patrimonial | Mensagens | TOTVS Protheus |
Todas as movimentações de mensagens, com algumas exceções, tanto para envio quanto para recebimento, resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistema que estão trocando informações.
Considerando as mensagens envolvidas nessas integração, seguem os registros De-Para que serão registrados ao enviar ou receber uma mesagem, como exemplo:
12.1.Mensagem Currency (Moeda)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
GMOEDA | SIMBOLO | R$ | PROTHEUS | 01||01 |
GMOEDA | SIMBOLO | US$ | PROTHEUS | 01||02 |
12.2.Mensagem CostCenter (Centro de Custo)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
GCCusto | CODCOLIGADA|CODCCUSTO | 1|100000000 | PROTHEUS | 01|01AM |100000000 |
GCCusto | CODCOLIGADA|CODCCUSTO | 1|100000002 | PROTHEUS | 01|01AM |100000002 |
12.3.Mensagem CustomerVendor (Cliente/Fornecedor)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
FCFO | CODCOLIGADA|CODCFO | 0|000000001 | PROTHEUS | 01||000000001|01|C |
FCFO | CODCOLIGADA|CODCFO | 0|000000110 | PROTHEUS | 01||000000110|01|F |
12.4.Mensagem FinancialNature (Natureza Financeira)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
TTBORCAMENTO | CODCOLIGADA|CODTBORCAMENTO | 2|001 | PROTHEUS | 01|01AM|001 |
TTBORCAMENTO | CODCOLIGADA|CODTBORCAMENTO | 2|002 | PROTHEUS | 01|01AM|002 |
12.5.Mensagem Bank (Banco/Agência/Conta Corrente/Conta Caixa/Convênio)
Banco / Agência / Conta Corrente
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
FConta | CODCOLIGADA|NUMBANCO|NUMAGENCIA|NROCONTA | 2|001|0455 |012453 | PROTHEUS | 01|02AM0001|001|0455|012453 |
FConta | CODCOLIGADA|NUMBANCO|NUMAGENCIA|NROCONTA | 2|033|4268 |01001459 | PROTHEUS | 01|01AM0001|033|4268|01001459 |
Conta Caixa
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
FCxa | CODCOLIGADA|CODCXA | 2|01001459 | PROTHEUS | 01|01AM0001|033|4268|01001459 |
FCxa | CODCOLIGADA|CODCXA | 2|012453 | PROTHEUS | 01|02AM0001|001|0455|012453 |
Convênio
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
FCONVENIO | CODCOLIGADA|IDCONVENIO | 2|19 | PROTHEUS | 01|02AM0001|001|0455|012453 |
FCONVENIO | CODCOLIGADA|IDCONVENIO | 2|22 | PROTHEUS | 01|01AM0001|033|4268|01001459 |
12.6.Mensagem AccounReceivableDocument (Lançamentos a receber)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
FLAN | CODCOLIGADA|IDLAN | 2|1380 | PROTHEUS | 01|01AM0001||68|1|002 |
FLAN | CODCOLIGADA|IDLAN | 2|1381 | PROTHEUS | 01|01AM0001||69|2|002 |
12.7.Mensagem AccountReceivableDocumentDischarge (Baixa de Lançamentos a receber)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
FLANBAIXA | CODCOLIGADA|IDLAN|IDBAIXA | 2|1416|238 | PROTHEUS | 01|01AM0001||29|1|NF|00000283|01|01 |
FLANBAIXA | CODCOLIGADA|IDLAN|IDBAIXA | 2|1559|237 | PROTHEUS | 01|01AM0001||69|2|002 |
12.8.Mensagem ReversalOfAccountReceivableDocumentDischarge (Cancelamento de Baixa de Lançamentos a receber)
Não haverá registro na tabela De-Para para o cancelamento.
Após o cancelamento, o registro referente à baixa é excluído da tabela De-Para.
12.9.Mensagem FinancialTrading (Negociação de Lançamentos a receber)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
FACORDO | CODCOLIGADA|IDACORDO | 2|36 | PROTHEUS | 01|01AM0001|L000016 |
FACORDO | CODCOLIGADA|IDACORDO | 2|37 | PROTHEUS | 01|01AM0001|L000017 |
12.10.Mensagem ReversalOfFinancialTrading (Cancelamento de Negociação de Lançamentos a receber)
Não haverá registro na tabela De-Para para o cancelamento.
Após o cancelamento, o registro referente ao acordo (negociação) é excluído da tabela De-Para.
12.11.Mensagem OurNumberBanking (Nosso Número Bancário )
Não haverá registro na tabela De-Para para essa requisição.
12.12.Mensagem AccountingItem (Item Contábil)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
SITEMCONTABILPROTHEUS | CODCOLIGADA|IDITEMCONTABIL | 2|10 | PROTHEUS | 01|01AM |02 |
SITEMCONTABILPROTHEUS | CODCOLIGADA|IDITEMCONTABIL | 2|11 | PROTHEUS | 01|01AM |03 |
12.13.Mensagem ClassValue (Classe de Valor)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
SCLASSEVALORPROTHEUS | CODCOLIGADA|IDCLASSEVALOR | 2|10 | PROTHEUS | 01|01AM0001|01 |
SCLASSEVALORPROTHEUS | CODCOLIGADA|IDCLASSEVALOR | 2|11 | PROTHEUS | 01|01AM0001|01.01 |
12.14.Mensagem Item (Produto)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
TPRODUTO | CODCOLIGADA|IDPRD | 2|16 | PROTHEUS | 01||1 |
TPRODUTO | CODCOLIGADA|IDPRD | 2|17 | PROTHEUS | 01||2 |
12.15.Mensagem StockGroup (Grupo de Produtos)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
TTb2 | CODCOLIGADA|CODTB2FAT | 1|0076 | PROTHEUS | 01||0076 |
TTb2 | CODCOLIGADA|CODTB2FAT | 1|0077 | PROTHEUS | 01||0077 |
12.16.Mensagem UnitOfMeasure (Unidade de Medida)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
TUnd | CODUND | TS | PROTHEUS | 01||TS |
TUnd | CODUND | T1 | PROTHEUS | 01||T1 |
12.17.Mensagem OurNumberBanking (Nosso Número Bancário )
Não haverá registro na tabela De-Para para essa requisição.
12.18.Mensagem Assets (Ativos Fixos)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
IPATRIMONIO | CODCOLIGADA|IDPATRIMONIO | 1|1 | PROTHEUS | 01||01 |
IPATRIMONIO | CODCOLIGADA|IDPATRIMONIO | 1|1 | PROTHEUS | 01||02 |
12.19.Mensagem AccountPayableDocument (Contas a Pagar)
Tabela RM | Chave Primária RM | Valor Chave Primária RM | Sistema Integrado | Valor Chave Integração |
FLAN | CODCOLIGADA|IDLAN | 2|1380 | PROTHEUS | 01|01AM0001||68|1|002 |
FLAN | CODCOLIGADA|IDLAN | 2|1381 | PROTHEUS | 01|01AM0001||69|2|002 |
A integração RM Educacional x Backoffice Protheus utilizando Stored Procedure foi descontinuada a partir da versão 12.1.4 e portanto, nas migrações da versão 11 para a versão 12, caso o cliente já utilizasse a integração via Stored Procedure, é necessário sincronizar os dados existentes nas duas bases de dados (RM e Protheus).
O mecanismo da integração via stored procedure realiza a amarração dos dados de forma diferente do de/para da mensagem única, sendo necessária utilização de uma rotina que sincronize as bases, criando e alimentando o de/para com os InternalIds correspondentes a cada registro e suas empresas e filiais.
Para isso, foi criada a mensagem específica InternalIdLoad, que trafega os dados de cada registro gravado na base RM, junto com a contrapartida na base Protheus e o InternalId gravado no de/para do ambiente RM. Uma vez recebidos esses dados, é verificado se o registro enviado pelo RM existe de fato na base Protheus e caso exista, o InternalId recebido é gravado no de/para Protheus como ExternalId. Desta maneira o registro do Protheus é gerado e enviado para o RM registrar no de/para.
Neste processo a base histórica gerada por meio das stored procedures são portadas para o padrão utilizada na mensagem única.
As seguintes entidades da integração com o contábil estão incluídas no processo de Sincronizador De/Para:
Para que o sincronizador funcione corretamente, é necessário criar as pastas para gravação dos logs do sincronizador no Protheus. As pastas devem ser criadas a partir do RoothPath do Protheus, da seguinte forma: <RoothPath>/logs/CargaSolum |
A mensagem InternalIdLoad está atualmente na versão 1.000, e sua estrutura está definida da seguinte forma:
Tag | Descrição |
EntityName | Nome da entidade que está sendo sincronizada |
IntegrationId | Chave do registro a ser procurado no Protheus |
NewIntegrationId | InternalId gerado no RM |
O padrão de chave a ser trafegado na tag IntegrationId varia de acordo com a entidade a ser sincronizada. Abaixo a relação de formatos de chaves esperadas no recebimento no Protheus, conforme cada entidade:
Importante!
A entidade UNITOFMEASURE (Unidade de Medida) somente é utilizada para sincronizar as unidades cujos tamanhos de seus códigos sejam iguais, ou menores que dois, que é o tamanho padrão no Protheus. Para as outras unidades de medidas, caso seja necessário sincronizar, o processo deve ser feito manualmente, criando o de/para adequado para cada caso.
Entidade | IntegrationId |
UNITOFMEASURE (Unidade de Medida) | Código da Unidade de Medidas |
CUSTOMERVENDOR (Cliente) | “L;T+C”, Sendo: L = Loja do Cliente T = Tipo (“C” = Cliente / “F” = Fornecedor) C = Código do Cliente |
ACCOUNTRECEIVABLEDOCUMENT (Contas a Receber) | “N;P;F;TT;LC;TC+CC”, sendo: N = Número do Título P = Parcela do Título F = Prefixo do Título TT = Tipo do Título LC = Loja do Cliente do Título TC = Tipo do Cliente (“C” = Cliente / “F” = Fornecedor) CC = Código do Cliente |
BANK (Banco) | Banco|Agência|Conta |
Mensagens Únicas relacionadas a esta integração:
Método | ID | Descrição | Origem | Destino | Mensagem | Versão |
Cadastros | ||||||
01 | Moeda | PROTHEUS | RM | Currency | 2.001 | |
02 | Centro de custos | PROTHEUS | RM | CostCenter | 2.000 | |
03 | Item contábil | PROTHEUS | RM | AccountingItem | 1.000 | |
04 | Classe de valor | PROTHEUS | RM | ClassValue | 1.000 | |
05 | Cliente/Fornecedor | PROTHEUS/RM | PROTHEUS/RM | CustomerVendor | 2.002 | |
06 | Produto | PROTHEUS | RM | Item | 2.001 | |
07 | Unidade de Medida | PROTHEUS | RM | UnitOfMeasure | 2.000 | |
08 | Grupo de Produtos | PROTHEUS | RM | StockGroup | 1.000 | |
09 | Natureza | PROTHEUS | RM | FinancialNature | 2.000 | |
10 | Banco/Agência/Conta | PROTHEUS | RM | Bank | 2.001 | |
| 11 | Contas a receber | RM | PROTHEUS | AccountReceivableDocument | 2.007 |
| 12 | Contas a pagar | RM | PROTHEUS | AccountPayableDocument | 2.001 |
| 13 | Ativo Fixo (Patrimônio) | PROTHEUS | RM | Assets | 1.001 |
14 | Sincronização De-Para | RM | PROTHEUS | InternalIdLoad | 1.000 | |
Requisições | ||||||
15 | Baixas de Contas a receber | PROTHEUS/RM | RM/PROTHEUS | AccountReceivableDocumentDischarge | 2.001 | |
| 16 | Cancelamento de baixas de Contas a receber | PROTHEUS | RM | ReversalOfAccountReceivableDocumentDischare | 2.000 |
| 17 | Negociação de Contas a receber | PROTHEUS | RM | FinancingTrading | 1.002 |
| 18 | Cancelamento de Negociação | PROTHEUS | RM | ReversalOfFinancingTrading | 1.000 |
| 19 | Atualização de títulos | PROTHEUS | RM | UpdateContractParcel | 1.002 |
| 20 | Nosso número bancário | PROTHEUS | RM | OurNumberBanking | 1.000 |
É necessário realizar o cadastro manualmente no Protheus e no RM e posteriormente configurar o de/para para a integração correspondente. Ambos produtos (RM e Protheus), possuem interfaces específicas para esta finalidade
Integrações / Aba Integração / Mensagem Única / De-Para
Nas integrações com o Protheus, é necessário realizar o cadastro manual do De/Para de Coligada/Filial (conforme exemplo abaixo). Esse cadastro é necessário para que haja um relacionamento entre as Coligadas/Filiais do Educacional e do BackOffice Protheus.
Exemplo:
De-para RM (Filial) | |
Tabela RM | GFILIAL |
Chave Primária RM | CODCOLIGADA|CODFILIAL |
Valor Chave Primária RM | 1|2 |
Sistema Integrado | PROTHEUS |
Valor Chave Integração | 10|113 |
Identificador da Mensagem: Currency
Versão: 2.001
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
Code | GMOEDA | SIMBOLO | CTO | CTO_MOEDA |
InternalId | GMOEDA | SIMBOLO | CTO | CTO_FILIAL | CTO_MOEDA |
Description | GMOEDA | DESCRICAO | CTO | CTO_DESC |
Symbol | GMOEDA | SIMBOLO | CTO | CTO_SIMB |
Caminho para acesso ao cadastro do Moeda, no sistema:
Acesse BackOffice / Gestão Financeira / Movimentações Bancárias / Moedas e Índices
Identificador da Mensagem: CostCenter
Versão: 2.000
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | GCCUSTO | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | - | Variável do Sistema | ||
BranchId | - | Variável do Sistema | ||
InternalId | GCCUSTO | CODCOLIGADA|CODCCUSTO | CTT | CTT_FILIAL | CTT_CUSTO |
Code | GCCUSTO | CODCCUSTO | CTT | CTT_CUSTO |
Name | GCCUSTO | NOME | CTT | CTT_DESC01 |
RegisterSituation | GCCUSTO | ATIVO | CTT | CTT_BLOQ |
ShortCode | GCCUSTO | CODREDUZIDO | CTT | CTT_RES |
Sped | GCCUSTO | ENVIASPED | - | - |
Class | GCCUSTO | CTT | CTT_CLASSE |
Informações importantes sobre a integração e o TOTVS Gestão Financeira:
O código do centro de custo no TOTVS Gestão Financeira pode ser criado de forma sequencial, ou por meio de máscara. Sendo possível definir pelo parâmetro CENTROCUSTOAUTOINC, criado nos parâmetros de integração.
Caso o parâmetro esteja com valor True (marcado) o código enviado é ignorado e um código de auto incremento é gerado. Se o parâmetro estiver com valor False (desmarcado) é utilizado o código enviado pelo sistema de origem de acordo com a máscara utilizada.
Acesse Módulo Integração / Integração / Mensagem Única / Integrações / Anexo Parâmetros de Integração
A máscara de centro de custo deve ser removida para que o sistema financeiro TOTVS Gestão Financeira aceite os código enviado pelo Protheus, na integração.
É permitido o cadastro de máscara vazia caso tenha ntegração por mensagem única que utilize a mensagem de Centro de Custo.
No sistema, o parâmetro pode ser acessado pelo caminho:
Acesse Módulo BackOffice / Gestão Financeira / Ambiente / Parâmetros / TOTVS Gestão Financeira
02.02 – Contas a receber / 02.02.01 – Manutenção de Lançamentos / 02.02.01.01 – Lançamento / Centro de Custo / Máscara do Centro de Custo
Caminho para acesso ao cadastro do Centro de Custo, no sistema:
Acesse BackOffice / Gestão Financeira / Cadastros / Centro de Custo
(Mais detalhes do cadastro de Centro de Custo acesse Principais Cadastros da Integração)
Identificador da Mensagem: ClassValue
Versão: 1.000
Módulo Educacional: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | SCLASSEVALORPROTHEUS | CODCOLIGADA | - | Variável do Sistema |
BranchId | SCLASSEVALORPROTHEUS | CODFILIAL | - | Variável do Sistema |
CompanyInternalId | SCLASSEVALORPROTHEUS | CODCOLIGADA| CODFILIAL | - | Variável do Sistema |
Code | SCLASSEVALORPROTHEUS | CLASSEVALOR | CTH | CTH_CLVL |
InternalId | SCLASSEVALORPROTHEUS | CODCOLIGADA| IDCLASSEVALOR | CTH | CTH_FILIAL | CTH_CLVL |
Name | SCLASSEVALORPROTHEUS | DESCRICAO | CTH | CTH_DESC01 |
Class | SCLASSEVALORPROTHEUS | TIPO | CTH | CTH_CLASSE |
RegisterSituation | SCLASSEVALORPROTHEUS | STATUS | CTH | CTH_BLOQ |
Caminhos para a parametrização da Classe de Valor para a integração com o Protheus:
TOTVS Educacional
Acesse: Educacional / Educacional / Currículo e Oferta / Matrizes Curriculares
Anexo: Matriz Aplicada
Anexo: Dados financeiros - Integração Protheus
TOTVS Processo Seletivo
Acesse: Educacional / Processo Seletivo / Cadastros / Processo Seletivo
Anexo: Integração Protheus
TOTVS Gestão Bibliotecária
Acesse: Educacional / Gestão Bibliotecária / Tabelas auxiliares / Unidades bibliotecárias
Anexo: Integração Protheus
Caminho para acesso ao cadastro de Classe de valor, no sistema:
Educacional / Educacional / Integrações / Protheus / Classe de Valor
Educacional / Gestão Bibliotecária / Integrações / Protheus / Classe de Valor
Educacional / Processo Seletivo / Integrações / Protheus / Classe de Valor
(Mais detalhes do cadastro de Classe de Valor acesse Principais Cadastros da Integração)
Identificador da Mensagem: AccountingItem
Versão: 1.000
Módulo Educacional: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | SITEMCONTABILPROTHEUS | CODCOLIGADA | - | Variável do Sistema |
BranchId | SITEMCONTABILPROTHEUS | CODFILIAL | - | Variável do Sistema |
Code | SITEMCONTABILPROTHEUS | ITEMCONTABIL | CTD | CTD_ITEM |
Description | SITEMCONTABILPROTHEUS | DESCRICAO | CTD | CTD_DESC01 |
CostCenterCode | Não se aplica. | Não se aplica. | ||
InternalId | SITEMCONTABILPROTHEUS | CODCOLIGADA| IDITEMCONTABIL | CTD | CTD_FILIAL | CTD_ITEM |
Caminhos para a parametrização do Item Contábil para a integração com o PROTHEUS:
TOTVS Educacional
Acesse: Educacional / Educacional / Currículo e Oferta / Matrizes Curriculares
Anexo: Matriz Aplicada
Anexo: Dados financeiros - Integração Protheus
TOTVS Processo Seletivo
Acesse: Educacional / Processo Seletivo / Cadastros / Processo Seletivo
Anexo: Integração Protheus
TOTVS Gestão Bibliotecária
Acesse: Educacional / Gestão Bibliotecária / Tabelas auxiliares / Unidades bibliotecárias
Anexo: Integração Protheus
Caminho para acesso ao cadastro de Item Contábil, no sistema:
Educacional / Educacional / Integrações / Protheus / Item Contábil
Educacional / Gestão Bibliotecária / Integrações / Protheus / Item Contábil
Educacional / Processo Seletivo / Integrações / Protheus / Item Contábil
(Mais detalhes do cadastro de Item Contábil acesse Principais Cadastros da Integração)
Na versão 11.83.55 a integração ainda trata a mensagem de Item Contábil como Department, na versão 1.000. |
Identificador da Mensagem: UnitOfMeasure
Versão: 2.000
Módulo Educacional: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
Code | TUnd | CODUN | SAH | AH_UNIMED |
Description | TUnd | DESCRICAO | SAH | AH_FILIAL|AH_UNIMED |
InternalId | TUnd | CODUN | SAH | AH_DESCPO |
Caminhos para o cadastro de unidade de medida:
Acesse: BackOffice / Gestão de Estoque, Compras e Faturamento / Cadastros / Mais... / Tabelas Auxiliares / Unidade
Identificador da Mensagem: StockGroup
Versão: 1.000
Módulo Educacional: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CodColigada | TTB2 | CODCOLIGADA | xFilial() | |
Code | TTB2 | CODTB2FAT | SBM | BM_GRUPO |
Description | TTB2 | DESCRICAO | SBM | BM_DESC |
InternalId | TTB2 | CODCOLIGADA|CODTB2FAT | SBM | BM_GRUPO |
Caminho para acesso a tabela de classificação, no sistema:
BackOffice / Gestão de Estoque, Compras e Faturamento / Cadastros / Tabelas de Classificação
As informações de grupo de produtos utilizam sempre a Tabela de Classificação 2 com o nome de Grupo de Produtos. Marque as opções Usar em Produto, Usar em Item de Movimento e Usar em Movimento.
Os parâmetros de tabelas de classificação podem ser acessados, no caminho:
BackOffice / Gestão de Estoque, Compras e Faturamento / Ambiente / Parâmetros / Gestão de Estoque, Compras e Faturamento
04.01 – Parâmetros Gerais / 04.01.04 – Tabelas / 04.01.04.01 – Classificação
Identificador da Mensagem: Item
Versão: 2.001
Módulo Gestão de Estoque, Compras e Faturamento: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | TPRODUTO | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | - | Variável do Sistema | ||
BranchId | - | Variável do Sistema | ||
Code | TPRODUTO | CODIGOPRD | SB1 | B1_COD |
InternalId | TPRODUTO | CODCOLIGADA| IDPRD | SB1 | B1_FILIAL | B1_COD |
Name | TPRODUTO | DESCRICAO | SB1 | B1_DESC |
ShortName | TPRODUTO | NOMEFANTASIA | SB1 | B1_DESC |
Detail | - | - | ||
Active | TPRODUTO | INATIVO | SB1 | B1_ATIVO |
StockGroupCode | SB1 | B1_GRUPO | ||
StockGroupCodeInternalId | SBM | BM_FILIAL | BM_GRUPO | ||
StockGroupCodeDescription | SB1 | B1_GRUPO | ||
UnitOfMeasureCode | TPRODUTODEF | CODUNDCONTROLE | SB1 | B1_UM |
UnitOfMeasureInternalId | SB1 | B1_FILIAL | B1_UM | ||
ObtainingType | - | - | ||
ComercialFamilyCode | - | - | ||
ComercialFamilyInternalId | - | - | ||
ComercialFamilyDescription | - | - | ||
DeployDate | TPRODUTO | DTCADASTRAMENTO | - | - |
ReleaseDate | - | - | ||
StandardWareHouseCode | SB1 | B1_LOCPAD | ||
StandardWareHouseDescription | SB1 | B1_LOCPAD | ||
MultipleLot | - | - | ||
EconomicLot | SB1 | B1_LE | ||
MinimumLot | SB1 | B1_LM | ||
QualityControl | - | - | ||
ControlType | - | - | ||
StockControlType | - | - | ||
FractionalQuantity | - | - | ||
NetWeight | SB1 | B1_PESO | ||
GrossWeight | SB1 | B1_PESBRU | ||
FamilyCode | SB1 | B1_FPCOD | ||
FamilyInternalId | SYC | SYC_FILIAL | SYC_FPCOD | ||
FamilyDescription | SB1 | B1_FPCOD | ||
FamilyClassificationCode | - | - | ||
FormulaType | - | - | ||
PerMillion | - | - | ||
IsScrapStockControl | - | - | ||
IsScrapFiscalPrice | - | - | ||
ScrapItemCode | - | - | ||
ScrapItemInternalId | - | - | ||
ScrapItemQuantity | - | - | ||
Origin |
|
| SB1 | B1_ORIGEM |
FiscalInformation |
|
| SB1 | B1_POSIPI |
ListOfCustomerItemInformation |
|
| SA7 | A7_PRODUTO |
CostCenterCode |
|
| - | - |
CostCenterInternalId |
|
| - | - |
GroupCode |
|
| - | - |
GroupInternalId |
|
| - | - |
GroupName |
|
| - | - |
SecondUnitOdMeasureCode |
|
| SB1 | B1_SEGUM |
SecondUnitOfMeasureInternalId |
|
| SB1 | B1_FILIAL | B1_SEGUM |
MultiplicationFactorValue |
|
| SB1 | B1_TIPCONV |
Values |
|
| SB1 | B1_CUSTD |
ProductType |
|
| SB1 | B1_TIPO |
Trail |
|
| SB1 | B1_RASTRO |
GovernmentCode | - | - |
Informações importantes sobre o cadastro de produtos:
O cadastro de produto é utilizado somente para vínculo com o serviço do Educacional e envio posterior, junto com o lançamento a receber para o backoffice Protheus. Por isso são utilizados os campos código e descrição do produto.
As definições Máscara e Opções para a Máscara de produto devem ser alteradas para QQQQQQQQQQQQQ e Não controla níveis de máscara respectivamente, para que o RM aceite os produtos enviados pelo Protheus na integração.
Caminho para acesso ao parâmetro para definições de produto:
Acesse: BackOffice / Gestão de Estoque, Compras e Faturamento / Ambiente / Parâmetros / Gestão de Estoque, Compras e Faturamento
04.01 – Parâmetros Gerais / 04.01.04 – Tabelas / 04.01.04.01 – Definições Gerais
Caso possua no Protheus informações de unidade de medida e grupo de produtos, são enviados antes pela integração por meio das mensagens: UnitOfMeasure e StockGroup,
No cenário em que o Protheus possua compartilhamento por Empresa e por Filial para o produto, o TOTVS Gestão de Estoque, Compras e Faturamento deve ser parametrizado para utilizar um cadastro de produto global. Dessa maneira, todos os produtos são cadastrados na coligada 0 assumindo o comportamento de compartilhados para todas as coligadas.
Caminho para acesso ao parâmetro para permitir o cadastro global:
Acesse BackOffice / Gestão de Estoque, Compras e Faturamento / Ambiente / Parâmetros / Gestão de Estoque, Compras e Faturamento
04.01 – Parâmetros Gerais / 04.01.04 – Tabelas / 04.01.04.07 – Produtos / 04.01.04.07.07 –Produto Global / Usa Produto Global
Essa configuração é realizada somente caso o Protheus tenha um compartilhamento por Empresa. |
Caminho para a parametrização da natureza para a integração com o Protheus:
Acesse: Educacional / Educacional / Financeiro/Contábil / Serviços
Anexo: Dados financeiros - Integração Protheus
Caminho para o cadastro de produtos no TOTVS Gestão de Estoque, Compras e Faturamento:
Acesse: BackOffice / Gestão de Estoque, Compras e Faturamento / Cadastros / Produto
Identificador da Mensagem: CustomerVendor
Versão: 2.002
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | FCFO | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | - | Variável do Sistema | ||
BranchId | - | Variável do Sistema | ||
StoreId | SA1/SA2 | A1_LOJA/A2_LOJA | ||
InternalId | FCFO | CODCOLIGADA| CODCFO | SA1/SA2 | A1_FILIAL | A1_COD | A1_LOJA / A2_FILIAL | A2_COD | A2_LOJA |
Code | FCFO | CODCFO | SA1/SA2 | A1_COD / A2_COD |
Name | FCFO | NOME | SA1/SA2 | A1_NOME / A2_NOME |
EntityType | FCFO | PESSOAFISOUJUR | SA1/SA2 | A1_PESSOA / A2_TIPO |
Type | - | Variável do Sistema | ||
RegisterDate | SA1 | A1_DTNASC | ||
Comments | - | - | ||
Address.Address | FCFO | RUA | SA1/SA2 | A1_END / A2_END |
Address.Number | FCFO | NUMERO | SA1/SA2 | A1_END / A2_END |
Address.District | FCFO | BAIRRO | SA1/SA2 | A1_BAIRRO / A2_BAIRRO |
Address.Complement | FCFO | COMPLEMENTO | SA1/SA2 | A1_COMPLEM / A2_ENDCOMP |
Address.State | FCFO | CODETD | SA1/SA2 | A1_EST / A2_EST |
Address.CityName | FCFO | CIDADE | SA1/SA2 | A1_CODMUNE / A2_COD_MUN |
CountryType.CountryCode | SA1/SA2 | A1_PAIS / A2_PAIS | ||
CountryType.CountryDescription | FCFO | PAIS | SA2 | A2_PAISDES |
Address.ZIPCode | FCFO | CEP | SA1/SA2 | A1_CEP / A2_CEP |
CommunicationInformation.PhoneNumber | FCFO | TELEFONE | SA1/SA2 | A1_TEL / A2_TEL |
CommunicationInformation.FaxNumber | FCFO | FAX | SA1/SA2 | A1_FAX / A2_FAX |
CommunicationInformation.Email | FCFO | SA1/SA2 | A1_EMAIL / A2_EMAIL | |
GovernmentalInformation | FCFO | CIDENTIDADE | - | |
GovernmentalInformation | FCFO | CGCCFO | SA1/SA2 | A1_CGC / A2_CGC |
GovernmentalInformation | FCFO | INSCRESTADUAL | SA1/SA2 | A1_INSCR / A2_INSCR |
GovernmentalInformation | FCFO | INSCRMUNICIPAL | SA1/SA2 | A1_INSCRM / A2_INSCRM |
BillingInformation.Address.Address | FCFO | RUAPGTO | SA1 | A1_ENDCOB |
BillingInformation.Address.Number | FCFO | NUMEROPGTO | SA1 | A1_ENDCOB |
BillingInformation.Address.District | FCFO | BAIRROPGTO | SA1 | A1_BAIRROC |
BillingInformation.Address.ZipCode | FCFO | CEPPGTO | SA1 | A1_CEPC |
BillingInformation.Address.CityName | FCFO | CIDADEPGTO | SA1 | A1_MUNC |
BillingInformation.Address.State | FCFO | CODETDPGTO | SA1 | A1_ESTC |
ShippingAddress.Address | FCFO | RUAENTREGA | - | - |
ShippingAddress.Number | FCFO | NUMEROENTREGA | - | - |
ShippingAddress.District | FCFO | BAIRROENTREGA | - | - |
ShippingAddress.ZipCode | FCFO | CEPENTREGA | - | - |
ShippingAddress.CityName | FCFO | CIDADEENTREGA | - | - |
ShippingAddress.State | FCFO | CODETDENTREGA | - | - |
Contact | FCFO | CONTATO | SA1/SA2 | A1_CONTATO / A2_CONTATO |
RegisterSituation | FCFO | ATIVO | SA1/SA2 | A1_MSBLQL / A2_MSBLQL |
Informações importantes sobre o cadastro de clientes:
O cadastro de cliente/fornecedor é utilizado por ambos os lados. Os cadastrados podem ser realizados no Backoffice Protheus ou no TOTVS Gestão Financeira.
Ao integrar por mensagem única com o Protheus, o cliente/fornecedor não poderá ser cadastro como ambos, PAGREC igual a 3. Não sendo possível a alteração de uma classificação de Cliente para Fornecedor ou vice versa.
O código de Cliente/Fornecedor é gerado de acordo com a parametrização do TOTVS Gestão Financeira. É gerado um código incremental de acordo com a máscara cadastrada. Se o sistema estiver integrado ao Protheus por mensageria única, será permitido a inclusão de uma máscara vazia.
O tamanho máximo do código de cliente/fornecedor não deve ultrapassar 9 caracteres.
Se for definida uma máscara vazia no Financeiro e no Educacional para o cadastro do Cliente/Fornecedor, ao gerar um responsável financeiro no cadastro de Alunos, internamente, será adotada uma máscara numérica com 09 posições.
O parâmetro para utilização de código sequencial numérico deve ser desabilitado caso a integração Educacional x BackOffice Protheus esteja ativa.
O sistema permite a alteração da máscara para vazio, quando integrado, porém não será permitido a alteração de nulo para outro valor.
No ambiente do Backoffice Protheus, os campos A1_LOJA e A2_LOJA (tabelas SA1 e SA2, respectivamente) devem ter os inicializadores padrão preenchidos (X3_RELACAO) com um valor default para a loja, evitando que haja inconsistência dos dados quando for efetuado um cadastro de cliente/fornecedor no ambiente TOTVS Educacional.
Parâmetro para cadastro da máscara de cliente:
Acesse: Módulo Gestão Financeira / Ambiente / Parâmetros / TOTVS Gestão Financeira / 02.02 – Contas a receber / 02.02.01 – Manutenção de Lançamentos / 02.02.01.01 – Lançamento / Cliente / Fornecedor / Máscara do código
Para o cenário em que o Protheus tiver um compartilhamento por Empresa, o TOTVS Gestão Financeira deve ser parametrizado para utilizar clientes globais.
Acesse: BackOffice / Gestão Financeira / Ambiente / Parâmetros / TOTVS Gestão Financeira
02.02 – Contas a receber / 02.02.01 – Manutenção de Lançamentos / 02.02.01.01 – Lançamento / Cliente / Fornecedor / Permite Globais
Acesse: BackOffice / Gestão Financeira / Ambiente / Parâmetros / TOTVS Gestão Financeira
02.02 – Contas a receber / 02.02.01 – Manutenção de Lançamentos / 02.02.01.01 – Lançamento / Cliente / Fornecedor / Default Cli/For Globais
A configuração para cliente global é realizada somente caso o Protheus tenha um compartilhamento por Empresa. |
Caminho para acesso ao cadastro de Cliente/Fornecedor no sistema:
BackOffice / Gestão Financeira / Cadastros / Clientes Fornecedores
Para o envio e o recebimento do código do país do Cliente/Fornecedor é necessário a utilização da tabela de Classificação de País do módulo fiscal.
A Tabela de Classificação pode ser acessada pelo endereço:
BackOffice / Gestão Fiscal / Cadastros / Globais / Mais... / Endereço / Classificação de País
Pelo anexo de codificação no cadastro de país do módulo fiscal é possível cadastrar um código de acordo com a tabela de classificação inclusa.
O cadastro de codificação de país pode ser acessado pelo endereço:
BackOffice / Gestão Fiscal / Cadastros / Globais / Mais... / Países / Anexos / Codificação de País
Para identificação de qual tabela de classificação será utilizada, foi criado o parâmetro de integração CODCLASSIFICPAIS para incluir o código da tabela cadastrada.
Caminho para o parâmetro de integração:
Integração / Mensagem Única / Integrações
Anexos: Parâmetros de integração
Identificador da Mensagem: FinancialNature
Versão: 2.000
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | TTBORCAMENTO | CODCOLIGADA | - | Variável do Sistema |
BranchId | TTBORCAMENTO | - | Variável do Sistema | |
Code | TTBORCAMENTO | CODTBORCAMENTO | SED | ED_CODIGO |
Description | TTBORCAMENTO | DESCRICAO | SED | ED_DESCRIC |
NatureType | TTBORCAMENTO | SINTETICOANALITICO | SED | ED_TIPO |
UseCategory | TTBORCAMENTO | NATUREZA | SED | ED_COND |
Blocked | TTBORCAMENTO | INATIVO | - | - |
Informações importantes sobre o cadastro de natureza financeira:
O código da natureza financeira deve ser criado de forma sequencial ou utilizando o código enviado. Essa definição poderá ser feita através do parâmetro NATUREZAFISCALAUTOINC criado nos parâmetros de integração.
Se o parâmetro estiver com valor True (marcado) o código enviado será ignorado e um código de auto incremento será gerado. Se o parâmetro estiver com valor False (desmarcado) será utilizado o código enviado pelo sistema de origem.
Acesse: Integração / Integração / Mensagem Única / Integrações / Anexo Parâmetros de integração
Caminhos para a parametrização da natureza para a integração com o Protheus:
TOTVS Educacional
Acesse: Educacional / Educacional / Financeiro/Contábil / Serviços
Anexo: Dados financeiros - Integração Protheus
TOTVS Processo Seletivo
Acesse: Educacional / Processo Seletivo / Cadastros / Processo Seletivo
Anexo: Integração Protheus
TOTVS Gestão Bibliotecária
Acesse: Educacional / Gestão Bibliotecária / Tabelas auxiliares / Unidades bibliotecárias
Anexo: Integração Protheus
Caminho para acesso ao cadastro de naturezas no sistema:
BackOffice / Gestão Financeira / Cadastros / Natureza Orçamentária Financeira
(Mais detalhes do cadastro de Natureza Financeira acesse Principais Cadastros da Integração)
Identificador da Mensagem: Bank
Versão: 2.001
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | FCONTA | CODCOLIGADA | - | Variável do Sistema |
BranchId | - | Variável do Sistema | ||
CompanyId | - | Variável do Sistema | ||
Code | GBANCO | NUMBANCO | SA6 | A6_COD |
InternalId | SA6 | A6_FILIAL | A6_COD | ||
Febraban | GBANCO | NUMEROOFICIAL | SA6 | A6_NUMBCO |
Name | GBANCO | NOME | SA6 | A6_NOME |
ShortName | GBANCO | NOMEREDUZIDO | SA6 | A6_NREDUZ |
ListOfAgency.Agency.Number | GAGENCIA | NUMAGENCIA | SA6 | A6_AGENCIA |
ListOfAgency.Agency.Name | GAGENCIA | NOME | SA6 | A6_NOMEAGE |
ListOfAgency.Agency.ShortName | - | - | ||
ListOfAgency.Agency.Address.Address | GAGENCIA | RUA | SA6 | A6_END |
ListOfAgency.Agency.Address.Number | GAGENCIA | NUMERO | - | - |
ListOfAgency.Agency.Address.State | GAGENCIA | ESTADO | - | - |
ListOfAgency.Agency.Address.City | GAGENCIA | CIDADE | SA6 | A6_MUN |
ListOfAgency.Agency.Address.ZIPCode | GAGENCIA | CEP | SA6 | A6_CEP |
ListOfAgency.Agency.Address.Country | GAGENCIA | PAIS | SA6 | A6_PAISBCO |
CommunicationInformation.PhoneNumber | GAGENCIA | TELEFONE | SA6 | A6_NUMBER |
ListOfAccount.Account.CompanyId | - | Variável do Sistema | ||
ListOfAccount.Account.Number | FCONTA| FCONVENIO | NUMAGENCIA| NROCONTA | SA6 | A6_NUMCON |
ListOfAccount.Account.AccountantAccountCode | FCXA | CODECXA | SA6 | A6_CONTA |
ListOfAccount.Account.Name | FCXA | DESCRICAO | - | - |
ListOfAccount.Contract.TransferorName | FCONVENIO | CEDENTE | SM0 | M0_NOMECOM |
ListOfAccount.Contract.TransferorCode | FCONVENIO | CODCEDENTE | SA6 | A6_CODCED |
ListOfAccount.Contract.BookType | FCONVENIO | TIPOCARTEIRA | SEE | EE_TIPCART |
ListOfAccount.Contract.BookCode | FCONVENIO | CARTEIRA | SEE | EE_CODCART |
ListOfAccount.Account.DigitAccount | FCONTA | DIGCONTA | SA6 | A6_DVCTA |
ListOfAccount.Contract.ContractNumber | FCONVENIO | IDCONVENIO | SEE | EE_NUMCTR |
ListOfAccount.Contract.ChargeType | FCONVENIO | TIPOCOB | SEE | EE_TPCOBRA |
Informações importantes sobre o cadastro de bancos:
A mensagem de Banco é utilizada para realizar o cadastro de Bancos, Agências, Contas Correntes, Conta Caixas e Convênios.
Como o cadastro é realizado no Protheus, os cadastros do TOTVS Gestão Financeira são desabilitados para inclusão e exclusão, caso o parâmetro utilize integração com Protheus esteja habilitado e utilizando o modelo novo de integração (Mensagem) tendo a integração Educacional x BackOffice Protheus ativa.
Os campos preenchidos pela integração são desabilitados e apenas informações pertinentes do TOTVS Gestão Financeira podem ser editados. Seguem possíveis campos que podem ser necessários o preenchimento, na geração de lançamentos a receber:
Bancos:
Agência:
Conta-Corrente:
Convênio:
Caminhos para acesso aos cadastros no sistema:
Bancos:
BackOffice / Gestão Financeira / Movimentações Bancárias / Bancos e Agências
Educacional / Educacional / Integrações / Protheus / Bancos e Agências
Agências:
BackOffice / Gestão Financeira / Movimentações Bancárias / Bancos e Agências
Anexo: Agência
Educacional / Educacional / Integrações / Protheus / Bancos e Agências
Anexo: Agência
Contas:
BackOffice / Gestão Financeira / Movimentações Bancárias / Contas Correntes
Educacional / Educacional / Integrações / Protheus / Bancos e Agências
Anexo: Agência
Anexo: Conta Corrente
Contas Caixas:
BackOffice / Gestão Financeira / Movimentações Bancárias / Contas/Caixa
Convênio:
BackOffice / Gestão Financeira / Movimentações Bancárias / Convênio
Educacional / Educacional / Integrações / Protheus / Convênio
(Mais detalhes do cadastro de Bancos acesse Principais Cadastros da Integração)
Os campos, do XML, número do contrato, nome do cedente e código do cedente devem ser preenchidos para que o cadastro do convênio seja realizado. Ao receber a mensagem de banco, caso uma dessas três informações estejam em branco o cadastro não é realizado não sendo gerada a mensagem de validação. |
Identificador da Mensagem: AccountReceivableDocument
Versão: 2.007
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | FLAN | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | FLAN | CODCOLIGADA| CODFILIAL | - | Variável do Sistema |
BranchId | FLAN | CODFILIAL | - | Variável do Sistema |
InternalId | FLAN | CODCOLIGADA| IDLAN | SE1 | E1_FILIAL | E1_PREFIXO | E1_NUM | E1_PARCELA | E1_TIPO |
DocumentPrefix | FLAN | SERIEDOCUMENTO | SE1 | E1_PREFIXO |
DocumentNumber | FLAN | NUMERODOCUMENTO | SE1 | E1_NUM |
DocumentParcel | “1” | SE1 | E1_PARCELA | |
DocumentTypeCode | FLAN | CODTDO | SE1 | E1_TIPO |
HolderCode | FBANCO | NUMBANCO | SE1 | E1_PORTADO |
HolderType | - | - | ||
AgencyNumber | FCONVENIO | NUMAGENCIA | SE1 | E1_AGEDEP |
AccountNumber | FCONVENIO | NROCONTA | SE1 | E1_CONTA |
ContractNumber | FLAN | CONVENIO | SE1 | E1_CONTRAT |
OurNumberBanking | FBOLETO | NOSSONUMERO | SE1 | E1_NUMBCO |
BarCode | FBOLETO | CODIGOBARRA | - | - |
Situation | FLAN | STATUSLAN | - | - |
IssueDate | FLAN | DATAEMISSAO | SE1 | E1_EMISSAO |
DiscountDate | - | - | ||
DiscountPercentage | SE1 | E1_DESCFIN | ||
InterestPercentage | SE1 | E1_PORCJUR | ||
AssessmentValue | SE1 | E1_VALJUR | ||
DueDate | FLAN | DATAVENCIMENTO | SE1 | E1_VENCTO |
ExtendedDate | - | - | ||
AccountingDate | - | - | ||
ChargeInterest | - | - | ||
CustomerCode | FLAN | CODCFO | SE1 | E1_CLIENTE |
CustomerInternalId | FLAN | CODCOLCFO|CODCFO | SE1 | E1_CLIENTE | E1_LOJA |
StoreId | SE1 | E1_LOJA | ||
CustomerBankCode | - | - | ||
NetValue | FLAN | VALORORIGINAL | SE1 | E1_VALOR |
GrossValue | FLAN | VALORORIGINAL | SE1 | E1_VALOR |
UnconditionalScholarshipValue | SE1 | E1_VLBOLSA | ||
InvoiceAmount | - | - | ||
CurrencyCode | FLAN | CODMOEVALORORIGINAL | SE1 | E1_MOEDA |
CurrencyInternalId | FLAN | CODMOEVALORORIGINAL | SE1 | E1_MOEDA |
CurrencyRate | SE1 | E1_TXMOEDA | ||
Taxes | SE1 | Campos de base de imposto | ||
ApportionmentDistribution | SE1 | Campos de rateio | ||
Observation | FLAN | HISTORICO | SE1 | E1_HIST |
Origin | FLAN | ORIGIN | SE1 | E1_ORIGEM |
FinancialNatureInternalId | SSERVICOINTPROTHEUS | IDNATUREZA | SE1 | E1_NATUREZ |
Other.AcademicRecord | SPARCELA | RA | SE1 | E1_NUMRA |
Other.Class | STURMADISC | IDTURMADISC | SE1 | E1_TURMA |
Other.AppliedMatrix | SHABILITACAOFILIAL | IDHABILITACAOFILIAL | SE1 | E1_IDAPLIC |
Other.AdemicPeriod | STURMADISC | IDPERLET | SE1 | E1_PERLET |
Other.ItemInternalId | SSERVICOINTPROTHEUS | CODCOLIGADA | IDPRD | SE1 | E1_PRODUTO |
Accounting.AccountingCodeDebit | SE1 | E1_DEBITO | ||
Accounting.AccountingCodeCredit | SE1 | E1_CREDIT | ||
Accounting.CostCenterDebit | SSERVICOINTPROTHEUS | CODCCUSTO | SE1 | E1_CCD |
Accounting.CostCenterCredit | SSERVICOINTPROTHEUS | CODCCUSTO | SE1 | E1_CCC |
Accounting.DepartmentCredit | SHABILITACAOFILIALINTPROTHEUS / LUNIDADEPARAMPROTHEUS / SPSPROCSELINTPROTHEUS | ITEMCONTABIL | SE1 | E1_ITEMD |
Accounting.ClassValueCredit | SHABILITACAOFILIALINTPROTHEUS / LUNIDADEPARAMPROTHEUS / SPSPROCSELINTPROTHEUS | CLASSEVALOR | SE1 | E1_CLVLDB |
Accounting.DepartmentDebit | SHABILITACAOFILIALINTPROTHEUS / LUNIDADEPARAMPROTHEUS / SPSPROCSELINTPROTHEUS | ITEMCONTABIL | SE1 | E1_ITEMC |
Accounting.ClassValueDebit | SHABILITACAOFILIALINTPROTHEUS / LUNIDADEPARAMPROTHEUS / SPSPROCSELINTPROTHEUS | CLASSEVALOR | SE1 | E1_CLVLCR |
Informações importantes sobre os lançamentos a receber:
A mensagem de Contas a receber é utilizada para enviar ao BackOffice Protheus, os títulos gerados pelos sistemas TOTVS Educacional, TOTVS Gestão Bibliotecária e TOTVS Processo Seletivo e receber alterações e exclusão de títulos do BackOffice Protheus. Ou seja, toda vez que o TOTVS Gestão Financeira receber solicitação de lançamento por esses sistemas, é verificado se este está integrado ao Protheus pelo modelo novo (Mensageria) para envio da mensagem.
Caso o sistema esteja parametrizado para o novo modelo (Mensageria) de integração, não é possível criar títulos através do TOTVS Gestão Financeira, apenas pelos produtos (TOTVS Educacional, TOTVS Gestão Bibliotecária, TOTVS Processo Seletivo e TOTVS Gestão de Estoque, Compra e Faturamento). O parâmetro para regeração de lançamentos cancelados são desabilitados, caso esteja com uma integração ativa.
Existe um limitação do tamanho do número do documento, para a mensagem única de 9 posições. O sistema deve ser configurado para seja adequado a esse tamanho.
O número da parcela do lançamento para integração com o Protheus será sempre 1, independente do código gerado no campo de parcela da FLAN. Essa definição é necessária devido a diferença de conceito no que se refere a parcela do lançamento (Título para o Protheus).
Informações bancárias, como Banco, Agência, Conta, são enviadas na mensagem de lançamentos a receber para o Protheus, apenas quando houver um convênio vinculado a conta caixa configurada para a geração do lançamento.
Lançamentos a receber gerados de faturamento de movimento, pelo TOTVS Gestão de Estoque, Compras e Faturamento, não podem ser cancelados a partir do Protheus. Para a realização do cancelamento desses lançamentos o movimento referente terá que ser cancelado.
Os tipo de documentos utilizados para geração de lançamentos de Faturamentos de Contratos devem ser alterados para gerarem numeração sequencial.
No ambiente Protheus a numeração automática do título (E1_NUM) não pode estar ativada. O sistema valida se existe controle de numeração automática ativado e caso esteja, não permite a utilização da mensagem única, retornando mensagem de XML notificando sobre essa inconsistência.
Acesse: BackOffice / Gestão Financeira / Ambiente / Parâmetros / TOTVS Gestão Financeira
02.02 – Contas a receber | 02.02.01 – Manutenção de Lançamentos / 02.02.01.01 – Lançamento / Inclusão / Tamanho do número / Documento
Acesse: BackOffice / Gestão Financeira / Cadastros / Tipos Documento / Último número
Seguem os processos relacionados, que geram mensagens de lançamentos a receber para a integração:
No TOTVS Educacional, caso o processo de geração de lançamento for acionado, após a inclusão/alteração do lançamento, deve ser enviado a mensagem com as informações do título para o Protheus.
No TOTVS Educacional, ao executar o processo de alteração de data vencimento de boleto, caso seja informado para alterar os vencimentos dos lançamentos, é enviada uma mensagem de lançamento a receber com a informação da nova data de vencimento.
No TOTVS Processo Seletivo, ao realizar a inscrição do candidato, deve ser enviado a mensagem com as informações do título para o Protheus.
No TOTVS Processo Seletivo, ao executar o processo de alteração de vencimento de lançamentos, é enviada uma mensagem com a informação da nova data de vencimento.
No TOTVS Processo Seletivo, ao excluir uma inscrição, é enviada uma mensagem solicitando a exclusão da mensagem para a integração.
No TOTVS Processo Seletivo, ao realizar a inscrição de candidatos anônima, deve ser enviado a mensagem com as informações do título para o Protheus.
No TOTVS Processo Seletivo, ao alterar a forma de inscrição do candidato, deve ser enviado a mensagem com as informações do título para o Protheus.
No TOTVS Gestão Bibliotecaria, ao gerar uma devolução com geração de multa, deve ser enviado a mensagem com as informações do título para o Protheus.
No TOTVS Gestão Bibliotecaria, ao criar um novo usuário e/ou realizar a renovação do mesmo, caso seja gerado um lançamento, deve ser enviado a mensagem com as informações do título para o Protheus.
No TOTVS Gestão de Estoque, Compras e Faturamento, quando os contratos forem faturados e houver integração com o TOTVS Educacional, para associação de matrículas, os lançamentos são enviados para a integração.
Para que o valores de bolsa incondicional seja enviado para a tag UnconditionalScholarshipValue, no RM o parametro de intgração "ENVIAVLRBOLSAINCONDICIONAL" deve estar marcado como "True". Se o mesmo não estiver aparecendo será necessário gerar a configuração novamente, caso ainda não aparece favor entrar em contato com o suporte, pois pode ser necessário executar alguns scripts.
Identificador da Mensagem: AccountPayableDocument
Versão: 2.001
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
InternalId | FLAN | CODCOLIGADA | FLAN/IDLAN | SE2 | M0_CODIGO | E2_FILIAL | E2_PREFIXO | E2_NUM | E2_PARCELA | E2_TIPO | E2_FORNECE | E2_LOJA |
CompanyId | FLAN | CODCOLIGADA | SM0 | M0_CODIGO |
BranchId | FLAN | CODFILIAL | SE2 | E2_FILIAL |
CompanyInternalId | FLAN | CODCOLIGADA | FLAN/CODFILIAL | SE2 | M0_CODIGO | E2_FILIAL |
DocumentPrefix | FLAN | SERIEDOCUMENTO | SE2 | E2_PREFIXO |
DocumentNumber | FLAN | NUMERODOCUMENTO | SE2 | E2_NUM |
DocumentParcel | FLAN | PARCELA | SE2 | E2_PARCELA |
DocumentTypeCode | FLAN | CODTDO | SE2 | E2_TIPO |
IssueDate | FLAN | DATAEMISSAO | SE2 | E2_EMISSAO |
DueDate | FLAN | DATAVENC | SE2 | E2_VENCTO |
RealDueDate | FLAN | DATAVENC | SE2 | E2_VENCREA |
VendorCode | FLAN | CODCFO | SE2 | E2_FORNECE |
VendorInternalId | FLAN | CODCOLCFO | CODCFO | SE2 | M0_CODIGO | E2_FILIAL | E2_FORNECE | E2_LOJA | F |
StoreId | SE2 | E2_LOJA | ||
NetValue | FLAN | VALORORIGINAL | SE2 | E2_VALOR |
GrossValue | FLAN | VALORORIGINAL | SE2 | E2_VALOR |
CurrencyCode | FLAN | CODMOEDA | SE2 | E2_MOEDA |
CurrencyInternalId | FLAN | CODMOEDA | SE2 | M0_CODIGO | CTO_FILIAL | E2_MOEDA |
CurrencyRate | SE2 | E2_TXMOEDA | ||
| ||||
ListOfSourceDocument | ListOfSourceDocument | |||
| ||||
Taxes | Taxes | |||
| ||||
ApportionmentDistribution | FLANRATCCU | ApportionmentDistribution | - | - |
Apportionment | - | - | ||
InternalId | FLANRATCCU | CODCOLIGADA| IDLAN | IDRATCCU | - | - |
CostCenterInternalId | FLANRATCCU | CODCOLIGADA| CODCCUSTO | CV4 | M0_CODIGO | CTT_FILIAL | CV4_CCD |
CostCenterCode | FLAN | CODCCUSTO | CV4 | CV4_CCD |
ProjectInternalId | ||||
TaskInternalId | ||||
Value | FLANRATCCU | VALOR | CV4 | CV4_VALOR |
Percentual | FLANRATCCU | PERCENTUAL | ||
Observation | FLANRATCCU | OBSERVACAO | ||
| ||||
Observation | FLAN | OBSERVACAO | SE2 | E2_HIST |
Origin | FLAN | CODSISTEMA | SE2 | E2_ORIGEM |
FinancialNatureInternalId | FLAN | CODCOLNATFINANCEIRA| CODNATFINANCEIRA | SE2 | M0_CODIGO | ED_FILIAL | E2_NATUREZ |
BankCode | FLAN | NUMBANCO | SE2 | E2_FORBCO |
BankBranch | FLAN | NUMAGENCIA | SE2 | E2_FORAGE |
BranchKey | SE2 | E2_FAGEDV | ||
CheckingAccountNumber | FLAN | NUMCONTA | SE2 | E2_FORCTA |
CheckingAccountNumberKey | SE2 | E2_FCTADV |
Os lançamentos de contas a pagar são gerados através do processo Protheus – Lançamentos a Pagar. Este processo irá baixar os lançamentos no TOTVS-RM e gerar o lançamento de contas a pagar no Protheus. A mensagem para criação é a mesma para cancelamento do registro, diferenciando apenas o tipo do evento. Sendo que para registrar será utilizado o UPSERT e para cancelar os registros será utilizado o DELETE. |
A mensagem ACCOUNTPAYABLEDOCUMENT (Contas a Pagar), somente, está disponibilizada na integração a partir da release 12.1.9. |
Ativos Fixos (Patrimônio)
Identificador da Mensagem: Assets
Versão: 1.001
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio: Síncrono
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | IPatrimonio | CodColigada | SM0 | M0_CODIGO |
BranchId | IPatrimonio | CodFilial | SN1 | N1_FILIAL |
CompanyInternalId | SN1 | M0_CODIGO | N1_FILIAL | ||
Code | SN1 | N1_CBASE | ||
InternalId | SN1 | M0_CODIGO | N1_FILIAL | N1_CBASE | N1_ITEM | ||
PropertyCode | IPatrimonio | CodPatrimonio | SN1 | N1_CBASE |
ItemNumber | IPatrimonio | CodPatrimonio | SN1 | N1_ITEM |
PurchaseDate | IPatrimonio | DataAquisicao | SN1 | N1_AQUISIC |
Description | IPatrimonio | Descricao | SN1 | N1_DESCRIC |
Amount | IPatrimonio | Quantidade | SN1 | N1_QUANTD |
CardAssets | IPatrimonio | Patrimonio | SN1 | N1_CHAPA |
StatusAssets | IPatrimonio | Ativo | SN1 | N1_STATUS |
VendorCode | IPatrimonio | CodFornecedor | SN1 | N1_FORNEC |
VendorInternalId | SN1 | M0_CODIGO | A2_FILIAL | N1_FORNEC | N1_LOJA | F | ||
ListOfSalesAndValuesAssets | - | - | ||
SalesAndValuesItem | - | - | ||
InternalId | SN3 | M0_CODIGO | N1_FILIAL | N1_CBASE | N1_ITEM | N3_TIPO | N3_BAIXA | N3_SEQ | ||
TypeAssets | SN3 | N3_TIPO | ||
TypeOccurrence | IPatrimonio | TipoOcorrencia | SN3 | N3_BAIXA |
Observation | IPatrimonio | Observacoes | SN3 | N3_HISTOR |
AssetAccount | SN3 | N3_CCONTAB | ||
CostCenterCode | IPatrimonio | CodCentroCusto | SN3 | N3_CUSTBEM |
CostCenterInternalId | SN3 | M0_CODIGO | CTT_FILIAL | N3_CUSTBEM | ||
DepreciationStartDate | SN3 | N3_DINDEPR | ||
CurrencyCode | - | 01 | ||
CurrencyInternalId | CTO | CTO_FILIAL | 01 | ||
OriginalValueCurrency | SN3 | N3_VORIG1 | ||
AnnualRateCurrencyDepreciation | SN3 | N3_TXDEPR1 | ||
MethodDepreciation | SN3 | N3_TPDEPR | ||
BalanceType | SN3 | N3_TPSALDO | ||
IsCalculated | - | Variável do sistema | ||
BalanceDepreciation | SN3 | N3_VRDACM1 |
Os ativos cadastrados no sistema Protheus são sincronizados com o TOTVS Gestão Patrimonial e disponibilizados para consultas.
As operações de inserção, alteração e exclusão devem ser realizadas no Protheus.
Os patrimônios cadastrados podem ser visualizados em: BackOffice / Gestão Patrimonial / Cadastros / Patrimônio
Com a instalação da integração, o TOTVS Gestão Patrimonial passa a utilizar o parâmetro interno NAOVALIDAMASCARA ativado. Sendo utilizado para que o sistema TOTVS Gestão Patrimonial ignore a máscara cadastrada em seus parâmetros e aceite o código enviado da Integração independente da forma cadastrada. Esse parâmetro é definido por Coligada, por isso, caso haja a ativação de outras coligadas após a instalação, esse parâmetro deve ser inserido na IPARAMETROS manualmente.
Para cadastro do Patrimônio é exigida, pelo sistema, a informação de um Grupo de Patrimônio, porém não é fornecido pelo XML da mensagem de integração. É utilizado um parâmetro de integração para a definição de um grupo padrão, por coligada, para o cadastro desses Patrimônios.
Os parâmetros de integração são incluídos juntamente com a instalação da integração. O parâmetro IDGRUPOPATRIMONIO deve ser configurado com o ID do grupo padrão para a coligada referente. Caso hajam ativações de coligadas após a instalação da integração, deve ser incluído o novo parâmetro para a nova coligada com o id do grupo referente, manualmente.
O processo de baixa e transferência do ativo, realizada no Sistema Protheus, não está contemplada nesta integração, necessitando o ajuste manual no Sistema TOTVS Gestão Patrimonial.
Como não são trabalhados os cenários de desvalorização do ativo, as informações de observação, centro de custo e tipo de ocorrência são consideradas apenas quando a tag TypeAssets contiver o valor 01 (Aquisição).
A mensagem ASSETS (Ativo Fixo), somente é disponibilizada na integração a partir da release 12.1.9. |
CONFIGURAÇÃO DE PARÂMETROS
TOTVS Gestão Patrimonial
Os parâmetros abaixo não podem ser utilizados quando houver integração com o BackOffice Protheus, estes devem estar desmarcados:
Parâmetros da integração TOTVS Educacional x BackOffice Protheus
Parâmetro "IDGRUPOPATRIMONIO" com o ID do grupo de patrimônio que será utilizado para cadastrar os Patrimônios.
O código do patrimônio é montado utilizando a junção das informações do código e do número do item enviados pelas tags: PropertyCode e ItemNumber, com um caracter de '.' no meio. Exemplo: <PropertyCode>NFE0000001</PropertyCode> <ItemNumber>0001</ItemNumber> Código do patrimônio: NFE0000001.001 |
O patrimônio no TOTVS Gestão Patrimonial é cadastrado por coligada e o código precisa ter um valor único. Dessa maneira, não é possível cadastrar dois patrimônios, mesmo em filiais diferentes, com o mesmo código dentro da mesma empresa. |
Baixa de lançamento (títulos a receber)
Tipo de Fluxo:
Mensagem: AccountReceivableDocumentDischarge
Versão: 2.007
Mensagem Padrão | RM | Protheus | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | FLAN | CODCOLIGADA | - | Variável do Sistema |
BranchId | FLAN | CODFILIAL | - | Variável do Sistema |
DocumentPrefix | FLAN | SERIE | SE1 | E1_PREFIXO |
DocumentNumber | FLAN | NUMERODOCUMENTO | SE1 | E1_NUM |
DocumentParcel | FLAN | PARCELA | SE1 | E1_PARCELA |
DocumentTypeCode | FLAN | CODTDO | SE1 | E1_TIPO |
PaymentDate | FLAN | DATABAIXA | SE1 | E1_BAIXA |
CreditDate | ||||
EntryDate | ||||
PaymentValue | FLANBAIXA | VALORBAIXA | SE5 | E5_VALOR |
OtherValues | ||||
CurrencyCode | SE5 | E5_MOEDA | ||
CurrencyRate | SE5 | E5_TXMOED | ||
CustomerCode | SE5 | E5_CLIFOR | ||
StoreId | SE5 | E5_HISTOR | ||
PaymentMethod | FLANBAIXA | IDFORMAPAGTO | SE5 | E5_MOTBX |
PaymentMeans | - | - | ||
HolderCode | SE5 | E5_BANCO | E5_AGENCIA | E5_CONTA | ||
HolderType | - | - | ||
FinancialCode | - | - | ||
HistoryText | SE5 | E5_HISTOR | ||
ListOfCreditDocument | - | - | ||
ListOfCreditDocument | - | - | ||
DiscargeSequence | SE5 | E5_SEQ | ||
| ||||
ReturnContentType | ||||
| ||||
CompanyId | FLAN | CODCOLIGADA | - | Variável do Sistema |
BranchId | FLAN | CODFILIAL | - | Variável do Sistema |
DocumentPrefix | FLAN | SERIE | SE1 | E1_PREFIXO |
DocumentNumber | FLAN | NUMERODOCUMENTO | SE1 | E1_NUM |
DocumentParcel | FLAN | PARCELA | SE1 | E1_PARCELA |
DocumentTypeCode | FLAN | CODTDO | SE1 | E1_TIPO |
DischargeSequence | SE5 | E5_SEQ |
A mensagem de Baixa de títulos a receber pode ser utilizada nos seguintes sentidos:
TOTVS Educacional - BackOffice Protheus
Nos parâmetros do educacional, Módulo Educacional / Configurações / Parâmetros / 15.05 Integração / 15.05.03 Financeiro / Fin – Geral 1/3 / Baixar automaticamente lançamentos com valor líquido igua a zero, caso o sistema esteja parametrizado para baixar automaticamente lançamentos com valor líquido igual a zero, será enviada a mensagem com os dados do título para o BackOffice Protheus realizar a baixa do título.
BackOffice Protheus - TOTVS Gestão Financeira
Ao ser realizado uma baixa de título no BackOffice Protheus, é enviada uma mensagem ao TOTVS Gestão Financeira para que seja realizada a baixa do título, ficando assim o lançamento com o mesmo status em ambos sistemas.
Caso a baixa no Protheus ocorra via CNAB, a mensagem de baixa também será enviada para o educacional. Nesse caso, se houver desconto ou bolsa vinculados ao título a ser baixado, os mesmos deverão ser informados no arquivo de remessa para envio ao banco. Do contrário (por exemplo, se o título for enviado ao banco no valor líquido, sem informar os devidos descontos) os valores de descontos serão omitidos, e ao receber o pagamento via retorno bancário, o desconto não existirá, e o XML de baixa que será enviado ao educacional terá apenas o valor líquido da baixa, não baixando o título completamente.
Para a realização da baixa financeira no Totvs Gestão Financeira é necessário que exista um meio de pagamento com o código "1" cadastro no sistema. Como a baixa é realizada apenas para refletir a mesma situação dos lançamentos no Protheus é utilizado um meio de pagamento padrão, uma vez que essa informação não será importante para o Totvs Gestão Financeira. |
Não é possível realizar a baixa de lançamentos por meio do TOTVS Gestão Financeira. Todas as baixas são realizadas pelo BackOffice Protheus, com exceção da baixa automática do TOTVS Educacional. Quando houver aplicação de Desconto Condicional, pela mensagem UPDATECONTRACTPARCEL, o campo de desconto deve ser preenchido com o valor referente. |
Cancelamento de baixa de lançamento (Baixa de lançamentos a receber)
Tipo de Fluxo:
Mensagem: ReversalOfAccountReceivableDocumentDischarge
Versão: 2.000
Mensagem Padrão | RM | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | FLAN | CODCOLIGADA | - | Variável do Sistema |
BranchId | FLAN | CODFILIAL | - | Variável do Sistema |
DocumentPrefix | FLAN | SERIEDOCUMENTO | SE1 | E1_PREFIXO |
DocumentNumber | FLAN | NUMERODOCUMENTO | SE1 | E1_NUM |
DocumentParcel | FLAN | PARCELA | SE1 | E1_PARCELA |
DocumentTypeCode | FLAN | CODTDO | SE1 | E1_TIPO |
DischargeSequence | FLAN | CODBAIXA | SE5 | E5_SEQ |
ReturnContentType | ||||
DocumentNumber | FLAN | NUMERODOCUMENTO | SE1 | E1_NUM |
|
A mensagem “Cancelamento de baixa de lançamento” será utilizada para cancelamento de baixa de títulos a receber e essa operação, sempre será realizada no BackOffice Protheus e enviada para o TOTVS Gestão Financeira. |
O processo de cancelamento de baixa no TOTVS Gestão Financeira ficará bloqueado, caso a integração estiver ativa e o modelo de integração estiver parametrizado com o novo modelo (Mensageria). |
Tipo de Fluxo:
Mensagem: FinancingTrading
Versão: 1.002
Mensagem Padrão | RM | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | FACORDO | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | - | Variável do Sistema | ||
BranchId | - | Variável do Sistema | ||
TradingDate | FACORDO | DATA | - | DataBase do Sistema |
TradingId | - | Código gerado pela rotina | ||
HistoryText | FACORDO | OBSERVACAO | - | - |
ListOfDischarge | - | |||
ListOfNewDocuments | - | |||
| - | |||
ListOfDischarge | - | |||
AccountReceivableDocumentInternalId | FLAN | CODCOLIGADA | IDLAN | SE1 | E1_FILIAL | E1_PREFIXO | E1_NUM | E1_PARCELA | E1_TIPO |
PaymentValue | FLAN | VALORBAIXADO | SE5 | E5_VALOR |
CustomerCode | FLAN | CODCOLCFO | CODCFO | SE1 | E1_CLIENTE | E1_LOJA |
StoreId | SE1 | E1_LOJA | ||
FinancialCode | SE1 | E1_NATUREZ | ||
| ||||
ListOfNewDocuments | - | - | ||
InternalId | E1_FILIAL | E1_PREFIXO | E1_NUM | E1_PARCELA | E1_TIPO | |||
DocumentPrefix | FLAN | SERIE | SE1 | E1_PREFIX |
DocumentNumber | FLAN | DOCUMENTO | SE1 | E1_NUM |
DocumentParcel | FLAN | PARCELA | SE1 | E1_PARCELA |
DocumentTypeCode | FLAN | CODCOLIGADA | CODTDO | SE1 | E1_TIPO |
HolderCode | SE1 | E1_PORTADO | ||
HolderType | - | - | ||
AgencyNumber | SE1 | E1_AGEDEP | ||
AccountNumber | SE1 | E1_CONTA | ||
ContractNumber | FLAN | IDCONVENIO | SE1 | E1_CONTRAT |
IssueDate | FLAN | DATAEMISSAO | SE1 | E1_EMISSAO |
DiscountDate | - | - | ||
DiscountPercentage | SE1 | E1_DESCFIN | ||
InterestPercentage | SE1 | E1_PORCJUR | ||
AssessmentValue | SE1 | E1_VALJUR | ||
DueDate | SE1 | E1_VENCTO | ||
ExtendedDate | FLAN | DATAVENCIMENTO | - | - |
AccountingDate | - | - | ||
ChargeInterest | - | - | ||
CustomerCode | FLAN | CODCFO | SE1 | E1_CLIENTE |
CustomerInternalId | FLAN | CODCOLCFO|CODCFO | SE1 | E1_CLIENTE | E1_LOJA |
StoreId | SE1 | E1_LOJA | ||
CustomerBankCode | SE1 | E1_BCOCLI | ||
GrossValue | FLAN | VALORORIGINAL | SE1 | E1_VALOR |
InvoiceAmount | - | - | ||
CurrencyCode | FLAN | CODMOEDAVALORORIGINAL | SE1 | E1_MOEDA |
CurrencyInternalId | - | - | ||
CurrencyRate | SE1 | E1_TXMOEDA | ||
Taxes | - | - | ||
ApportionmentDistribution | - | - | ||
Observation | - | - | ||
Origin | SE1 | E1_ORIGEM | ||
FinancialNatureInternalId | SE1 | E1_NATUREZ | ||
ReturnContentType | ||||
ListOfOurNumber - ReturnItem - OriginInternalId | E1_FILIAL | E1_PREFIXO | E1_NUM | E1_PARCELA | E1_TIPO | |||
ListOfOurNumber - ReturnItem - DestinationInternalId | FLAN | CODCOLIGADA | IDLAN | - | - |
ListOfOurNumber - ReturnItem - OurNumber | FBOLETO | NOSSONUMERO | SE1 | E1_NUMBCO |
ListOfOurNumber - ReturnItem - Barcode | FBOLETO | CODIGOBARRA | - | - |
ListOfInternalId - InternalId - Name | FIXO - FinancingTradingInternalId ou AccountReceivableDocumentInternalId | |||
ListOfInternalId - InternalId - Origin | FLAN / FACORDO | Para: AccountReceivableDocumentInternalId CODCOLIGADA | IDLAN Para:AccountReceivableDocumentInternalId CODCOLIGADA | IDACORDO | ||
ListOfInternalId - InternalId - Destination | Para: AccountReceivableDocumentInternalId E1_FILIAL | E1_PREFIXO | E1_NUM | E1_PARCELA | E1_TIPO Para:AccountReceivableDocumentInternalId Código gerado pela rotina (código da liquidação) |
A criação de um acordo no TOTVS Gestão Financeira, depende de um Template previamente cadastrado. Foi criado um parâmetro de integração que irá conter o código do template criado para os acordos gerados pela Integração.
Acesse: Integração / Integração / Mensagem Única / Integrações / Anexo Parâmetros de integração
Parâmetro: IDTEMPLATEACORDO
Esse parâmetro é cadastrado para a coligada global, mesmo que os templates sejam cadastrados por coligada. Como o contrato e a aprovação são gerados pelo Protheus, existe apenas um template para geração de acordo.
O mesmo template deve ser cadastrado para todas as coligadas com o mesmo código.
O Template cadastro não deve ter restrições e deve ser parametrizado para efetivação.
Caminhos para a acesso ao Template e aos acordos:
Acesse: BackOffice / Gestão Financeira / Conta a Pagar / Receber / Acordo
Tipo de Fluxo: Protheus -> RM
Mensagem: ReversalOfFinancialTranding
Versão: 1.000
Mensagem Padrão | RM | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | FACORTO | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | - | Variável do Sistema | ||
BranchId | - | Variável do Sistema | ||
ReversalDate | FACORDO | DATACANCELAMENTO | - | DataBase do Sistema |
TradingId | FACORDO | CODCOLIGADA | IDACORDO | - | Código gerado pela rotina |
| ||||
ReturnContentType | ||||
ListOfInternalId | FLAN | CODCOLIGADA | IDLAN | - | - |
O cancelamento do acordo somente é realizado caso exista um registro De-Para criado para o acordo. A operação de cancelamento é realizada somente pelo Protheus, sendo desabilitado o cancelamento pelo TOTVS Gestão Financeira |
Tipo de Fluxo:
Mensagem: OurNumberBanking
Versão: 1.000
Mensagem Padrão | RM | PROTHEUS | ||
Tabela | Campo | Tabela | Campo | |
CompanyId | FLAN | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | - | Variável do Sistema | ||
BranchId | - | Variável do Sistema | ||
DocumentInternalId | SE1 | E1_FILIAL | E1_PREFIXO | E1_NUM | E1_PARCELA | E1_TIPO | ||
DueDate | FLAN | DATAVENCIMENTO | SE1 | E1_VENCREA |
BankingCode | SE1 | E1_PORTADO | ||
Agency | SE1 | E1_AGEDEP | ||
Account | SE1 | E1_CONTA | ||
Contract | FLAN | IDCONVENIO | SE1 | E1_CONTRAT |
ReturnContentType | ||||
DocumentInternalId | FLAN | CODCOLIGADA | IDLAN | SE1 | E1_FILIAL | E1_PREFIXO | E1_NUM | E1_PARCELA | E1_TIPO |
OurNumber | FBOLETO | NOSSONUMERO | SE1 | E1_NUMBCO |
Barcode | FBOLETO | CODIGOBARRA | SE1 | E1_CODBAR |
Para utilização da requisição do Nosso Número, o banco utilizado deve ser cadastrado antes dessa requisição, por meio da mensagem Bank. |
Tipo de Fluxo:
Mensagem: UpdateContractParcel
Versão: 1.002
Mensagem Padrão | RM | Protheus | ||
---|---|---|---|---|
Tabela | Campo | Tabela | Campo | |
CompanyInternalId | FLAN | CODCOLIGADA| CODFILIAL | ------- | Variável do sistema |
BranchId | FLAN | CODFILIAL | - | Variável do sistema |
AccountDocument | FLAN | CODCOLIGADA| IDLAN | SE1 | E1_FILIAL | E1_PREFIXO | E1_NUM | E1_PARCELA | E1_TIPO |
Date | DATA DE BAIXA | - | DataBase do Sistema | |
ReturnContentType | ||||
AccountDocument | FLAN | CODCOLIGADA| IDLAN | SE1 | E1_FILIAL | E1_PREFIXO | E1_NUM | E1_PARCELA | E1_TIPO |
DiscountValue | VALOR DO DESCONTO CONDICIONAL | SE1 | E1_DESCONT | |
SholarshipValue | VALOR DE BOLSA | SE1 | E1_VLBOLSA | |
Observation | OBSERVACAO | - | Campo livre |
Algumas situações de erro e/ou validações podem ocorrer durante o processamento de mensagens da integração. Nas duas situações, as mensagens que foram processadas podem ser verificadas no módulo Integração, no menu Integração / Mensagem Única / Fila de mensagens únicas.
Ao abrir o cadastro de Fila de mensagem, podemos perceber a fila de mensagem processada e no anexo Informação de execução de mensagem, temos as informações do processamento da mensagem.
Caso ocorra algum erro, ou validação durante uma integração que utilize uma mensagem síncrona, o texto do erro, ou validação é apresentada no momento da operação.
As integrações que utilizam mensagens assíncronas podem processar, ou agendar o processamento por meio da tela de Fila de mensagens, no menu Processos / Execução manual de mensagens únicas.
Casos de erros onde a mensagem informada refere-se ao WebService do EAI serão exibidas no campo "Mensagem de execução", carregada da mensagem de retorno da integração.
Mensagens de erro:
Deve-se ser verificado o código Febraban do banco utilizado, pois o mesmo pode não estar entre os bancos compatíveis para a geração do Nosso Número. Verificar a documentação em:
http://wikihelp.totvs.com.br/WikiHelp/FIN/FIN.NossoNumero.aspx
Itens para conferência no TOTVS Educacional | |
1º | Instalação da Biblioteca RM versão 11.83.55 ou superior. |
2º | Instalação do pacote TOTVS Business Connect e/ou configuração do Host para utilização do webservice do EAI. |
3º | Instalação da integração TOTVS Educacional x BackOffice Protheus. |
4º | Configuração do endereço do webservice do EAI do Protheus. |
5º | Integração TOTVS Educacional x BackOffice Protheus ativa. |
6º | Parametrização da integração com Protheus mensagem única (Novo) – TOTVS Educacional, Gestão Bibliotecária e Processo Seletivo. |
Itens para conferência no Protheus | |
1º | Configuração do endereço do webservice do TBC |
2º | Parametrizações da integração. |
3º | Inicializador padrão dos campos A1_LOJA e A2_LOJA |
4º | Equalização dos tamanhos dos campos chave das tabelas envolvidas na integração |
5º | Preencher o parâmetro MV_1DUP como “1” para que as parcelas sejam geradas em sequência numérica |
AccountReceivableDocumentInternalId