Cadastros
Cadastros Especiais
Será necessário primeiro fazer o cadastro manualmente no Protheus e no RM e depois configurar o “de/para” de integração correspondente (RM e Protheus possuem interfaces específicas para este fim).
RM: RM.exe | Segmento Integrações | Aba Integração | Mensagem Única | De-Para
Empresa e Filial
O primeiro cadastro que deve ser realizado para operação dos sistemas é o de Empresa (Coligada) e suas Filiais. No RM estas entidades são cadastros comuns, mas no Protheus a Empresa e as Filias são definidas em arquivos de configuração de ambientes sendo parte da implantação do Protheus padrão.
A maioria das mensagens de integração fará referências ao cadastro de Empresa/Coligada.
Ex:
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 |
Info |
---|
|
Nas integrações com o Protheus, será necessário cadastrar manualmente na tabela de De/Para um mapeamento da coligada para ela mesma (conforme exemplo abaixo). Esse cadastro é necessário para o correto funcionamento dos códigos de extensions criados nas integrações. |
Cadastros comuns
<Plano de Contas>
Identificador da Mensagem: AccountAntAccount
Versão: 2.000
Módulo Gestão Contábil: RM
Módulo Protheus: Protheus
Tipo de Envio:
Mensagem Padrão | RM | PROTHEUS |
Tabela | Campo | Tabela | Campo |
CompanyId | CCONTA | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | CCONTA | CODCOLIGADA | - | Variável do Sistema |
Code | CCONTA | CODCONTA | CT1 | CT1_CONTA |
InternalId | CCONTA | CODCOLIGADA|CODCONTA | CT1 | CT1_FILIAL|CT1_CONTA |
ShortCode | CCONTA | REDUZIDO | CT1 | CT1_RES |
Description | CCONTA | DESCRIÇÃO | CT1 | CT1_DESC01 |
PostingNature | CCONTA | NATUREZA | CT1 | CT1_NORMAL |
AnalyticalOrSynthetic | CCONTA | ANALITICA | CT1 | CT1_CLASSE |
ActiveOrInactive | CCONTA | INATIVA | CT1 | CT1_BLOQ |
Info |
---|
|
Está disponível no RM um campo chamado “NATSPED” conforme print abaixo. Esse campo informa para o SPED a natureza da conta (se é uma conta de ativo, passivo, patrimônio líquido, contas de resultado, contas de compensação). Esse campo não será transferido na mensagem pois o mesmo deve estar somente no backoffice. Porém, esse campo é obrigatório para inclusão da conta contábil no RM. Sendo assim, iremos gravar o valor de valor “01 – Não informado” somente para permitir a geração. |
Info |
---|
|
A máscara parametrizada da conta contábil no TOTVS Contabilidade Gerencial será 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 seu código de conta (ex: 1011214), então o parâmetro “Não utiliza máscara nas contas” deve ser marcado. Caso contrário, ocorrerá um erro no processo de inclusão da conta. |
Caminho para acesso ao cadastro do Plano de contas, no sistema:
Acesse: BackOffice | Contabilidade Gerencial | Cadastros | Contábil
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 cenário onde o Protheus possuir um compartilhamento por Empresa e por Filial para o Plano de Contas, o 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
Note |
---|
|
A configuração para utilização da conta Global será realizada somente se o Protheus tiver um compartilhamento por Empresa. |
<Centro de custo>
Identificador da Mensagem: CostCenter
Versão: 2.000
Módulo Gestão Financeira: RM
Módulo Protheus: Protheus
Tipo de Envio:
Mensagem Padrão | RM | PROTHEUS |
Tabela | Campo | Tabela | Campo |
CompanyId | GCCUSTO | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | | | - | Variável do Sistema |
BranchId | | | CTT | CTT_FILIAL |
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 mensagem de Centro de Custo:
O código do centro de custo no TOTVS Gestão Financeira poderá ser criado de forma sequencial ou através de máscara. Essa definição poderá ser feita através do parâmetro EDUCTBCCUSTOAUTOINC 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 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 deverá ser removida para que o sistema financeiro TOTVS Gestão Financeira aceite os código enviado pelo PROTHEUS, na integração.
No sistema, o parâmetro pode ser acessado através do caminho:
Acesse: MóduloBackOffice | 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
10.1.2.3. <Histórico Padrão>
Identificador da Mensagem: AccountAntDefaultHistory
Versão: 1.000
Módulo Educacional: RM
Módulo Protheus: Protheus
Tipo de Envio:
Mensagem Padrão | RM | PROTHEUS |
Tabela | Campo | Tabela | Campo |
CompanyId | CHISTP | CODCOLIGADA | | |
DefaultHistoryCode | CHISTP | CODHISTP | | |
InternalId | CHISTP | CODCOLIGADA|CODHISTP | | |
Description | CHISTP | DESCRICAO | | |
DefaultHistoryCode | CHISTP | CODCOLIGADA | | |
Nota
Apesar da mensagem de histórico padrão pertencer a integração, ainda, não será utilizada.
10.1.2.4. <Período Contábil>
Identificador da Mensagem: AccountingCalendar
Versão: 1.000
Módulo Educacional: RM
Módulo Protheus: Protheus
Tipo de Envio:
Mensagem Padrão | RM | PROTHEUS |
Tabela | Campo | Tabela | Campo |
CompanyId | CPARAM | CODCOLIGADA | - | Variável do Sistema |
CompanyInternalId | CPARAM | CODCOLIGADA | - | Variável do Sistema |
CalendarCode | CPARAM | CODCOLIGADA |24|25 | CTG | CTG_CALEND |
InternalId | CPARAM | CODCOLIGADA|24|25 | CTG | CTG_FILIAL|CTG_CALEND|CTG_EXERC |
InitialDate | CPARAM | CODCOLIGADA|24 | CTG | CTG_DTINI |
FinalDate | CPARAM | CODCOLIGADA|25 | CTG | CTG_DTFIM |
Nota
ID = 24 (corresponde a linha da parametrização da dataInicio do período contábil)
ID = 25 (corresponde a linha da parametrização da dataFIm do período contábil)
No processo de integração, o RM atualizará as datas de período contábil sempre de acordo com a menor data inicial e a maior data final enviada pelo Protheus. No Protheus, essas informações são armazenadas em um cadastro, e no RM essas informações são armazenadas nos parâmetros, sendo assim, teremos espaço para armazenar somente uma dataIncial e uma dataFinal.
Caminhos para a parametrização do período contábil:
Acesse: BackOffice | Contabilidade Gerencial | Ambiente | Parâmetros | TOTVS Contabilidade Gerencial
01.04 – Fechamento | 01.04.01 – Fechamento Mensal
10.1.2.5. <Lançamentos Contábeis>
Identificador da Mensagem: AccountingEntry
Versão: 2.000
Módulo Gestão de Estoque, Compras e Faturamento: RM
Módulo Protheus: Protheus
Tipo de Envio:
Mensagem Padrão | RM | PROTHEUS |
Tabela | Campo | Tabela | Campo |
CompanyId | CLANCAMENTO | CODCOLIGADA | - | Variável do Sistema |
BranchId | CLANCAMENTO | CODFILIAL | - | Variável do Sistema |
CompanyInternalId | CLANCAMENTO | CODCOLIGADA | - | Variável do Sistema |
PeriodStartDate | CLANCAMENTO | DATAINICIAL | - | - |
PeriodoEndDate | CLANCAMENTO | DATAFINAL | - | - |
BatchNumber | CLANCAMENTO | CODLOTE | CT2 | CT2_LOTE |
Document | CLANCAMENTO | CODLOTE | CT2 | CT2_DOC |
InternalId | CLANCAMENTO | CODCOLIGADA|CODLOTE | CT2 | CT2_FILIAL | CT2_DATA | CT2_LOTE | CT2_SBLOTE | CT2_DOC |
Entries/Entry/item | | | CT2 | CT2_LINHA |
Entries/Entry/ItemType | | | CT2 | CT2_DC |
Entries/Entry/EntryNumber | CPARTIDA | CODCOLIGADA| IDPARTIDA | - | - |
Entries/Entry/MovementDate | CPARTIDA | DATA | CT2 | CT2_DATA |
Entries/Entry/DebitAccountCode | CPARTIDA | DEBITO | CT2 | CT2_DEBITO |
Entries/Entry/DebitAccountInternalId | CPARTIDA | CODCOLDEBITO|DEBITO | CT1 | CT1_FILIAL | CT1_CONTA |
Entries/Entry/CreditAccountCode | CPARTIDA | CREDITO | CT2 | CT2_CREDIT |
Entries/Entry/CreditAccountInternalId | CPARTIDA | CODCOLCREDITO|CREDITO | CT1 | CT1_FILIAL | CT1_CONTA |
Entries /EntryValue | CPARTIDA | VALOR | CT2 | Ct2_VALOR |
Entries/Entry/HistoryCode | | | CT2 | CT2_HP |
Entries/Entry/ComplementaryHistory | CPARTIDA | COMPLEMENTO | CT2 | Ct2_HIST |
Entries/Entry/CostCenterCode | CPARTIDA | CODCCUSTO | CT2 | CT2_CCD |
Entries/Entry/CostCenterDebitInternalId | CPARTIDA | CODCOLIGADA|CODCCUSTO | CTT | CTT_FILIAL | CTT_CUSTO |
CompanyId | CPARTIDA | CODCCUSTO | - | Variável do Sistema |
BranchId | CPARTIDA | CODCOLIGADA|CODCCUSTO | - | Variável do Sistema |
CompanyInternalId | CLANCAMENTO | CODCOLIGADA | - | Variável do Sistema |
PeriodStartDate | CLANCAMENTO | CODFILIAL | - | - |
PeriodoEndDate | CLANCAMENTO | CODCOLIGADA | - | - |
BatchNumber | CLANCAMENTO | DATAINICIAL | CT2 | CT2_LOTE |
Document | CLANCAMENTO | DATAFINAL | CT2 | CT2_DOC |
InternalId | CLANCAMENTO | CODLOTE | CT2 | CT2_FILIAL | CT2_DATA | CT2_LOTE | CT2_SBLOTE | CT2_DOC |
Entries/Entry/item | CLANCAMENTO | CODLOTE | CT2 | CT2_LINHA |
Entries/Entry/ItemType | CLANCAMENTO | CODCOLIGADA|CODLOTE | CT2 | CT2_DC |
Entries/Entry/EntryNumber | | | - | - |
Entries/Entry/MovementDate | | | CT2 | CT2_DATA |
Entries/Entry/DebitAccountCode | CPARTIDA | CODCOLIGADA| IDPARTIDA | CT2 | CT2_DEBITO |
Entries/Entry/DebitAccountInternalId | CPARTIDA | DATA | CT1 | CT1_FILIAL | CT1_CONTA |
Entries/Entry/CreditAccountCode | CPARTIDA | DEBITO | CT2 | CT2_CREDIT |
Entries/Entry/CreditAccountInternalId | CPARTIDA | CODCOLDEBITO|DEBITO | CT1 | CT1_FILIAL | CT1_CONTA |
Entries /EntryValue | CPARTIDA | CREDITO | CT2 | Ct2_VALOR |
Entries/Entry/HistoryCode | CPARTIDA | CODCOLCREDITO|CREDITO | CT2 | CT2_HP |
Entries/Entry/ComplementaryHistory | CPARTIDA | VALOR | CT2 | Ct2_HIST |
Entries/Entry/CostCenterCode | | | CT2 | CT2_CCD |
Entries/Entry/CostCenterDebitInternalId | CPARTIDA | COMPLEMENTO | CTT | CTT_FILIAL | CTT_CUSTO |
CompanyId | CPARTIDA | CODCCUSTO | - | Variável do Sistema |
BranchId | CPARTIDA | CODCOLIGADA|CODCCUSTO | - | Variável do Sistema |
CompanyInternalId | CPARTIDA | CODCCUSTO | - | Variável do Sistema |
PeriodStartDate | CPARTIDA | CODCOLIGADA|CODCCUSTO | - | - |
PeriodoEndDate | CLANCAMENTO | CODCOLIGADA | - | - |
BatchNumber | CLANCAMENTO | CODFILIAL | CT2 | CT2_LOTE |
Document | CLANCAMENTO | CODCOLIGADA | CT2 | CT2_DOC |
InternalId | CLANCAMENTO | DATAINICIAL | CT2 | CT2_FILIAL | CT2_DATA | CT2_LOTE | CT2_SBLOTE | CT2_DOC |
Entries/Entry/item | CLANCAMENTO | DATAFINAL | CT2 | CT2_LINHA |
Entries/Entry/ItemType | CLANCAMENTO | CODLOTE | CT2 | CT2_DC |
Entries/Entry/EntryNumber | CLANCAMENTO | CODLOTE | - | - |
Entries/Entry/MovementDate | CLANCAMENTO | CODCOLIGADA|CODLOTE | CT2 | CT2_DATA |
Entries/Entry/DebitAccountCode | | | CT2 | CT2_DEBITO |
Entries/Entry/DebitAccountInternalId | | | CT1 | CT1_FILIAL | CT1_CONTA |
Entries/Entry/CreditAccountCode | | CODCOLIGADA| IDPARTIDA | CT2 | CT2_CREDIT |
Entries/Entry/ AccountingItemDebitCode | SHABILITACAOFILIALINTPROTHEUS | IDCLASSEVALORPROTHEUS | CT2 | CT2_ITEMD |
Entries/Entry/ AccountingItemDebitInternalId | SHABILITACAOFILIALINTPROTHEUS | CODCOLIGADA| IDCLASSEVALORPROTHEUS | | |
Entries/Entry/ AccountingItemCreditCode | SHABILITACAOFILIALINTPROTHEUS | IDCLASSEVALORPROTHEUS | CT2 | CT2_ITEMC |
Entries/Entry/ AccountingItemCreditInternalId | SHABILITACAOFILIALINTPROTHEUS | CODCOLIGADA| IDCLASSEVALORPROTHEUS | | |
Entries/Entry/ ClassValueDebitCode | SHABILITACAOFILIALINTPROTHEUS | IDITEMCONTABILPROTHEUS | CT2 | CT2_CLVLDB |
Entries/Entry/ ClassValueDebitInternalId | SHABILITACAOFILIALINTPROTHEUS | CODCOLIGADA| IDITEMCONTABILPROTHEUS | | |
Entries/Entry/ ClassValueCreditCode | SHABILITACAOFILIALINTPROTHEUS | IDITEMCONTABILPROTHEUS | CT2 | CT2_CLVLCR |
Entries/Entry/ ClassValueCreditInternalId | SHABILITACAOFILIALINTPROTHEUS | CODCOLIGADA| IDITEMCONTABILPROTHEUS | | |
Informações importantes sobre a geração de lançamentos contábeis:
A informação do “Código do Lote” [BatchNumber] será utilizada como identificador do lote contábil enviado para o Protheus.
Durante a geração de contabilização por competência do Educacional (Aba Financeiro / Contabilidade > Processo de Contabilidade), será enviado uma mensagem com todos os lançamentos contábeis processados para o Protheus.
Caso seja executado o processo de estorno (Aba Financeiro / Contabilidade > Processo de Contabilidade), deverá ser enviada uma mensagem com os lançamentos de estorno como se estissem incorporados ao lote “0”, nesse caso eles nunca serão excluídos.
Caminhos para acesso a geração da contabilização:
Acesse:
Educacional | Educacional | Financeiro / Contábil | Contabilidade
Educacional | Educacional | Financeiro / Contábil | Contratos
Processos | Gerar contabilização
Importante:
As informações de Item Contábil e Classe de Valor serão obtidas através da Matriz Aplicada do Educacional. Quando houver necessidade de enviá-las na mensagem de lançamentos contábeis será necessário a configuração do Evento Contábil para busca-las.
Será exibida a aba “Integração Protheus”, no cadastro de Evento Contábil, quando a integração estiver ativa. Após a configuração de busca para “Matriz Aplicada”, na aba “Integração Protheus”, ao enviar a mensagem de lançamentos contábeis e as informações de Item Contábil e Classe de Valor vinculadas, elas serão enviadas para a integração.
A mesma configuração poderá ser realizada no Módulo de Gestão de Estoque, Compras e Faturamento para envio dessas informações na contabilização do movimento.
A aba “Integração Protheus” será exibida para todos os eventos do tipo: Contrato Educacional, Parcela Educacional e Movimento
Cadastros
Descreva características gerais do fluxo de informações e que serão comuns para este tipo de entidade. Características particulares para cada entidade deverão ser citadas em tópicos específicos de cada entidade.
Sempre que existir (a sugestão é sempre criar) e for agregador ao documento acrescentar aqui os diagramas/imagens ou até mesmo colocar tais diagramas diretamente na especificação dos processos
Em seguida faça uma descrição para cada um dos fluxos para cada entidade
<Transação/Entidade>
Identificador da Mensagem: <mensagem>
Versão: <versão>
Módulo <marca 1>: <BackOffice – Gestão xxxxxxx>
Módulo <marca 2>: <SIGAXXX>
Tipo de Envio: <Assíncrona/Síncrona>
Mensagem Padrão | PROTHEUS | RM |
Tabela | Campo | Tabela | Campo |
Code | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO * |
Description | CTO990 | CTO_DESC | GMOEDA | DESCRICAO |
Symbol | CTO990 | CTO_SIMB | GMOEDA | SIMBOLO |
Notas:
Observações sobre comportamento desta mensagem ou dos processos envolvidos nela/para ela
A seguir descrever as variações, particularidades da mensagem e processos (integração) de acordo com cada marca
Limitações/Restrições
Descreva limitações e restrições para a integração que está sendo descrita.