O objetivo deste manual é descrever a integração entre o TOTVS Educacional com o BackOffice Protheus e suas formas de integração entre os seus processos e cadastrados. Atualmente temos três formas de integração entre os dois sistemas com a utilização do EAI – Enterprise Application Integration.

Essas formas são:

Sistemas Envolvidos

Integração

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 já existe uma integração entre os produtos, mas que é restrita a troca de algumas outras informações que são enviadas pelo Protheus. Feito a reestruturação e adequação com a criação desta nova integração para envio de informações do TOTVS Educacional para o 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 dos produtos são executados com o mesmo XML para uma mesma entidade, ou seja, caso um arquivo XML corresponda 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: 

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.

Pré-requisitos instalação/implantação/utilizaçã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). Os pré-requisitos instalação/implantação/utilização da integração pacote 1012 no EAI 1.0 clique aqui


Configurando WS do RM

Para informações da instalação do TBC, consulte os documentos de apoio abaixo: 


Instalação do Protheus V12 e configuração do AppServer e Dbaccess

Acesse os documentos de apoio abaixo para instalação e configuração.


Como configurar EAI do Protheus

Para a configuração do EAI acesso documento Configuração EAI Protheus 

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  

Adapters da Integração:

A seguir a listagem dos adapters da integração com a informação de envio e recebimento para cada sistema.

Rotina

Mensagem

Descrição


ProtheusRMCanal

Operação

Versão

Alias do Protheus

Envia

Recebe

EnviaRecebe
ATFA012ASSETSAtivo FixoSim Não NãoSimEAITodas 1.001SN1 
CTBA010ACCOUNTINGCALENDARCalendário ContábilSim Não NãoSimEAITodas1.000CTG 
CTBA020ACCOUNTANTACCOUNTPlano de ContaSim Não NãoSimEAITodas2.000CT1
CTBA030COSTCENTERCentro de CustoSim Não NãoSimEAITodas2.000CTT 
CTBA040ACCOUNTINGITEMItem ContábilSim Não NãoSimEAITodas1.000CTD
CTBA060CLASSVALUEClasse de ValorSim Não NãoSimEAITodas1.000CTH
CTBA102ACCOUNTINGENTRYLançamento ContábilNãoSimSimSimEAITodas2.000CT2
CTBA140CURRENCYMoeda SimNão NãoSimEAITodas2.001CTO
FINA010FINANCIALNATURENatureza FinanceiraSimNãoNãoSimEAITodas2.000SED
FINA040ACCOUNTRECEIVABLEDOCUMENTLançamento a receberNãoSimSimNãoEAITodas2.002SE1
FINA050ACCOUNTPAYABLEDOCUMENTLançamento a pagar NãoSim SimNãoEAITodas 2.001SE2 
FINA130BANKBancoSimNãoNãoSimEAITodas2.001SA6
FINA280FINANCINGTRADINGNegociação lançamento a receberNãoSimSimNãoEAIAtualização1.002-
FINA280REVERSALOFFINANCINGTRADING                       Cancelamento negociação lançamento a receberNãoSimSimNãoEAIExclusão1.000-
FINA460FINANCINGTRADINGNegociação lançamento a receberNãoSimSimNãoEAIAtualização1.002-
FINA460REVERSALOFFINANCINGTRADING                    Cancelamento negociação lançamento a receberNãoSimSimNãoEAIExclusão1.000-
INTXATU01INTERNALIDLOADSincronização DE - PARANãoSimSimNãoEAITodas1.000-
MATA010ITEMProdutoSimNãoNãoSimEAITodas3.007SB1
MATA020CUSTOMERVENDORCliente ou FornecedorSimSimSimSimEAITodas2.002SA2
MATA030CUSTOMERVENDORCliente ou FornecedorSimSimSimSimEAITodas2.002SA1
MATA035STOCKGROUPGrupo de ProdutoSimNãoNãoSimEAITodas1.000SBM
MATA070BANKBancoSimNãoNãoSimEAITodas2.001SA6
QIEA030UNITOFMEASUREUnidade de medidaSimNãoNãoSimEAITodas2.000SAH
FINI070LSTLISTOFACCOUNTRECEIVABLESETTLEMENTSBaixa a receberNãoSimSimNãoEAITodas1.000-
FINI035LSTLISTOFCOMPLEMENTARYVALUEValores AcessóriosNãoSimSimNãoEAITodas1.000-

Tabelas De-Para

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 sistemas que estão trocando informações. Considerando as mensagens envolvidas nessas integrações, seguem as informações presentes no de-para e as observações devidas em cada uma.

Integração EAI 2.0Observação
AplicativoNome do aplicativo responsável pela integração entre os dois sistemas
Tabela RMTabela de origem no RM onde os dados são enviados ou recebidos
Campos RMCampos da tabela que são utilizados na montagem da chave interna no sistema RM
Valor RMValores dos campos da tabela que são utilizados na montagem da chave interna no sistema RM.
Valores ExternosValores dos campos da tabela do sistema que está sendo integrado com o sistema RM
TransaçãoNome na mensagem - adapter responsável por gerar e gerenciar o de-para
Identificador GlobalIdentificador enviado na mensagem - adapter como chave de integração no de-para entre o sistema RM e o sistema de destino. Caso esse identificador estiver vazio, a integração envia o valor presente no campo "Valor RM".

Seguir a descrição de cada adapters da integração e sua responsabilidade

No cadastro de coligada do RM deve ser configurado o campo Código Externo com o mesmo código do Grupo de Empresa do Protheus.

Assim, se tiver algum cadastro do RM relacionado a integração com o Protheus que não permite cadastro global, ao receber a mensagem de integração o RM irá realizar a replicação dos dados para todas as coligadas com código externo preenchido.

A replicação será conforme o tipo de compartilhamento configurado no Protheus, como por exemplo compartilhado compartilhado por empresa.

Os cadastros do cliente e do fornecedor podem ser realizados no RM no TOTVS Gestão Financeira e no BackOffice Protheus.

O cadastro de cliente/fornecedor é utilizado por ambos os lados e podem ser realizados no BackOffice Protheus ou no TOTVS Gestão Financeira. 

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Configurar Protheus para uso do cadastro de Cliente / Fornecedor no Módulo "SIGACFG".

Base de dados | Dicionário | Bases de Dados

Grupo de Campos = Alterar o tamanho 

Dicionário de Dados deve localizar as Tabelas "SA1 e SA2"

Editar ambas as Tabelas 

Localizar o campo "A1_LOJA" = Editar

Aba "Opções" deve preencher o Inicializador Padrão  = “01”

(A1_COD) = Editar

Se o Inicializador Padrão estiver preenchido deve ser deletado a informação para ficar em branco, como mostra a segunda print abaixo.

Inicializador Padrão preenchido

Inicializador Padrão em branco

Verificando cadastro do Cliente / Fornecedor no Protheus no Módulo "SIGAFIN"

Atualizações | Cadastros | Clientes 

Cliente enviado para Protheus

Na integração EAI 2.0 no cadastro do cliente/fornecedor do TOTVS Gestão Financeira tem três campos novos que são:

  • Código da Loja: Campo correspondente ao código da loja presente no BackOffice Protheus. Desta forma, para o preenchimento desse campo teve a criação do parâmetro de integração CODLOJADEFAULT, por padrão terá o valor "01" conforme o campo "LOJA" presente nas tabelas SA1 e SA2, e descrito na aba Protheus
  • Código Externo: Campo correspondente ao código do cliente ou do fornecedor cadastrado no BackOffice Protheus. Deve informar preferencialmente o próximo código correspondente ao código no Protheus
  • Código da Filial de Integração: Campo responsável por armazenar a filial de integração do cliente/fornecedor quando o cadastro do cliente ou do fornecedor do BackOffice Protheus tem compartilhamento exclusivo por filial.

A geração do código do cliente/fornecedor na integração EAI 2.0 é gerado de duas formas, que são:

  • Utilização do parâmetro “Usar código sequencial (se máscara for numérica) ”:  O TOTVS Gestão Financeira irá gerar o código automaticamente de acordo com a parametrização.
  • Sem a utilização do parâmetro “Usar código sequencial (se máscara for numérica) ”: O código do cliente/fornecedor será criado automaticamente pelo TOTVS Gestão Financeira. O usuário deverá informar somente o código externo do cadastro. A criação do código do cliente/fornecedor será no seguinte formato separado por ponto e vírgula:
    • Código da loja + ; + C para cliente ou F para fornecedor + ; + Código Externo + ; + Código Filial Integração.

Vale ressaltar que a recomendação é a opção: Sem a utilização do parâmetro “Usar código sequencial (se máscara for numérica) ”


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.

A definição da 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 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.

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

E acesse também o Módulo TOTVS Educacional / Configurações/ Parâmetros / 15.02 - Tesouraria / Geral 1/2 / Responsável Financeiro / Máscara do código de Cliente/Fornecedor.


Cenário em que o Protheus tiver um compartilhamento por Empresa, o TOTVS Gestão Financeira deve ser parametrizado para utilizar clientes globais. Para isso 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 / Default Cli/For Globais

Cadastro do Cliente Fornecedor do RM no TOTVS Gestão Financeira 

Cliente / Fornecedor cadastrado no RM

Acesse Integrações opção "Integração Protheus" para vincular um fornecedor para no cadastro do cliente para geração de lançamento a pagar. Esse campo só ficará visível somente para o cadastro de cliente.


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 / EAI 2.0 / Parâmetros adapter


Todas as movimentações da mensagem CUSTOMERVENDOR tanto no seu envio quanto para o seu recebimento, resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações. Desta forma, o sistema de origem envia seu código de identificação do cliente/fornecedor para o sistema de destino juntamente com seu  código de identificação. 

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

FCFO

CODCOLIGADA|CODCFO

0|000000001

01||000000001|01|C

CUSTOMERVENDOR

B96F1F8B-CAD3-484B-9903-1FB2BE635888
TOTVS Educacional x BackOffice Protheus

FCFO

CODCOLIGADA|CODCFO

0|000000110

01||000000110|01|F

CUSTOMERVENDOR


A restrição da mensagem está relacionada ao tipo de compartilhamento das tabelas SA1 e SA2 no Protheus, para mais informações clique aqui

A configuração para cliente/fornecedor global é realizada somente caso o Protheus tenha um compartilhamento por Empresa.


A recomendação na integração EAI 2.0 é utilizar o modo de compartilhamento exclusivo por empresa e o modo de compartilhamento compartilhado por filial no Protheus. O motivo dessa recomendação é porque atualmente no cadastro de cliente/fornecedor no TOTVS Gestão Financeira não tem a possibilidade de incluir o cliente ou o fornecedor por filial. Vale ressaltar que o campo "Código da Filial de Integração" somente informa a filial do cliente ou do fornecedor no Protheus quando o compartilhamento é exclusivo por filial.

A mensagem de Banco é utilizada para realizar o cadastro de Bancos, Agências, Contas Correntes, Conta Caixas e Convênios.

O cadastro do banco é realizado no BackOffice Protheus e em seguida, o cadastro é replicado para o TOTVS Gestão Financeira, através desta integração. Como o cadastro é realizado no Protheus, os cadastros do TOTVS Gestão Financeira são desabilitados para inclusão e exclusão, caso a integração esteja ativa.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Configurar Protheus para cadastro do banco no Módulo SIGACFG

( Ambiente | Empresa | Filial ). É necessário para que o cadastro de convênio no TOTVS Gestão financeira possa ser criado.

Cadastro de banco no Módulo "SIGAFIN"

Atualizações | Cadastros | Bancos 


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. 

Cadastro Bancário no Protheus

      • Código Bancário
      • Número da Agência
      • Número da Conta
      • Número do Banco
      • Código Cedente 

Cadastro do Contrato Bancário e Parâmetro Bancário no BackOffice Protheus = Convênio no RM

Atualizações | Cadastros | Contrato Bancário

Informar o Número do Contrato bancário (Será utilizado no cadastro do Parâmetro Bancário)

Atualizações | Cadastros | Parâmetros de Bancos

Na Aba "Cadastrais" informar :

      • Banco
      • Agência
      • Conta
      • Sub Conta 

Na Aba "Outros"

      • Contrato (Informar o número do contrato criado no Contrato Bancário)


Banco | Agencia | Conta Corrente enviado para o RM (Gestão Financeira)

Movimentações Bancárias | Bancos e Agências


TOTVS Gestão Financeira 

Movimentações Bancárias | Controle Bancário | Contas / Caixa

Conta Caixa enviada para o Gestão Financeira

Movimentações Bancárias | Convênio

Convênio enviado para o Gestão Financeiro


Todas as movimentações da mensagem BANK resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações. 

Mensagem Bank (Banco/Agência/Conta Corrente/Conta Caixa/Convênio)

Banco / Agência / Conta Corrente

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

FCONTA

CODCOLIGADA|NUMBANCO|NUMAGENCIA|NROCONTA

1|104|1041|1234

T1||104|1041|1234

BANK

84043D1C-707C-4F5A-A961-48CDCBBE0267
TOTVS Educacional x BackOffice Protheus

FCONTA

CODCOLIGADA|NUMBANCO|NUMAGENCIA|NROCONTA

1|341|9598|01214

T1||341|9598|01214

BANK

1A46E902-3D5F-41B1-A1F6-8375CA82B28E


Conta Caixa

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

FCXA

CODCOLIGADA|CODCXA

1|2

T1|D MG 01|318|0001|00001

BANK

84043D1C-707C-4F5A-A961-48CDCBBE0100
TOTVS Educacional x BackOffice Protheus

FCXA

CODCOLIGADA|CODCXA

1|3

T1|D MG 01|033|3477|01087756

BANK



Convênio

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

FCONVENIO

CODCOLIGADA|IDCONVENIO

1|2

T1|D MG 01 |1

BANK

84043D1C-707C-4F5A-A961-48CDCBBE0101
TOTVS Educacional x BackOffice Protheus

FCONVENIO

CODCOLIGADA|IDCONVENIO

1|3

T1|D MG |2

BANK


A restrição da mensagem está relacionada ao tipo de compartilhamento da tabela SA6 no Protheus, para mais informações clique aqui

A recomendação na integração EAI 2.0 é utilizar o modo de compartilhamento exclusivo por empresa e o modo de compartilhamento compartilhado por filial no Protheus. O motivo dessa recomendação é porque atualmente no cadastro de Banco no TOTVS Gestão Financeira não tem a possibilidade de incluir o banco por filial. 

O cadastro da moeda é realizado no BackOffice Protheus e em seguida, o cadastro é replicado para o TOTVS Gestão Financeira, através desta integração.

Como o cadastro é realizado no Protheus, os cadastros do TOTVS Gestão Financeira são desabilitados para inclusão e exclusão, caso a integração esteja ativa.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Configurar Protheus para cadastro do banco no Módulo (SIGACTB) 

Atualizações | Cadastros | Moedas Contábeis

Cadastro de Moeda Realizado no Protheus


Caminho para acesso ao cadastro do Moeda, no sistema:

Acesse BackOffice / Gestão Financeira / Movimentações Bancárias / Moedas e Índices

Todas as movimentações da mensagem CURRENCY resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações. 

Moeda

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

GMOEDA

SIMBOLO

R$

T1|D MG 01|01

CURRENCY

84043D1C-707C-4F5A-A961-48CDCBBE0102
TOTVS Educacional x BackOffice Protheus

GMOEDA

SIMBOLO

USD

T1|D MG 01|19

CURRENCY


A restrição da mensagem está relacionada ao tipo de compartilhamento da tabela CTO, para mais informações clique aqui

A recomendação na integração EAI 2.0 é utilizar o modo de compartilhamento exclusivo por empresa e o modo de compartilhamento compartilhado por filial no Protheus. O motivo dessa recomendação é porque atualmente no cadastro de Moeda no TOTVS Gestão Financeira não tem a possibilidade de incluir a moeda por filial. 

O cadastro dos valores acessórios é realizado no TOTVS Gestão Financeira, através da parametrização dos valores opcionais, e em seguida, o cadastro é replicado para o BackOffice Protheus, através desta integração.

Ao inserir um valor opcional no RM, criando um "Tipo de valor acessório" no Protheus, não será possível alterar a ação do valor opcional, e nem excluir o registro no Protheus. O sistema permite somente que o "Tipo de valor acessório" seja desativado. Ressaltamos que o sistema cria o "Tipo de valor acessório" somente se a ação definida no RM for igual a Somar ou Diminuir. Outras ações não terão a mensagem de integração disparada. 

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Verificação dos valores acessórios enviados para o Protheus no Módulo "SIGAFIN"

Atualizações | Cadastros | Tipos de Valores Acessórios 

Valores acessórios preenchidos com os Valores Opcionais enviados pelo TOTVS Gestão Financeira

Após efetuar a parametrização dos Campos opcionais e Valores acessórios , gerar o Título para o BackOffice Protheus

Módulo "SIGAFIN"

Atualizações | Contas a Receber | Contas a Receber

Título enviado para o Protheus

Verificar Valores Acessórios, selecionar a Parcela e em Outras Ações | Valores Acessórios

Valores Acessórios 

Configurar TOTVS Gestão financeira para cadastro de valores acessórios

BackOffice | Gestão Financeira

Ambiente | Parâmetros | TOTVS Gestão Financeira

02.02 – Contas a Receber

Valores Opcionais cadastrados no TOTVS Gestão Financeira

Todas as movimentações da mensagem LISTOFCOMPLEMENTARYVALUE resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações.

Mensagem LISTOFCOMPLEMENTARYVALUE (Valores Complementares do Contas a Receber)

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

FPARAM

CODCOLIGADA|CODIGO

1|VALOROP4

T1|D MG 01|000007

COMPLEMENTARYVALUE

84043D1C-707C-4F5A-A961-48CDCBBE0104
TOTVS Educacional x BackOffice Protheus

FPARAM

CODCOLIGADA|CODIGO

1|VALOROP5

T1|D MG 01|000008

COMPLEMENTARYVALUE


Os valores acessórios enviados para serem cadastrados no BackOffice Protheus são os valore opcionais parametrizados no TOTVS Gestão Financeira. 


A mensagem FINANCIALNATURE é responsável por receber os dados de natureza orçamentária financeira entre a integração TOTVS Educacional com BackOffice Protheus. 

Os cadastros de natureza orçamentária financeira devem ser realizados no BackOffice Protheus, serão desabilitadas quaisquer alterações a serem feitas no cadastro de natureza orçamentária financeira do lado do RM.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Cadastros Natureza Financeira - Protheus

Módulo "SIGAFIN" 

Atualizações | Cadastros | Naturezas

Natureza Cadastrada no BackOffice Protheus 


A geração do código da natureza orçamentária financeira na integração EAI 2.0 é gerado utilizando o parâmetro NATUREZAFINANCEIRAAUTOINC

Caminho para acesso ao cadastro de naturezas no sistema: 

Acesse: BackOffice / Gestão de Estoque, Compras e Faturamento / Orçamento / Tabelas de Orçamento / Natureza Orçamentária Financeira

                                              

Orçamento | Tabelas de Orçamento | Natureza Orçamentária Financeira


TOTVS Educacional - Financeiro / Contábil | Serviços

Vincular a Natureza Financeira cadastrada no BackOffice Protheus ao Serviço do TOTVS Educacional

Selecionar o Serviço desejado (Editar) Anexos | Dados financeiros – Integração Protheus 

Vinculado ao Serviço do TOTVS Educacional a Natureza Financeira cadastrada no BackOffice Protheus.


Na geração do lançamento financeiro pela parcela do contrato a natureza financeira é buscada primeiro no anexo "Dados financeiros - Integração Protheus" e caso não tiver busca a natureza cadastrada no serviço no campo "Código da Natureza Financeira".

Na geração do acordo do lançamento financeiro a natureza financeira é buscada primeiro no anexo "Dados financeiros - Integração Protheus" e caso não tiver busca a natureza cadastrada no serviço no campo "Código da Natureza Financeira", e por último no rateio por centro de custo.

Todas as movimentações da mensagem FINANCIALNATURE resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações. 

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

TOTVS Educacional x BackOffice Protheus

TTBORCAMENTO

CODCOLIGADA|CODTBORCAMENTO

1|1

T1|D MG 01 |1

FINANCIALNATURE

A restrição da mensagem está relacionada ao tipo de compartilhamento das tabelas SED no Protheus, para mais informações clique aqui

A recomendação na integração EAI 2.0 é utilizar o modo de compartilhamento exclusivo por empresa e o modo de compartilhamento compartilhado por filial no Protheus. O motivo dessa recomendação é porque atualmente no cadastro de Natureza Orçamentaria Financeira no TOTVS Gestão de Estoque, Compras e Faturamento não tem a possibilidade de ser incluída por filial. Já para a utilização de natureza Global no RM é realizada quando no BackOffice Protheus o tipo de compartilhamento for compartilhado por Empresa.

Quando no RM está cadastrado a coligada em Integração / EAI 2.0 / Aplicativos como:

  • Unidade de Negócio: não é permitido no Protheus o modo de compartilhamento "compartilhado" de Filial e Unidade de Negócio
  • Empresa: não é permitido no Protheus o modo de compartilhamento "compartilhado" somente de Filial
  • Grupo de Empresa: não é permitido no Protheus o "compartilhamento" compartilhado somente de Filial ou Filial e Unidade de Negócio
  • Nas coligada acima: não é permitido que a Filial, Unidade de Negocio e Empresa esteja cadastrado no modo de compartilhamento "exclusivo" no Protheus.

Vale ressaltar que ao marcar para Permitir Globais em: Módulo Gestão de Estoque / Ambiente / Parâmetros / Gestão Estoque, Compras e Faturamento / 04.01 – Parâmetros Gerais / 04.01.04 – Tabelas / 04.01.04.10 – Natureza Orçamentária Financeira, mesmo o Protheus sendo configurado como compartilhamento exclusivo por empresa, será cadastrado a natureza como global no RM. Quando o modo de compartilhamento for compartilhado por empresa e o parâmetro para Permitir Globais estiver desmarcado o RM irá replicar o cadastro para cada coligada.

A mensagem de ACCOUNTINGITEM é utilizada para realizar o cadastro dos itens contábeis no TOTVS Educacional para que a integração entre o TOTVS Gestão Contábil e o Backoffice Protheus possa ocorrer.

Os cadastros de item contábil devem ser realizados no BackOffice Protheus, serão desabilitadas quaisquer alterações a serem feitas no cadastro de unidade de medida do lado do RM.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Cadastros Item Contábil - Protheus.

Módulo "SIGACTB"


Atualizações | Entidades | Item Conta


Item Contábil cadastrado


Verificando no TOTVS Educacional cadastro dos Itens Contábeis enviado para o RM

Item Contábil cadastrada no TOTVS Educacional

Item Contábil é vinculado ao cadastro da Matriz Aplicada .

Matriz Aplicada | < Anexos > | Dados Financeiros – Integração Protheus 

Ao gerar Contabilização por Competência, o evento contábil é parametrizado para buscar a informação de Item Contábil da Matriz Aplicada.


Todas as movimentações da mensagem AccountingItem resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações.

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

SITEMCONTABILPROTHEUS

CODCOLIGADA|IDITEMCONTABIL

1|1

T1|D MG 01 |1

ACCOUNTINGITEM

84043D1C-707C-4F5A-A961-48CDCBBE0107

A restrição da mensagem está relacionada ao tipo de compartilhamento das tabelas CTD no Protheus, para mais informações, clique aqui

Quando o RM está cadastrado a coligada em Integração / EAI 2.0 / Aplicativos como:

  • Unidade de Negócio: não é permitido no Protheus o modo compartilhamento "compartilhado" de Filial e Unidade de Negócio
  • Empresa: não é permitido no Protheus o modo compartilhamento "compartilhado" somente de Filial
  • Grupo de Empresa: não é permitido no Protheus o compartilhamento "compartilhado" somente de Filial ou Filial e Unidade de Negocio

Os itens contábeis enviados para o RM são cadastrados no TOTVS Educacional para que posam ser associados em matrizes aplicadas. 

A mensagem de ClassValue é utilizada para realizar o cadastro das classes de valor no TOTVS Educacional para que a integração entre o TOTVS Gestão Contábil e o BackOffice Protheus possa ocorrer.

O cadastro da classe deve ser realizado no BackOffice Protheus, serão desabilitadas quaisquer alterações a serem feitas no cadastro de unidade de medida do lado do RM.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Cadastro da classe de valor do Protheus

Módulo "SIGACTB"

Atualizações | Entidades | Classe de Valor


Classe de Valor cadastrada 


Verificação no TOTVS Educacional das classes de valor enviado para o RM



Classe de Valor cadastrada no TOTVS Educacional


Classe de valor é vinculada ao cadastro da Matriz Aplicada.

Matriz Aplicada | < Anexos > | Dados Financeiros – Integração Protheus 


Ao gerar Contabilização por Competência, o evento contábil é parametrizado para buscar a informação de Classe de valor da Matriz Aplicada.

Todas as movimentações da mensagem ClassValue resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações.

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

SCLASSEVALORPROTHEUS

CODCOLIGADA|IDCLASSEVALOR

1|1

T1|D MG 01 |1

CLASSVALUE

84043D1C-707C-4F5A-A961-48CDCBBE0107

A restrição da mensagem está relacionada ao tipo de compartilhamento da tabela CTH no Protheus, para mais informações, clique aqui

Quando o RM está cadastrado a coligada em Integração / EAI 2.0 / Aplicativos como:

  • Unidade de Negócio: não é permitido no Protheus o modo de compartilhamento "compartilhado" de Filial e Unidade de Negócio
  • Empresa: não é permitido no Protheus o modo de compartilhamento "compartilhado" somente de Filial
  • Grupo de Empresa: não é permitido no Protheus o modo de compartilhamento "compartilhado" somente de Filial ou Filial e Unidade de Negocio

As classes de valor enviados para o RM são cadastrados no TOTVS Educacional para que posam ser associados em matrizes aplicadas. 

A mensagem de ACCOUNTANTACCOUNT é utilizada para realizar o cadastro dos planos de contas no TOTVS Gestão Contábil para que a integração entre o TOTVS Gestão Contábil e o Backoffice Protheus possa ocorrer.

O cadastro do plano de contas deve ser realizado no BackOffice Protheus, serão desabilitadas quaisquer alterações a serem feitas no cadastro de unidade de medida do lado do RM.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Cadastrando Plano de Contas no Protheus

Módulo Contábil "SIGACTB"


Atualizações | Entidades | Plano de Contas


Plano de Contas cadastrada no Protheus


A máscara parametrizada da conta contábil no TOTVS Contabilidade Gerencial é validada no processo de inclusão da conta contábil. Portanto, o parâmetro de máscara contábil deve ser cadastrado de acordo com o formato do código da conta a ser enviado pelo Protheus. Caso o Protheus não envie máscara no código de conta, exemplo: 1011214, então o parâmetro Não utiliza máscara nas contas deve ser marcado, em cada coligada. Caso contrário, ocorrerá um erro no processo de inclusão da conta.

Caminho para acesso ao parâmetro para não utilizar máscara:                                              

Acesse: BackOffice / Contabilidade Gerencial / Ambiente / Parâmetros 

01.01 – Plano de Contas / 01.01.01 – Plano de Contas contábil / Plano de Contas Contábil / Não utilizar máscara nas contas

No TOTVS Contabilidade Gerencial deve ser parametrizado para utilizar contas globais por padrão.

Caminho para acesso ao parâmetro para utilizar conta global:                                            

Acesse: BackOffice / Contabilidade Gerencial / Ambiente / Parâmetros  

01.01 – Plano de Contas / 01.01.01 – Plano de Contas contábil / Plano Contas / Acessa conta globais                                                             

01.01 – Plano de Contas / 01.01.01 – Plano de Contas contábil / Plano Contas / Cadastrar como global por padrão

Verificando cadastro do Plano de Contas no RM.       

Acesse: BackOffice / Contabilidade Gerencial / Cadastros / Contábil

Plano de Contas enviado para RM.


Todas as movimentações da mensagem AccountAntAccount resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações.

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

CCONTA

CODCOLIGADA|CODCONTA

1|1

T1|D MG |1

ACCOUNTANTACCOUNT

84043D1C-707C-4F5A-A961-48CDCBBE0108

A restrição da mensagem está relacionada ao tipo de compartilhamento da tabela CT1 no Protheus, para mais informações, clique aqui

A recomendação na integração EAI 2.0 é utilizar o modo de compartilhamento exclusivo por empresa e o modo de compartilhamento compartilhado por filial no Protheus. O motivo dessa recomendação é porque atualmente no cadastro de Plano de contas no TOTVS Gestão Contábil não tem a possibilidade de incluir o plano de contas por filial. Já para a utilização de conta Global no RM é realizada quando no BackOffice Protheus o tipo de compartilhamento for compartilhado por Empresa.

Quando o RM está cadastrado a coligada em Integração / EAI 2.0 / Aplicativos como:

  • Unidade de Negócio: não é permitido no Protheus o modo de compartilhamento "compartilhado" de Filial e Unidade de Negócio
  • Empresa: não é permitido no Protheus o modo de compartilhamento "compartilhado" somente de Filial
  • Grupo de Empresa: não é permitido no Protheus o modo de compartilhamento "compartilhado" somente de Filial ou Filial e Unidade de Negócio

A mensagem COSTCENTER é responsável por receber os dados de centro de custo entre a integração TOTVS Educacional com BackOffice Protheus.

Os cadastros de centro de custo devem ser realizados no BackOffice Protheus, serão desabilitadas quaisquer alterações a serem feitas no cadastro de centro de custo do lado do RM.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Cadastros Centro de Custos - Protheus

Módulo "SIGACTB"

Atualizações | Entidades | Custos 

Centro de Custo Cadastrado no Protheus


Cadastros Centro de Custos - RM

Caminho para acesso ao cadastro do Centro de Custo, no sistema:

Acesse BackOffice / Gestão Contábil / Cadastro / Auxiliares / Centros de Custos


Todas as movimentações da mensagem CostCenter resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações.

Centro de Custo

Exemplo: 

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

GCCUSTO

CODCOLIGADA|CODCCUSTO

1|1

T1|D MG 01 |1

COSTCENTER

84043D1C-707C-4F5A-A961-48CDCBBE0110
TOTVS Educacional x BackOffice ProtheusGCCUSTOCODCOLIGADA|CODCCUSTO1|2T1|D MG 01 |2COSTCENTER

A restrição da mensagem está relacionada ao tipo de compartilhamento da tabela CTT no Protheus, para mais informações, clique aqui

A recomendação na integração EAI 2.0 é utilizar o modo de compartilhamento exclusivo por empresa e o modo de compartilhamento compartilhado por filial no Protheus. O motivo dessa recomendação é porque atualmente no cadastro de Centro de Custo no TOTVS Gestão Contábil não tem a possibilidade de incluir centro de custo por filial. 

Quando o RM está cadastrado a coligada em Integração / EAI 2.0 / Aplicativos como:

  • Unidade de Negócio: não é permitido no Protheus o modo de compartilhamento "compartilhado" de Filial e Unidade de Negócio
  • Empresa: não é permitido no Protheus o modo de compartilhamento "compartilhado" somente de Filial
  • Grupo de Empresa: não é permitido no Protheus o modo de compartilhamento "compartilhado" somente de Filial ou Filial e Unidade de Negocio

A mensagem ACCOUNTINGCALENDAR é responsável por enviar a informação de "Período contábil" do BackOffice Protheus com o TOTVS Educacional.

O cadastro de calendário contábil deve ser realizado no BackOffice Protheus, serão desabilitadas quaisquer alterações a serem feitas no Período Contábil do lado do RM.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Cadastros de calendário contábil - Protheus

Módulo "SIGACTB"

Atualizações | Cadastros | Calendário Contábil

Inserção do calendário no Protheus

Preencha o código e as datas







A mensagem UNITOFMEASURE é responsável por receber os dados de unidade de medida entre a integração BackOffice Protheus com o TOTVS Educacional.

Os cadastros de unidade de medida devem ser realizados no BackOffice Protheus, serão desabilitadas quaisquer alterações a serem feitas no cadastro de unidade de medida do lado do RM.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Cadastro de Unidade de Medida - Protheus

Módulo "SIGAEST"

Atualizações | Cadastros | Unidade de Medida

Unidade de Medida no Protheus

Cadastro de Unidade de Medida - RM

Acesse o módulo BackOffice | Gestão de Estoque, Compras e Faturamento 


Unidade de Medida no RM


Todas as movimentações da mensagem Unitofmeasure resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações.

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

TUND

CODUND

UN

T1|UN

UNITOFMEASURE

84043D1C-707C-4F5A-A961-48CDCBBE0111

A restrição da mensagem está relacionada ao tipo de compartilhamento das tabelas SAH no Protheus, para mais informações clique aqui

A recomendação na integração EAI 2.0 é utilizar o modo de compartilhamento da Filial, Unidade e Empresa parametrizado no modo “Compartilhado” no Protheus, pois no RM o cadastro de Unidade de Medida não possui vínculo com a Coligada/Filial.

A mensagem STOCKGROUP é responsável por receber os dados do grupo de produto entre a integração BackOffice Protheus com o TOTVS Educacional.

Os cadastros de grupo de produto devem ser realizados no BackOffice Protheus, serão desabilitadas quaisquer alterações a serem feitas no cadastro de grupo de produto do lado do RM.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Cadastro de Grupo de Produto - Protheus

Módulo "SIGAEST"

Atualizações | Cadastros | Grupos


Grupo de Produto no Protheus

Caminho para acesso a tabela de classificação, no sistema:

BackOffice / Gestão de Estoque, Compras e Faturamento / Cadastros / Tabelas de Classificação.


Grupo de produto no RM                         

As informações de grupo de produtos utilizam sempre a Tabela de Classificação 2 com o nome de Grupo de Produtos. 

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                                                   

Marque as opções Usar em Produto, Usar em Item de Movimento e Usar em Movimento.               


Todas as movimentações da mensagem StockGroup resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações.

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

TTB2

CODCOLIGADA|CODTB2FAT

1|0015

T1||0015

STOCKGROUP

004505C8-2789-457E-BBCA-20FDB97BA6ED

As restrições da mensagem está relacionada ao tipo de compartilhamento das tabelas SBM no Protheus, para mais informações clique aqui

Quando no RM está cadastrado a coligada em Integração / EAI 2.0 / Aplicativos como:

  • Unidade de Negócio: não é permitido no Protheus o modo de compartilhamento "compartilhado" de Filial e Unidade de Negócio
  • Empresa: não é permitido no Protheus o modo de compartilhamento "compartilhado" somente de Filial
  • Grupo de Empresa: não é permitido no Protheus o "compartilhamento" compartilhado somente de Filial ou Filial e Unidade de Negócio
  • Nas coligada acima: não é permitido que a Filial, Unidade de Negocio e Empresa esteja cadastrado no modo de compartilhamento "exclusivo" no Protheus.

A mensagem ITEM é responsável por receber e enviar os dados do produto entre a integração BackOffice Protheus com o TOTVS Educacional.

Os cadastros de produto devem ser realizados no BackOffice Protheus, as alterações a serem feitas no cadastro de grupo de produto do lado do RM.

Nas abas abaixo são descritas as configurações necessárias para a utilização da mensagem com as suas particularidades.

Cadastro de Grupo de Produto - Protheus

Módulo "SIGAEST"


Atualizações | Cadastros | Produto


Produto no Protheus

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.

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, 

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

Produto no RM


Caminho para a parametrização do produto para a integração com o Protheus:

Acesse: Educacional / Educacional / Financeiro/Contábil / Serviços 

Anexo: Dados financeiros - Integração Protheus


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

Importante: Essa configuração é realizada somente caso o Protheus tenha um compartilhamento por Empresa.


Todas as movimentações da mensagem Item resultam em um registro na tabela De-Para para relacionamento entre os códigos dos sistemas que estão trocando informações.

Exemplo:

Aplicativo

Tabela RM

Campos RM

Valor RM

Valores Externos

Transação

Identificador Global
TOTVS Educacional x BackOffice Protheus

TPRODUTO

CODCOLPRD|IDPRD

1|7

T1||001

ITEM

314D6308-1488-462D-805F-64A196BE1848

As restrições da mensagem está relacionada ao tipo de compartilhamento das tabelas SBM no Protheus, para mais informações clique aqui

Quando no RM está cadastrado a coligada em Integração / EAI 2.0 / Aplicativos como:

  • Unidade de Negócio: não é permitido no Protheus o modo de compartilhamento "compartilhado" de Filial e Unidade de Negócio
  • Empresa: não é permitido no Protheus o modo de compartilhamento "compartilhado" somente de Filial
  • Grupo de Empresa: não é permitido no Protheus o "compartilhamento" compartilhado somente de Filial ou Filial e Unidade de Negócio
  • Nas coligada acima: não é permitido que a Filial, Unidade de Negocio e Empresa esteja cadastrado no modo de compartilhamento "exclusivo" no Protheus.



Caso o RM estiver configurado para produto global, o cadastrado do “de/para” do produto no RM irá considerar a coligada corrente para a montagem do “de/para”. E na geração do lançamento financeiro da parcela do contrato onde o serviço foi vinculado ao produto. A integração irá enviar o produto conforme o “de/para” do produto durante o seu cadastro. Vale ressaltar quando o produto é global no RM, os seus dados são replicados para cada coligada configurada para a integração com o Protheus. Esse comportamento estar presente somente na versão do EAI 1.0.

Exemplo:

No Protheus temos o produto “Caixa Box” com código 19 da entidade 01. O valor da chave de integração é 01||19. No momento do cadastro do produto “Caixa Box” no Protheus, a integração cadastrar o “de/para” desse produto no RM na coligada 1 com o seu identificador 100. Assim o valor da primária no RM será 1|100.

O produto “Caixa Box” presente no sistema da RM é vinculado aos serviços “mensalidade” da coligada 1, e “mensalidade padrão” da coligada 9. Assim na geração do lançamento financeiro para a parcela do contrato da coligada 1 e 9 com seus respectivos serviços, a integração ao irá enviar o “de/para” “1|100” para o Protheus gerar o título de cobrança. Visto que esse “de/para” estar presente nos dois sistemas.