Histórico da Página
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
|---|
Informações Gerais
Especificação | |||
Produto | Protheus | Módulo | Contabilidade Gerencial |
Segmento Executor |
| ||
Projeto1 | M_CTR010 | IRM1 | PCREQ-5853 |
Requisito1 | PCREQ-5854 | Subtarefa1 | M_CTR010-1059 |
Chamado2 |
| ||
Release de Entrega Planejada |
| Réplica |
|
País | (X) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros | <Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>. | ||
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
Objetivo
Definições necessárias à disponibilização no ambiente Protheus Contabilidade Gerencial das funcionalidades para o atendimento da instrução normativa No. 21 de 13/03/79 que uniformiza o procedimento de apuração de resultado de contratos, com prazo de execução superior a um ano, de construção por empreitada.
A apuração será realizada no sistema TIN utilizando serviços do Protheus para consulta de saldos e lançamentos contábeis.
Essa integração será realizada utilizando a tecnologia de mensagem única.
Definição da Regra de Negócio
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
CTBA030 - Centro de Custos | Envolvida | Contabilidade / Atualizações/Entidade/Custos | |
CTBA040 – Item contábil | Alteração | Contabilidade / Atualizações/ Entidade/Custos | |
CTBA140 – Moedas Contábeis | Envolvida | Contabilidade->Atualizações->Cadastros->Moedas Contábeis | |
CTBA060 – Classe de Valor | Envolvida | Contabilidade->Atualizações->Entidade->Custos | |
CTBA102- Lançamento contábil | Envolvido | Contabilidade->Atualizações->Movimentos->Lançamento Contábeis Automáticos | |
CTBA020 - Plano de Contas | Alteração | Contabilidade / Atualizações/Entidade/Custos | |
CTBA050 – Entidade Contábil | Envolvido | Contabilidade / Atualizações/ Configurações/Entidades Contábeis | |
CTBA800 – Cadastros de Entidades | Alteração | Contabilidade / Atualizações/ Configurações/Entidades Contábeis |
Esta solução foi criada para integrar o módulo Contabilidade Gerencial do Microsiga Protheus com a funcionalidade presente no pacote CorporeRM também chamado de TIN para a apuração e contabilização do andamento do contrato(POC) .
O módulo TIN da RM desta maneira terá acesso as funcionalidades contábeis do Back Office Microsiga Protheus.
Esta integração utilizará o conceito de mensagem única
A Mensagem Única é um mecanismo natural de integração entre os produtos Totvs que padroniza o processo de transferência de informações comuns, tornando a integração um processo ágil, simples e com menor interdependência.
As funcionalidades envolvidas na integração RM TIN X Back Office Protheus para o calculo do POC são:
Contabilidade
- Cadastro Moeda Contábil
- Cadastro Plano de Contas
- Cadastro Centro de Custos
- Cadastro Item Contábil
- Cadastro Classe de Valor
- Cadastro de Entidade Contábeis GerenciaisConta Gerencial
- Lançamento Contábil
- Consulta de Saldo Contábil
Financeiro
- Financiamento
Para atender a integração das funcionalidades citadas serão necessárias a utilização das Mensagens Únicas a seguir:
Contabilidade | Mensagem | Tipo | Versão |
Cadastro Moeda Contábil | Currency | Event | 2_000 |
Cadastro Plano de Contas | AccountAntAccount | Event | 2_000 |
Cadastro Centro de Custos | CostCenter | Event | 2_000 |
Cadastro Item Contábil | AccountingItem | Event | 1_000 |
Cadastro Classe de Valor | ClassValue | Event | 1_000 |
Cadastro de Entidade Contábeis GerenciaisConta Gerencial | ListOfManagerialAccountingEntityManagerialAccountingEntity | Event | 1_000 |
Lançamento Contábil | AccountingEntry | Event | 2_001 |
Consulta de Saldo Contábil | AccountingBalance | Request | 1_000 |
Financeiro | Mensagem | Tipo | Versão |
Financiamento | Financing | Event | 1_002 |
Visão Geral dos Processos
A seguir serão apresentados os processos contemplados no projeto em questão. Lembrando que esta especificação trata apenas os processos dos módulos (Contábil e Financeiro).
Cadastros Contábeis
As mensagens a seguir não serão alteradas nesse projeto, porém são pré requisitos para a integração contábil:
- Cadastro Moeda Contábil
- Cadastro Plano de Contas
- Cadastro Centro de Custos
- Cadastro Classe de Valor
Item Contábil
A mensagem AccountingItem será uma mensagem do tipo “event” e substituirá a mensagem atual “Departament”. O motivo da substituição é que a mensagem atual “Departament” do adpter CTBI040, foi criado em duplicidade com a mensagem do fonte CSAI100.
As tags de envio serão:
TAG SUPERIOR | TAG | Obrigatórios | Observação |
BusinessContentType | _ CompanyId | Não | Empresa |
BusinessContentType | _ BranchId | Não | Filial |
BusinessContentType | _ CompanyInternalId | Não | InternalID da Empresa/Filial
|
BusinessContentType | _Code | Não | Código |
BusinessContentType | _InternalId | Não | InternalID |
BusinessContentType | _ Name | Não | Descrição |
BusinessContentType | _ Class | Não | Classe do Item: 1- Sintético, 2-Analítico |
BusinessContentType | _ RegisterSituation | Não | Situação: Active- Ativo, Inactive - Inativo |
As tags de retorno serão:
TAG SUPERIOR | TAG | Obrigatórios | Observação |
ReturnContentType | _ ListOfInternalId | Não | InternalID |
Para o processamento do InternalID utilizar a função CFGA070Int para pegar o código interno a partir do código recebido pelo XML
Cadastro de Entidade Contábeis Gerenciais
A mensagem ManagerialAccountingEntity ListOfManagerialAccountingEntity será uma mensagem do tipo “event” que será utilizada para o cadastro das entidades gerenciaisde conta gerencial.
A conta gerencial será uma entidade contábil que no RM TIN pode representar a sub-unidade no Protheus será representado por uma entidade gerencial.
No Protheus o cliente pode, através do wizard “CTBWIZENT” criar da entidade 05 até a entidade 09. Essa entidades são cadastradas na tabela CV0, além de criar os campos nas tabelas do sistema.
O RM TIN irá utilizar uma das entidades como equivalente a “Conta Gerencial”, e dependendo da configuração do cliente irá eleger uma das entidades do Protheus.
.
Após a criação da entidade o cliente, no sistema Protheus, deve eleger qual entidade será a conta gerencial e informa no parâmetro MV_CTBCGER.
Essa mensagem é em formato de lista, onde o RM TIN irá enviar uma lista de contas gerenciais, o sistema Protheus irá cadastrar a lista, realizando a validação dos dados. Caso o sistema encontre algum dado inválido a mensagem irá retornar o erro e nenhuma das contas gerenciais da mensagem será gravada no Protheus.
Também deve ser observado o limite padrão de 1 mb para tamanho da mensagem.
As tags de envio serão:
TAG SUPERIOR | TAG | Obrigatórios | Observação |
BusinessContentType | _ CompanyId | Não | Empresa |
BusinessContentType | _ BranchId | Não | Filial |
BusinessContentType | _ CompanyInternalId | Não | InternalID da Empresa/Filial
|
BusinessContentType | _Plane | Não | Plano. Deve informar qual entidade será cadastrada, Entidade 05 até a entidade 09. O TIN irá enviar o código da entidade configurada pelo usuário no RM |
BusinessContentType | _Code | Não | Código |
BusinessContentType | _InternalId | Não | InternalID |
BusinessContentType | _ Name | Não | Descrição |
BusinessContentType | _ Class | Não | Classe do Item: 1- Sintético, 2-Analítico |
BusinessContentType | _ RegisterSituation | Não | Situação: Active- Ativo, Inactive – Inativo |
BusinessContentType | _PostingNature | Não | Natureza da Entidade: 1- Devedora, 2-Credora |
As tags de retorno serão:
TAG SUPERIOR | TAG | Obrigatórios | Observação |
ReturnContentType | _ ListOfInternalId | Não | InternalID |
- Para o processamento do InternalID utilizar a função CFGA070Int para pegar o código interno a partir do código recebido pelo XML
Mensagem de Saldo Contábil
A mensagem AccountingBalance será uma mensagem do tipo “request” ou seja ela irá apenas retornar as informações requistadas pelo sistema externo, não alterando nenhuma informação no sistema Protheus. Essa mensagem deverá ser utilizada para o retorno do saldo de uma entidade ou combinação de entidade como por exemplo Conta + Centro de Custo em um determinado período.
Esse novo serviço será acessado apenas por meio de requisição de mensagem única e será síncrona.
As tags de envio serão:
TAG SUPERIOR | TAG | Obrigatórios | Observação |
BusinessContentType | _ InitialDate | Não | Data Inicial |
BusinessContentType | _ FinalDate | Não | Data Final |
BusinessContentType | _ BalanceType | Não | Tipo de saldo contábil. Caso a tag não seja informada será considerado o tipo de saldo 1 - Fiscal
|
BusinessContentType | _CurrencyCode | Não | Moeda. Caso a tag não seja informada será considerada a moeda 01 |
BusinessContentType | _CurrencyInternalId | Não | Internal Id Moeda. Caso a tag não seja informada será considerada a moeda 01 |
BusinessContentType | _ Account | Não | Conta Contábil |
BusinessContentType | _ AccountInternalId | Não | InternalID da conta contábil |
BusinessContentType | _ CostCenter | Não | Centro de Custo |
BusinessContentType | _ CostCenterInternalId | Não | InternalID do Centro de Custo |
BusinessContentType | _ AccountItem | Não | Item Contábil |
BusinessContentType | _ AccountItemInternalId | Não | InternalID do Item Contábil |
BusinessContentType | _ ClassValue | Não | Classe de Valor |
BusinessContentType | _ ClassValueInternalId | Não | InternalID da Classe de Valor |
BusinessContentType | ManagerialAccountingEntity05 | Não | Entidade Gerencial 05 |
BusinessContentType | ManagerialAccountingEntity05InternalId | Não | InternalID da Entidade Gerencial 05 |
BusinessContentType | ManagerialAccountingEntity06 | Não | Entidade Gerencial 06 |
BusinessContentType | ManagerialAccountingEntity06InternalId | Não | InternalID da Entidade Gerencial 06 |
BusinessContentType | ManagerialAccountingEntity07 | Não | Entidade Gerencial 07 |
BusinessContentType | ManagerialAccountingEntity07InternalId | Não | InternalID da Entidade Gerencial 07 |
BusinessContentType | ManagerialAccountingEntity08 | Não | Entidade Gerencial 08 |
BusinessContentType | ManagerialAccountingEntity08InternalId | Não | InternalID da Entidade Gerencial 08 |
BusinessContentType | ManagerialAccountingEntity09 | Não | Entidade Gerencial 09 |
BusinessContentType | ManagerialAccountingEntity09InternalId | Não | InternalID da Entidade Gerencial 09 |
As tags de retorno serão:
TAG SUPERIOR | TAG | Obrigatórios | Observação |
ReturnContentType | _ CurrentBalance | Não | Saldo Atual |
ReturnContentType | _ CurrentBalanceSignal | Não | Sinal do Saldo ( 1 – Devedor, 2 – Credor) |
ReturnContentType | _ CurrentDebtBalance | Não | Saldo Atual Débito |
ReturnContentType | _ CurrentCreditBalance | Não | Saldo Atual Crédito |
ReturnContentType | _ PreviousBalance | Não | Saldo Anterior |
ReturnContentType | _ PreviousBalanceSignal | Não | Sinal do Saldo ( 1 – Devedor, 2 – Credor) |
ReturnContentType | _ PreviousDebtBalance | Não | Saldo Anterior Débito |
ReturnContentType | _ PreviousCreditBalance | Não | Saldo Anterior Crédito |
ReturnContentType | _ PeriodMovement | Não | Movimento do Período |
ReturnContentType | _ PeriodMovementSignal | Não | Sinal do Saldo ( 1 – Devedor, 2 – Credor) |
ReturnContentType | _ PeriodDebtMovement | Não | Movimento do Período Crédito |
ReturnContentType | _ PeriodCreditMovement | Não | Movimento do Período Débito |
- Para o processamento do InternalID utilizar a função CFGA070Int para pegar o código interno a partir do código recebido pelo XML
Mensagem de Lançamento Contábil
Atualmente a mensagem AccountingEntry utiliza até a entidade de centro de custo (Conta e Centro de Custo), após esse desenvolvimento o sistema irá permitir utilizar as seguintes entidades na mensagem única:
- Item Contábil
- Classe de Valor
- Conta Gerencial
As novas tags de envio serão:
TAG SUPERIOR | TAG | Obrigatórios | Observação |
BusinessContentType | _ AccountingItemDebitCode | Não | Item contábil Débito |
BusinessContentType | _ AccountingItemDebitInternalId | Não | InternalID do Item contábil Débito |
BusinessContentType | _ AccountingItemCreditCode | Não | Item contábil Crédito |
BusinessContentType | _ AccountingItemCreditInternalId | Não | InternalID do Item contábil Crédito |
BusinessContentType | _ ClassValueDebitCode | Não | Classe de Valor Débito |
BusinessContentType | _ ClassValueDebitInternalId | Não | InternalID da Classe de Valor Débito |
BusinessContentType | _ ClassValueCreditCode | Não | Classe de Valor Crédito |
BusinessContentType | _ ClassValueCreditInternalId | Não | InternalID da Classe de Valor Crédito |
BusinessContentType | ManagerialAccountingEntity05Debit | Não | Entidade Gerencial 05 Debito |
BusinessContentType | ManagerialAccountingEntity05DebitInternalId | Não | InternalID Entidade Gerencial 05 Debito |
BusinessContentType | ManagerialAccountingEntity05Credit | Não | Entidade Gerencial 05 Crédito |
BusinessContentType | ManagerialAccountingEntity05CreditInternalId | Não | InternalID Entidade Gerencial 05 Crédito |
- Para o processamento do InternalID utilizar a função CFGA070Int para pegar o código interno a partir do código recebido pelo XML
O adapter CTBI102 deverá ser alterado para respeitar as novas tags.
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas