Integração RM Labore x BackOffice Protheus
Sumário
1. Contexto de negócio (Introdução)
2. Sistemas Envolvidos
3. Integração
4. Escopo
5. Pré-requisitos instalação/implantação/utilização
5.1 Protheus
5.2 RM
Importante!
6. Instalação/Atualização
6.1 Protheus
6.2 RM
Instalar o WebService de Integração (TBC)
Execução do configurador da integração
Configuração da integração
Parametrização do Totvs folha de pagamento
Mapeamento manual (cadastro de/para)
Permissão de usuário
7. Controle de Versão
8. Suporte
9. Transações/Entidades/Mensagens únicas
10. Fluxo das Informações
10.1 Cadastros
10.2 Processos
11. Como fazer
12. Situações comuns
13. Anexos
14. Novidades da Integração
Contexto de negócio (Introdução)
Este documento tem por objetivo reunir as informações relevantes sobre a Integração do Totvs folha de pagamentos RM com BackOffice Protheus.
Esta integração está de acordo com as boas práticas recomendadas pelo Comitê de Integração TOTVS e utiliza a arquitetura Mensagem Única e comunicação via WebService.
Sistemas Envolvidos
- BackOffice Protheus (Financeiro e Contabilidade Gerencial)
- RM Labore
Integração
- Envio de Fornecedor do Protheus, módulo Financeiro, para o RM Labore.
- Envio de Centro de Custo do Protheus, módulo Contabilidade Gerencial, para o RM Labore.
- Envio de Banco do Protheus, módulo Financeiro, para o RM Labore.
- Envio de Plano de Contas do Protheus, módulo Contabilidade Gerencial, para o RM Labore.
- Envio de Período Contábil do Protheus, módulo Contabilidade Gerencial, para o RM Labore.
- Envio de Lançamentos Financeiros (Contas a Pagar) do RM Labore para o Protheus, módulo Financeiro.
- Envio de Lançamentos Contábeis do RM Labore para o Protheus, módulo Contabilidade Gerencial.
Escopo
Essa integração visa a utilização do BackOffice Protheus para fazer a contabilização e o RM Labore para o cálculo da folha de pagamento. Para tais fins, os seguintes itens fazem parte do escopo:
- Envio de inclusão, alteração e exclusão de Fornecedor do Protheus, módulo Financeiro, para o RM Labore.
- Envio de inclusão, alteração e exclusão de Centro de Custo do Protheus, módulo Contabilidade Gerencial, para o RM Labore.
- Envio de inclusão, alteração e exclusão de Banco do Protheus, módulo Financeiro, para o RM Labore.
- Envio de inclusão, alteração e exclusão de Plano de Contas do Protheus, módulo Contabilidade Gerencial, para o RM Labore.
- Envio de inclusão, alteração e exclusão de Período Contábil do Protheus, módulo Contabilidade Gerencial, para o RM Labore.
- Envio de inclusão, alteração e exclusão de Lançamento Contábil do RM Labore para o Protheus, módulo Contabilidade Gerencial.
- Envio de inclusão, alteração e exclusão de Lançamento Financeiro (Contas a Pagar) do RM Labore para o Protheus, módulo Financeiro.
Os seguintes itens NÂO fazem parte do escopo dessa integração:
- Envio ou recebimento de Clientes através da mensagem CUSTOMERVENDOR.
- Integração do cadastro de Natureza Financeira (FinancialNature).
- Integração do cadastro de Moeda (Currency),
- Integração de Histórico Padrão (AccountantDefaultHistory).
- Envio de Fornecedor do RM Labore para o Protheus.
- Envio de Centro de Custo do RM Labore para o Protheus.
- Envio de Banco do RM Labore para o Protheus.
- Envio de Plano de Contas do RM Labore para o Protheus.
- Envio de Período Contábil do RM Labore para o Protheus.
- Envio de Lançamento Contábil do Protheus para o RM Labore.
- Envio de Lançamento Financeiro (Contas a Pagar) do Protheus para o RM Labore.
Pré-requisitos instalação/implantação/utilização
Protheus
- Versão mínima do Protheus: 11.80.
- Possuir um licenciamento (License Server) adequado do sistema Protheus.
- Necessário o uso da ferramenta EAI.
- Necessária configuração de um WebService.
- Módulos necessários: Financeiro (SigaFIN) e Contabilidade Gerencial (SigaCTB).
- Programa CTB cuja data mínima seja 24/07/2014.
- Programa CTBA010 cuja data mínima seja 24/07/2014.
- Programa CTBA020 cuja data mínima seja 24/07/2014
- Programa CTBA030 cuja data mínima seja 03/07/2014.
- Programa CTBA101 cuja data mínima seja 24/07/2014.
- Programa CTBA102 cuja data mínima seja 24/07/2014.
- Programa CTBA105 cuja data mínima seja 24/07/2014.
- Programa CTBA140 cuja data mínima seja 24/07/2014.
- Programa CTBI010 cuja data mínima seja 24/07/2014.
- Programa CTBI020 cuja data mínima seja 24/07/2014.
- Programa CTBI030 cuja data mínima seja 17/06/2014.
- Programa CTBI102 cuja data mínima seja 24/07/2014.
- Programa CTBXFUN cuja data mínima seja 24/07/2014.
- Programa CTBXFUNA cuja data mínima seja 24/07/2014.
- Programa CTBXFUNB cuja data mínima seja 24/07/2014.
- Programa CTBXFUNC cuja data mínima seja 24/07/2014.
- Programa CTBXVLD cuja data mínima seja 24/07/2014.
- Programa FIN cuja data mínima seja 16/07/2014.
- Programa FINA050 cuja data mínima seja 16/07/2014.
- Programa FINI050 cuja data mínima seja 07/07/2014.
- Programa FINXFUN cuja data mínima seja 22/07/2014.
- Programa MATA020 cuja data mínima seja 29/04/2014.
- Programa MATA070 cuja data mínima seja 14/07/2014.
- Programa MATI020 cuja data mínima seja 26/05/2014.
- Programa MATI070 cuja data mínima seja 01/04/2014.
RM
- Versão mínima RM: 12.1.3.
- Utilizar nova máquina de cálculo do RM Labore.
- Utilizar o EAI.
Utilizar o Internet Information Services (IIS).
Obs.: As entidades contábeis "Item contábil" e "Classe de Valor" da Integração Contábil, foram homologadas e disponibilizadas ao mercado no release 12.1.13 das duas marcas (Protheus e RM).
Importante!
É responsabilidade da equipe de implantação executar a carga inicial e/ou sincronismo dos cadastros, para os clientes que já possuem bases de dados dos produtos TOTVS implantadas. A integração realiza o sincronismo automático dos novos registros ou das alterações posteriores após sua ativação.
Instalação/Atualização
Protheus
- Acessar SigaCFG > Ambiente > Cadastros > Parâmetros e configurar o parâmetro MV_EAIURL2 com o endereço do serviço de EAI do ambiente ao qual o Protheus será integrado.
Exemplo: http://12.50.90.211:81/MensagemUnicaWS.
- Acessar SigaCFG > Ambiente > Cadastros > Parâmetros e configurar o parâmetro MV_EAIWS com o nome do cliente WebService do EAI para envio a outro EAI. (WSEAISERVICE).
- Caso o servidor necessite de autenticação, acessar SigaCFG > Ambiente > Cadastros > Parâmetros e configurar o parâmetro MV_ EAIUSER com o nome de usuário.
- Caso o servidor necessite de autenticação, acessar SigaCFG > Ambiente > Cadastros > Parâmetros e configurar o parâmetro MV_ EAIPASS com a senha de usuário.
- Acessar SigaCFG > Ambiente > Schedule > Adapter E.A.I. e realizar o cadastro das rotinas de integração, conforme segue:
Mensagem Única | Rotina | Mensagem | Envia | Recebe | Método | Operação | Canal | Versão |
Sim | CTBA020 | ACCOUNTANTACCOUNT | Sim | Não | Síncrono | Todas | EAI | 2.000 |
Sim | CTBA030 | COSTCENTER | Sim | Não | Síncrono | Todas | EAI | 2.000 |
Sim | CTBA010 | ACCOUNTINGCALENDAR | Sim | Não | Síncrono | Todas | EAI | 1.000 |
Sim | CTBA102 | ACCOUNTINGENTRY | Não | Sim | Síncrono | Todas | EAI | 2.000 |
Sim | MATA020 | CUSTOMERVENDOR | Sim | Não | Síncrono | Todas | EAI | 2.003 |
Sim | MATA070 | BANK | Sim | Não | Síncrono | Todas | EAI | 2.000 |
Sim | FINA050 | ACCOUNTPAYABLEDOCUMENT | Não | Sim | Síncrono | Todas | EAI | 2.000 |
- Caso alguma mensagem esteja configurada com o método Assíncrono, acessar SigaCFG > Ambiente > Schedule > Schedule e configurar um agente e um agendamento, conforme segue abaixo:
- Cadastrar agente.
Clicar no símbolo destacado no canto superior direito da tela, para o cadastro automático dos agentes:
- Cadastrar agendamento.
Clicar no símbolo destacado na parte inferior para adicionar um novo agendamento:
Preencher o campo "Rotina" com a rotina FWEAI e informar as empresas para as quais o agendamento será válido:
Definir a data e horário para a execução do agendamento e definir a recorrência (clicando no símbolo destacado na parte superior), conforme as necessidades existentes
Confirmar a inclusão do agendamento:
- Iniciar os serviços de agendamento:
- Iniciar os agentes:
RM
Instalar o WebService de Integração (TBC)
Execute o instalador "TOTVS Business Connect – [versão].msi" e patchs disponíveis, se houver. Este pacote cria uma aplicação no IIS e copia os arquivos necessários para a utilização dos WS.
Os WS serão instalados na porta 80 (como é a porta padrão pode ser omitida na url). E o alias de banco de dados padrão será CORPORERM. Mas o administrador do sistema deverá alterar esta e demais configurações, se desejado, editando o arquivo Web.config que se encontra no diretório de instalação RM na pasta WS_TBC.
Execução do configurador da integração
Acesse RM.exe | Segmento Integrações | Aba Ferramentas | Configurar. Será apresentado um wizard de configuração do TBC. Este projeto utiliza mensageria padrão TOTVS, então selecione a opção "TOTVS Folha de pagamento RM x BackOffice Protheus" e execute o processo.
Configuração da integração
Acesse RM.exe | Segmento Integrações | Aba Integração | Mensagem Única | Integrações. Esta interface permite incluir ou alterar um pacote de integração.
Selecione TOTVS Folha de pagamento Rm x BackOffice Protheus (Identificador = 1013) e clique em editar para alterar as configurações iniciais criadas pelo configurador.
- Identificação
- NOME INTEGRAÇÃO: Este é o nome completo da integração. Trata-se de um campo meramente informativo.
- NOME REDUZIDO: Este é o nome reduzido da integração. Trata-se de um campo apenas informativo.
- SISTEMA INTEGRADO: Este é um mnemônico que identifica a aplicação de origem e será enviado no atributo "name" da tag <Product> no XML trafegado.
Ex: "PROTHEUS".
- SIGNIFICADO DE COLIGADA: Define qual o limite da identificação da coligada, se representa a companhia ou a unidade de negócio.
- 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 do mesmo no seu navegador (no formato http://\[servidor\]:\[porta\]), 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. BackOffice Protheus X TOTVS Incorporação
- Mapeamento de Entidades
Aqui é possível fazer mapeamentos de cada entidade (cada mensagem única) que faz parte do pacote de integração. O Wizard de Configuração fará o mapeamento padrão automaticamente. Alterações só devem ser feitas com critério. Vale ressaltar que as alterações realizadas precisam ser muito bem documentadas, pois a atualização de versões e reconfiguração da integração pode substituí-las, para aplicar ajustes necessários ou até mesmo melhorias.
Caso seja necessário acrescentar uma entidade à integração que não esteja no pacote padrão, clique em Anexos e escolha "Mapeamento de Entidades". Na tela que é apresentada informe o código ou nome da mensagem. Clique no botão reticências (...) para localizar a mensagem na lista de mensagens pré-cadastradas.
- EAI – Fila de Mensagens Únicas
Acesse RM.exe | Segmento Integrações | Aba Integração | Mensagem Única | Fila de mensagens únicas. Nesta tela serão registradas as informações de envio e recebimento de mensagens XML trafegadas pela integração. Para ver mais detalhes da mensagem trafegada de um duplo clique no registro, para detalhes de execução (erro ou sucesso) selecione o registro e clique em Anexos | Informações de execução de mensagem, neste anexo é possível visualizar a mensagem de resposta.
Parametrização do Totvs folha de pagamento
Acesse RM.exe | segmento RH| aba Ambiente| Parâmetros | Folha de pagamento. Nesse parametrizador serão registradas informações dos parâmetros de integração da folha RM com qualquer BackOffice de terceiros.
Importante: O documento em questão detalha a integração da folha da RM com o BackOffice do Protheus.
Porém, a folha da RM está preparada para integrar com qualquer BackOffice. Para isso, basta desenvolver e mapear as mensagens no EAI da RM.
- Usa integração com outros BackOffice: Este parâmetro deve ser marcado caso queira integrar a folha da RM com outros BackOffice. Se o mesmo for desmarcado, a folha será integrada com o BackOffice da RM.
- Qtde. partidas contábeis enviadas por pacote contábil: Esse parâmetro armazena a quantidade de partidas contábeis que devem ser enviadas para os BackOffice. Esse parâmetro foi criado devido a uma limitação da arquitetura do Protheus em receber pacotes grandes de informações nas suas mensagens.
Ao ativar a opção de integração com outros BackOffices, automaticamente o parâmetro "Gera lotes contábeis no Folha de Pagamento antes de enviar para o Saldus" localizado em 06.01 – Folha de Pagamento / 06.01.03 – Folha Normal é selecionado e bloqueado para alteração.
Para a configuração agrupamento de partidas contábeis, acessar a Etapa 11 (Contabilização) do parametrizador e selecionar as opções: Item Contábil (Área e Linha de Negócio) e/ou Classe de Valor.
Nota: |
Nota: |
Mapeamento manual (cadastro de/para)
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 (Empresa) | |||
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 |
Obs: 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.
Ex:
De-para RM (Empresa) | |
Tabela RM | GCOLIGADA |
Chave Primária RM | CODCOLIGADA |
Valor Chave Primária RM | 1 |
Sistema Integrado | PROTHEUS |
Valor Chave Integração | 1 |
- Tipo de documento
Esse projeto não contempla o sincronismo automático de tipos de documentos. Portanto, o cadastro dessas informações deve ser feito manualmente no RM e no Protheus e o cadastro dos "de/para" devem ser feitos manualmente em ambos os lados.
A mensagem contendo dados de lançamentos financeiros fará referência aos tipos de documentos cadastrados.
De-para RM (Empresa) | ||
Tabela RM | FTDO | |
Chave Primária RM | CODCOLIGADA | CODTDO |
Valor Chave Primária RM | 1 | 0001 |
Sistema Integrado | PROTHEUS | |
Valor Chave Integração | 10 | 1 |
Permissão de usuário
Lançamentos financeiros
Acesse RM.exe | segmento Globais| aba Segurança| Perfis.
Na edição de perfil, aba "Acesso a Menus" localize na árvore de tags o recurso em questão:
[Folha de Pagamento | Encargos | Financeiro | Lançamentos | Integração financeira com outros BackOffice]. Através dessa permissão, o usuário do perfil terá condições de executar o processo de envio de dados financeiros para o BackOffice de terceiros.
Lançamentos contábeis
Acesse RM.exe | segmento Globais| aba Segurança| Perfis.
Na edição de perfil, aba "Acesso a Menus" localize na árvore de tags o recurso em questão:
[Folha de Pagamento | Encargos | Contabilização | Lançamentos| Lançamentos (RM Labore) | Integração contábil com outros BackOffice]. Através dessa permissão, o usuário do perfil terá condições de executar o processo de envio de dados contábeis para o BackOffice de terceiros.
Controle de Versão
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.
Suporte
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.
Transações/Entidades/Mensagens únicas
Método | ID | Descrição | Origem | Destino | XSD (versões podem variar) |
Cadastros | 01 | Centro de Custo | Protheus | RM | CostCenter_2_000.xsd |
02 | Fornecedor | Protheus | RM | CustomerVendor_2_003.xsd | |
03 | Banco | Protheus | RM | Bank_2_000.xsd | |
04 | Plano de Contas | Protheus | RM | AccountantAccount_2_000.xsd | |
05 | Histórico Padrão | Protheus | RM | AccountantDefaultHistory_1_000.xsd | |
06 | Período Contábil | Protheus | RM | AccountingCalendar_1_000.xsd | |
07 | Lançamento Financeiro | RM | Protheus | AccountPayableDocument_2_000.xsd | |
08 | Lançamento Contábil | RM | Protheus | AccountingEntry_2_000.xsd |
Fluxo das Informações
- Protheus envia Centro de Custo para o RM.
- Protheus envia Fornecedor para o RM.
- Protheus envia Banco para o RM.
- Protheus envia Plano de Contas para o RM.
- Protheus envia Plano Contábil para o RM.
- RM envia Lançamento Financeiro para o Protheus.
- RM envia Lançamento Contábil para o Protheus.
Cadastros
Fornecedor
Identificador da Mensagem: CustomerVendor
Versão: 2.003
Módulo RM: Financeiro – Cadastro de Cliente/Fornecedor
Módulo Protheus: SigaFIN - Financeiro
Tipo de Envio: Síncrono
Mensagem Padrão |
| RM | PROTHEUS | ||||||||
Tabela | Campo | Valor | Tabela | Campo | Valor | ||||||
CompanyId | Código da empresa | FCFO | CODCOLIGA DA | cEmpAnt | |||||||
CompanyIntern alId | InternalId da empresa |
| CODCOLIGA DA | cEmpAnt | xFilial(" SA2") | ||||||
Code | Código do fornecedor | FCFO | CODCFO | SA2 | A2_COD | ||||||
StoreId | Loja | SA2 | A2_LOJA | ||||||||
|
|
|
| CODCFO |
|
| cEmpAnt | xFilial("S A2") | A2_COD | A2_LOJA | |
ShortName | Nome reduzido | FCFO | NOMEFANTA SIA | SA2 | A2_NREDUZ | ||||||
|
|
|
| [Se Type = 'Customer'] PagRec=1 Senão se Type = 'Vendor' PagRec=2 Senão | |||||||
|
|
|
| [Se EntityType = 'Person'] PessoaFisOuJur= F |
|
|
| ||||
|
|
|
| [Se RegisterSituation = 'Active'] |
|
|
| ||||
|
|
|
| [Se Id[Name]= CPF'] ou Id[Name]= CNPJ'] CGCCFO=1 |
|
| |||||
Address.Addre ss | Nome da rua | FCFO | RUA | Address.Address | SA2 | A2_END | |||||
Address.Numb er | Numero | FCFO | NUMERO | Address.Number | SA2 | A2_NR_END | |||||
Address.Compl ement | Complemento | FCFO | COMPLEMEN TO | Address.Complem ent | SA2 | A2_COMPLEM | |||||
Address.City.Ci tyInternalId | Código do município | FCFO | CODMUNICIP IO | Address.City.CityI nternalId | SA2 | cCodEst + A2_COD_MUN | |||||
Address.City.Ci tyDescription | Nome cidade | FCFO | CIDADE | SA2 | A2_MUN | ||||||
Address.District | Bairro | FCFO | BAIRRO | SA2 | A2_BAIRRO | ||||||
Address.State. StateInternalId | Codigo do estado | FCFO | CODETD | SA2 | A2_EST | ||||||
Address.State. StateDescriptin | Descrição do estado | FCFO | DESCETD | SX5 | X5_DESCRI | ||||||
Address.Countr y.CountryIntern alId |
|
|
|
|
| ||||||
Address.Countr y.CountryDescr iption |
|
|
|
|
| ||||||
Address.ZIPCo de | Cep | FCFO | CEP | SA2 | A2_CEP | ||||||
Address.POBo x | Caixa postal | FCFO | CAIXAPOSTA L | SA2 | A2_CX_POST | ||||||
ListOfCommuni cationInformati on.Communicat ionInformation. PhoneNumber |
|
|
| CommunicationInfor mation[1]/PhoneNu mber |
|
| |||||
ListOfCommuni cationInformati on.Communicat ionInformation. FaxNumber |
|
|
| CommunicationInfor mation[1]/FaxNumb er |
|
| |||||
ListOfCommuni cationInformati on.Communicat ionInformation. Email |
|
|
| CommunicationInfor mation[1]/E-mail [Primeira posição na lista de e-mail da mensagem] |
|
|
+ Notas:
Somente fornecedores devem ser enviados nessa integração.
As configurações iniciais desta integração criará um parâmetro chamado "RH_CLIFORAUTOINC" que irá definir se utiliza Auto incremento ou não para o campo "FCFO.CODCFO". Caso o parâmetro não seja "De auto incremento", a máscara do código do Cliente/Fornecedor deve ser configurada de acordo com a máscara do cliente/fornecedor enviada pelo Protheus:
Ex: "QQQQQQQQ". [Permite qualquer caractere limitado a 8 posições].
Caso o parâmetro seja de "auto incremento", a máscara deve ser definida como "" (vazio) e o parâmetro do financeiro "Usar código sequencial (se máscara for numérica)" deve ser marcado.
Exemplo de mensagem de entrada:
<TOTVSMessage>
<MessageInformation version="2.003">
<UUID>76111122-5165-2241-2012-021116129700</UUID>
<Type>BusinessMessage</Type>
<Transaction>CUSTOMERVENDOR</Transaction>
<StandardVersion>1.000</StandardVersion>
<SourceApplication>Protheus</SourceApplication>
<CompanyId>10</CompanyId>
<BranchId>113</BranchId>
<Product name="Protheus" version="12.1.1" />
<GeneratedOn>2014-04-11T19:30:05</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessEvent>
<Entity>CUSTOMERVENDOR</Entity>
<Event>upsert</Event>
</BusinessEvent>
<BusinessContent>
<InternalId>10|F00983</InternalId>
<CompanyId>10</CompanyId>
<CompanyInternalId>10|113</CompanyInternalId>
<Code>F00983</Code>
<ShortName>Fornecedor xpto</ShortName>
<Name>fornecedor erlon</Name>
<Type>Customer</Type>
<EntityType>Person</EntityType>
<RegisterSituation>Active</RegisterSituation>
<GovernmentalInformation>
<Id name="CPF">908094166-20</Id>
</GovernmentalInformation>
<Address>
<Address>Rua Santos</Address>
<Number>907</Number>
<Complement>ap 201</Complement>
<City>
<CityInternalId>1</CityInternalId>
<CityDescription>Belo Horizonte</CityDescription>
</City>
<District>Jardim America</District>
<State>
<StateInternalId>MG</StateInternalId>
<StateDescription>Minas Gerais</StateDescription>
</State>
<Country>
<CountryInternalId>Br</CountryInternalId>
<CountryDescription>Brasil</CountryDescription>
</Country>
<ZIPCode>30421386</ZIPCode>
<POBox>24533</POBox>
</Address>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage>
Centro de Custo
Identificador da Mensagem: CostCenter
Versão: 2.000
Módulo RM: Contabilidade – Cadastro de Centro de Custo
Módulo Protheus: SigaCTB – Contabilidade Gerencial
Tipo de Envio: Síncrono
Mensagem Padrão | Descrição | RM | Protheus | |||||
Tabela | Campo | Valor | Tabela | Campo | Valor | |||
CompanyId | Código da empresa | GCCUSTO | CODCOLIGADA | cEmpAnt | ||||
Code | Código do Centro de Custo | GCCUSTO | CODCCUSTO | CTT | CTT_CUSTO | |||
|
|
|
| |||||
CODCCUSTO |
|
| cEmpAnt | xFili al("CTT") | CTT_CUSTO | |||
|
|
| ATIVO |
|
|
| ||
Name | GCCUSTO | NOME | CTT | CTT_DESC01 | ||||
ShortCode | Código do centro de custo reduzido | GCCUSTO | CODREDUZID O | CTT | CTT_RES |
Notas:
As configurações iniciais desta integração criará um parâmetro chamado "RH_ CENTROCUSTOAUTOINC" que irá definir se utiliza Auto incremento ou não para o campo "GCCUSTO.CODCCUSTO". Caso o parâmetro não seja "De auto incremento", a máscara do código do Centro de custo deve ser configurada de acordo com a máscara do centro/custo enviada pelo Protheus: Ex: "QQQQQQQQ". [Permite qualquer caractere limitado a 8 posições].
Caso o parâmetro seja "De auto incremento", o Código do Centro de Custo no RM será gerado a partir da tabela GAUTOINC, sempre ignorando o código informado na mensagem única. Nesse caso, o parâmetro "Máscara do Centro de Custo" deve ser preenchido como "QQQQQQQ" [qualquer caractere].
Exemplo de mensagem de entrada:
<TOTVSMessage>
<MessageInformation version="2.000">
<UUID>59e9fed1-45ac-41a2-bd8b-12c990eb2d58</UUID>
<Type>BusinessMessage</Type>
<Transaction>COSTCENTER</Transaction>
<StandardVersion>1.000</StandardVersion>
<SourceApplication>Protheus</SourceApplication>
<CompanyId>10</CompanyId>
<BranchId>113</BranchId>
<Product name="Protheus" version="12.1.1" />
<GeneratedOn>2014-04-11T19:30:05</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessEvent>
<Entity>COSTCENTER</Entity>
<Event>upsert</Event>
</BusinessEvent>
<BusinessContent>
<InternalId>10|04.4.9</InternalId>
<CompanyId>10</CompanyId>
<CompanyInternalId>10|113</CompanyInternalId>
<Code>04.4.9</Code>
<RegisterSituation>Active</RegisterSituation>
<Name>PDE</Name>
<ShortCode>04.4.9</ShortCode>
<SPED>true</SPED>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage>
Banco
Identificador da Mensagem: Bank
Versão: 2.000
Módulo RM: Financeiro – Cadastro de Banco
Módulo RM: Financeiro – Cadastro de Agência
Módulo RM: Financeiro – Conta Corrente
Módulo RM: Financeiro – Conta Caixa
Módulo Protheus: SigaFIN - Financeiro
Tipo de Envio: Síncrono
Mensagem Padrão | Descrição | RM | Protheus | ||||||||
Tabela | Campo | Valor | Tabela | Campo | Valor | ||||||
Code | Número do banco | GBANCO | NUMBANCO | SA6 | A6_COD | ||||||
FCONTA | NUMBANCO | ||||||||||
FCXA | NUMBANCO | ||||||||||
Febraban | Número do banco oficial | GBANCO | NUMEROOFICIA L | SA6 | A6_NUMBCO | ||||||
|
|
|
| NUMBANCO |
|
| cEmpAnt | xFilial( "SA6") | A6_COD | ||
A6_AGENCIA | A6_NUMCON | ||||||||||
Name | Nome banco | GBANCO | NOME | SA6 | A6_NOME | ||||||
ShortName | Nome reduzido | GBANCO | NOMEREDUZID O | SA6 | A6_NREDUZ | ||||||
|
| GAGENCIA | NUMAGENCIA |
|
| ||||||
FCONTA | NUMAGENCIA | ||||||||||
FCXA | NUMAGENCIA | ||||||||||
Agency/Nam e |
|
|
| Concatenção de : "Agencia: "+ Agency/Number |
|
| |||||
Agency/Addr ess/Number | Número do endereço da agência |
|
|
| |||||||
Agency/Addr ess/Complem ent |
|
|
|
| |||||||
Agency/Addr ess/City/Desc ription |
|
|
|
|
| ||||||
Agency/Addr ess/State/Co de |
|
|
|
|
| ||||||
Agency/Addr ess/District | Bairro | GAGENCIA | BAIRRO | SA6 | A6_BAIRRO | ||||||
Agency/Addr ess/ZIPCode | Cep | GAGENCIA | CEP | SA6 | A6_CEP | ||||||
Agency/Cont actInformatio n/ Comunication Information/P honeNumber |
|
|
|
|
| ||||||
Agency/ ListOfAccount | Empresa | FCONTA | CODCOLIGADA | cEmpAnt | |||||||
/Account | FCXA | CODCOLIGADA | |||||||||
|
| FCONTA | NROCONTA |
|
| ||||||
FCXA | CODCXA | ||||||||||
FCXA | NROCONTA | ||||||||||
|
|
|
| Concatenação de: "Conta Caixa – ", Number |
| ||||||
Agency/ ListOfAccount |
|
|
|
| |||||||
Agency/ ListOfAccount |
|
|
|
|
Notas:
O Banco, Agência, Conta Corrente e Conta Caixa devem ser cadastrados no BackOffice Protheus e sincronizados para o RM. O BackOffice Protheus possui apenas uma tabela que contém todas as informações Código do Banco, Nome, Agência, Conta, entre outros.
Agência é um anexo da visão de Banco, assim como Conta Corrente é um anexo da visão de Agência. Na Linha RM são tabelas independentes: Banco (GBANCO), Agência (GAGENCIA), Conta Corrente (FCONTA) e Conta Caixa (FCXA). Com isso, a exclusão da entidade banco no Protheus, reflete na exclusão de uma Conta caixa, conta, agencias e banco no Lado RM.
As configurações iniciais desta integração criará um parâmetro chamado "RH_ CONTACAIXAAUTOINC" que irá definir: Se desmarcado: O Código da "Conta / Caixa" no RM será sempre o número da conta bancária enviada na mensagem;
Se marcado: O Código da conta caixa no RM será um valor a partir da tabela GAUTOINC, sempre ignorando o número da conta bancária enviada na mensagem única.
Exemplo de mensagem de entrada:
<TOTVSMessage>
<MessageInformation version="2.000">
<UUID>11108840-8121-9118-9052-220423190777</UUID>
<Type>BusinessMessage</Type>
<Transaction>BANK</Transaction>
<StandardVersion>1.000</StandardVersion>
<SourceApplication>Protheus</SourceApplication>
<CompanyId>10</CompanyId>
<BranchId>113</BranchId>
<Product name="Protheus" version="12.1.1" />
<GeneratedOn>2014-04-11T19:30:05</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessEvent>
<Entity>BANK</Entity>
<Event>upsert</Event>
</BusinessEvent>
<BusinessContent>
<Code>877</Code>
<InternalId>877</InternalId>
<Name>Banco teste 1 </Name>
<ShortName>teste</ShortName>
<Febraban>877</Febraban>
<ListOfAgency>
<Agency>
<Number>0488</Number>
<Address>
<Number>877</Number>
<Complement>ap 201</Complement>
<City>
<Description>Itaguara</Description>
</City>
<State>
<Code>MG</Code>
</State>
<District>jardim america</District>
<ZIPCode>30421546</ZIPCode>
</Address>
<ContactInformation>
<CommunicationInformation>
<PhoneNumber>33845425</PhoneNumber>
</CommunicationInformation>
</ContactInformation>
<ListOfAccount>
<Account>
<Number>70</Number>
<CompanyId>10</CompanyId>
</Account>
</ListOfAccount>
</Agency>
</ListOfAgency>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage>
Natureza Financeira
Notas:
A mensagem única "FinancialNature _2_000" não será utilizada nessa integração. No RM a natureza financeira existe no rateio de centro de custo do lançamento financeiro (FlanRatCCu.CODNATFINANCEIRA) e na mensagem padrão a natureza financeira existe no lançamento financeiro (AccountPayableDocument.FinancialNatureInternalId). Sendo assim, não temos esse valor para enviar para o Protheus.
Será criado um parâmetro de integração chamado "RH_NATUREZAFINANCEIRADEFAULT" que deve ser preenchido manualmente com um valor de natureza financeira default a ser enviado para o Protheus na mensagem "AccountPayableDocument.FinancialNatureInternalId).
Moeda
Notas:
A mensagem padrão "Currency" não será utilizada nessa integração. O RH da RM trabalha sempre com a moeda real "R$". Portanto, não será enviado nenhum valor na mensagem "AccountPayableDocument.CurrencyInternalId". O Protheus automaticamente incluirá o valor "1" (moeda corrente do país) em caso de não envido da moeda.
Plano de Contas
Identificador da Mensagem: AccountantAccount
Versão: 2.000
Módulo RM: Contabilidade – Cadastro de Plano de Contas Contábil
Módulo Protheus: SigaCTB – Contabilidade Gerencial
Tipo de Envio: Síncrono
Mensagem Padrão | Descrição | RM | Protheus | |||||||
Tabela | Campo | Valor | Tabela | Campo | valor | |||||
CompanyId | Empresa | CCONTA | CODCOLIGADA | cEmpAnt | ||||||
CompanyIntern alId | Internal Id da empresa | CCONTA | CODCOLIGADA | Não se aplica. | ||||||
Code | Código da conta | CCONTA | CODCONTA | CT1 | CT1_CONTA | |||||
|
|
|
| CODCONTA |
|
| cEmpAnt | xFilial( "CT1") | CT1_CO NTA | |
| Código reduzido da conta |
|
| CT1 | CT1_RES | |||||
Description | Descrição da conta | CCONTA | DESCRIÇÃO | CT1 | CT1_DESC01 | |||||
|
|
|
| -Valor "1" no Protheus equivale valor "1" na RM |
|
|
| |||
|
|
|
| -Valor "1" no Protheus equivale valor "0" na RM |
|
|
| |||
|
|
|
| -Valor "1" no Protheus equivale valor "1" na RM |
|
|
|
Notas:
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 gravação. O mesmo não será utilizado pelo RM Labore.
A máscara parametrizada da conta contábil no RM 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.
Exemplo de mensagem de entrada:
<TOTVSMessage>
<MessageInformation version="2.000">
<UUID>11009901-2801-8089-0090-949098000290</UUID>
<Type>BusinessMessage</Type>
<Transaction>ACCOUNTANTACCOUNT</Transaction>
<StandardVersion>1.000</StandardVersion>
<SourceApplication>Protheus</SourceApplication>
<CompanyId>10</CompanyId>
<BranchId>113</BranchId>
<Product name="Protheus" version="12.1.1" />
<GeneratedOn>2014-04-11T19:30:05</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessEvent>
<Entity>ACCOUNTANTACCOUNT</Entity>
<Event>upsert</Event>
</BusinessEvent>
<BusinessContent>
<InternalId>10|1.1.1.1.369</InternalId>
<CompanyId>10</CompanyId>
<CompanyInternalId>10|113</CompanyInternalId>
<Code>1.1.1.1.369</Code>
<ShortCode>1.1.1.1.369</ShortCode>
<Description>Conta contábil teste</Description>
<PostingNature>0</PostingNature>
<AnalyticalOrSynthetic>2</AnalyticalOrSynthetic>
<ActiveOrInactive>2</ActiveOrInactive>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage>
Histórico Padrão
Identificador da Mensagem: AccountantDefaultHistory
Versão: 1.000
Módulo RM: Contabilidade – Cadastro de Histórico Padrão
Módulo Protheus: Não se aplica.
Tipo de Envio: Síncrono
Mensagem Padrão | Descrição | RM | Protheus | |||||||
Tabela | Campo | Valor | Tabela | Campo | Valor | |||||
CompanyId | Empresa | CHISTP | CODCOLIGADA | Não se aplica. | ||||||
DefaultHistor yCode | Código do histórico padrão | CHISTP | CODHISTP | Não se aplica. | ||||||
InternalId | Id de integração | CHISTP | CODCOLIGADA | CODHISTP | Não se aplica. | |||||
Description | Descrição | CHISTP | DESCRICAO | Não se aplica. |
Notas:
No primeiro momento não será implementada no lado do Protheus a sincronização via mensagem única das informações de histórico padrão.
No lado RM, a rotina já está preparada para recebê-la quando a mesma for implementada pela equipe Protheus.
Período Contábil
Identificador da Mensagem: AccountingCalender
Versão: 1.000
Módulo RM: Contabilidade – Parâmetros
Módulo Protheus: SigaCTB – Contabilidade Gerencial
Tipo de Envio: Síncrono
Mensagem Padrão | Descrição | RM | Protheus | |||||||||
Tabela | Campo | Valor | Tabela | Campo | Valor | |||||||
CompanyId | Empresa | CPARAM | CODCOLIGADA | cEmpAnt | ||||||||
CompanyInt ernalId | Internal Id da empresa |
|
| cEmpAnt | cFilAn t | |||||||
|
|
|
| 24 | 25 | ID = 24 (corresponde a linha da parametrização da dataInicio do período contábil) |
|
| ||||
|
|
|
| 24 | 25 | ID = 24 (corresponde a linha da parametrização da dataInicio do período contábil) |
|
|
| xF ilial("CTG") | CTG_CALE ND | CTG_E XERC |
InitialDate | Data inicial do período contábil | CPARAM | CODCOLIGADA | 24 | CTG | CTG_DTINI | ||||||
FinalDate | Data final do período contábil | CPARAM | CODCOLIGADA | 25 | CTG | CTG_DTFIM |
Notas:
No processo de integração, o lado 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.
Item Contábil
Identificador da Mensagem: AccountingItem
Versão: 1.000
Módulo RM: Contabilidade – Item Contábil
Módulo Protheus: SigaCTB – Contabilidade Gerencial
Tipo de Envio: Síncrono
Mensagem Padrão | Descrição | RM | Protheus | |||||
Tabela | Campo | Valor | Tabela | Campo | Valor | |||
CompanyId | Empresa | SITEMCONTABILPROTHEUS | CODCOLIGADA | |||||
CompanyInt ernalId | Internal Id da empresa |
|
| |||||
|
|
|
| |||||
|
|
|
| ITEMCONTABIL | ||||
Code | Código do Item Contábil | SITEMCONTABILPROTHEUS | ITEMCONTABIL | |||||
Description | Descrição do Item contábil | SITEMCONTABILPROTHEUS | DESCRICAO |
Notas:
Existem três pontos para visualizar os registros integrados de item contábil (Área e Linha de Negócio):
- Educacional / Educacional / Integrações / Protheus / Item Contábil;
- RH / Folha de Pagamento / Encargos / Contabilização – Cadastros / Item Contábil;
- RH / Folha de Pagamento / Encargos / Financeiro – Cadastros Financeiros / Item Contábil.
No intuito de evitar cadastros duplicados, e tornar possível utilizar as mesmas informações para mais de uma integração, foi padronizado para que ambos menus apontem para a mesma tela (Tela de item contábil do módulo Educacional)..
- Item contábil no módulo Educacional:
- Item contábil no módulo Folha de Pagamento:
Após recebimento, o Item Contábil (Área e Linha de Negócio) poderá ser vinculado ao Funcionário, na Seção, e no Agrupamento de Contas por meio do lookup disponibilizado nas respectivas telas.
RM / Folha de Pagamento / Administração de Pessoal / Funcionários:
Na tela de cadastro de Funcionários acessar: Rotinas Mensais/Anuais – Dados Contábeis / Dados Contábeis – Item Contábil.
RM / Folha de Pagamento / Administração de Pessoal / Seções:
Na tela de cadastro de Seção acessar: Dados Contábeis / Item Contábil:
RM / Folha de Pagamento / Encargos / Contabilização – Cadastros / Cadastros Contábeis / Agrupamento de Contas:
Na tela de cadastro do Agrupamento de Contas: Item Contábil (Área e Linha de Negócio).
|
Exemplo de mensagem de entrada:
<TOTVSMessage>
<MessageInformation version="1.000">
<UUID>08648e54-c7b0-e0ca-dbb7-fa1953f6a91d</UUID>
<Type>BusinessMessage</Type>
<Transaction>ACCOUNTINGITEM</Transaction>
<StandardVersion>1.000</StandardVersion>
<SourceApplication>P12_INTXX</SourceApplication>
<CompanyId>T1</CompanyId>
<BranchId>D MG 01</BranchId>
<Product name="PROTHEUS" version="12" />
<GeneratedOn>2016-08-24T11:34:10</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessEvent>
<Entity>Departament</Entity>
<Event>upsert</Event>
<Identification>
<key name="InternalID">T1|D MG 01 |600000003</key>
</Identification>
</BusinessEvent>
<BusinessContent>
<CompanyId>T1</CompanyId>
<BranchId>D MG 01</BranchId>
<CompanyInternalId>T1|D MG 01</CompanyInternalId>
<Code>600000003</Code>
<InternalID>T1|D MG 01 |600000003</InternalID>
<Description>ITCTB ANLT 600000003</Description>
<Classe>2</Classe>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage>
Classe de Valor
Identificador da Mensagem: ClassValue
Versão: 1.000
Módulo RM: Contabilidade – Classe de Valor
Módulo Protheus: SigaCTB – Contabilidade Gerencial
Tipo de Envio: Síncrono
Mensagem Padrão | Descrição | RM | Protheus | |||||||
Tabela | Campo | Valor | Tabela | Campo | Valor | |||||
CompanyId | Empresa | SCLASSEVALORPROTHEUS | CODCOLIGADA | |||||||
CompanyInt ernalId | Internal Id da empresa | SCLASSEVALORPROTHEUS |
| |||||||
|
| SCLASSEVALORPROTHEUS |
| |||||||
|
| SCLASSEVALORPROTHEUS |
| IDCLASSEVALOR | ||||||
Code | Código da Classe de Valor | SCLASSEVALORPROTHEUS | IDCLASSEVALOR | |||||||
Name | Descrição da Classe de Valor | SCLASSEVALORPROTHEUS | DESCRICAO | |||||||
RegisterSituation | Status | SCLASSEVALORPROTHEUS | STATUS | |||||||
Class | Tipo | SCLASSEVALORPROTHEUS | TIPO |
Exemplo de mensagem de entrada:
<TOTVSMessage>
<MessageInformation version="1.000">
<UUID>ef20b823-0c55-c21b-925d-62fd37fd6a38</UUID>
<Type>BusinessMessage</Type>
<Transaction>CLASSVALUE</Transaction>
<StandardVersion>1.000</StandardVersion>
<SourceApplication>P12_INTXX</SourceApplication>
<CompanyId>T1</CompanyId>
<BranchId>D MG 01</BranchId>
<Product name="PROTHEUS" version="12" />
<GeneratedOn>2016-08-23T09:26:43</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessEvent>
<Entity>ClassValue</Entity>
<Event>upsert</Event>
<Identification>
<key name="InternalId">T1|D MG 01 |700000001</key>
</Identification>
</BusinessEvent>
<BusinessContent>
<CompanyId>T1</CompanyId>
<BranchId>D MG 01</BranchId>
<CompanyInternalId>T1|D MG 01</CompanyInternalId>
<Code>700000001</Code>
<Name>CLVL ANLT 700000001</Name>
<Class>2</Class>
<RegisterSituation>Active</RegisterSituation>
<InternalId>T1|D MG 01 |700000001</InternalId>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage>
Lançamentos Financeiros
Identificador da Mensagem: AccountPayableDocument
Versão: 2.002
Módulo RM: Financeiro – Lançamentos Financeiros
Módulo Protheus: SigaFIN - Financeiro
Tipo de Envio: Síncrono
Mensagem Padrão | Descrição | RM | Protheus | ||||||||||||
Tabela | Campo | Valor | Tabela | Campo | Valor | ||||||||||
|
|
|
| I DFINANC |
|
| cEmpAnt | xFilial( 'SE2') | E2_PRE FIXO | E2_NUM | E2_PARCELA | E2_TIPO | E2_F ORNECE | E2_L OJA | |
CompanyId | Empresa | PFINANCEIRO | CODCOLIGADA | cEmpAnt | |||||||||||
CompanyInte rnalId | Enteral Id da coligada | PFINANCEIRO | CODCOLIGADA | cEmpAnt | xFili al('SE2') | ||||||||||
BranchId | Filial | PFINANCEIRO | CODFILIAL | xFilial('SE2') | |||||||||||
Origin | Código do sistema | PFINANCEIRO | ORIGEM | ||||||||||||
DocumentNu mber | Número do título | PFINANCEIRO | NUMERODOCU MENTO | SE2 | E2_NUM | ||||||||||
DocumentParcel | Parcela do documento | PFINANCEIRO | PARCELA | ||||||||||||
DocumentTyp eCode | Tipo do título | PFINANCEIRO | CODCOLIGADA | CODTDO | SE2 | E2_TIPO | |||||||||
VendorCode | Código do Cliente/Fornecedor | PFINANCEIRO | CODCFO | ||||||||||||
VendorInternalId | Internal Id de Cliente/Fornecedor | PFINANCEIRO | CODCOLCFO | CO DCFO |
|
| cEmpAnt | xFilial( 'SA2') | E2_FOR NECE | E2_LOJ A | |||||
IssueDate | Data da Emissão | PFINANCEIRO | DATAEMISSAO | ||||||||||||
DueDate | Data de vencimento | PFINANCEIRO | DATAVENCIMEN TO | SE2 | E2_VENCTO | ||||||||||
| Data de vencimento |
| DATAVENCIMEN TO | SE2 | E2_VENCRE A | ||||||||||
NetValue | Valor Orignal | PFINANCEIRO | VALORORIGINAL | SE2 | E2_VALOR | ||||||||||
GrossValue | Valor Original | PFINANCEIRO | VALORORIGINAL | ||||||||||||
CurrencyCode | Código da Moeda | PFINANCEIRO | CODMOEVALORORIGINAL | ||||||||||||
|
| Não será enviado nenhum valor. O Protheus automaticame nte incluirá o valor "1". | |||||||||||||
|
|
| Natureza financeira gravada no parâmetro "RH_NATUREZA FINANCEIRADEF AULT" |
|
|
|
| xFilial("SED") | E 2_NATUREZ | ||||||
Apportionmen tDistribution/ Apportionmen t/ CostCenterInternalId |
|
|
| CODCCUSTO | |||||||||||
Apportionmen tDistribution/ Apportionmen t/ CostCenterCode | Código do Centro de Custo |
|
| ||||||||||||
Apportionmen tDistribution/ Apportionmen t/ ProjectInternalId |
|
|
| IDPRJ | |||||||||||
Apportionmen tDistribution/ Apportionmen t/ TaskInternalId |
|
|
| IDTRF | |||||||||||
Apportionmen tDistribution/ Apportionmen t/ Value |
|
|
| ||||||||||||
Apportionmen tDistribution/ Apportionmen t/ AccountingItemCode |
|
|
| ||||||||||||
Apportionmen tDistribution/ Apportionmen t/ AccountingItemInternalId |
|
|
| IDITEMCONTABIL | |||||||||||
Apportionmen tDistribution/ Apportionmen t/ ClassValueCode |
|
|
| ||||||||||||
Apportionmen tDistribution/ Apportionmen t/ ClassValueInternalId |
|
|
| IDCLASSEVALOR |
Exemplo de mensagem de saída:
<TOTVSMessage>
<MessageInformation version="2.002">
<UUID>c0e2f361-2819-4e52-acaa-b602b0bb9e00</UUID>
<Type>BusinessMessage</Type>
<Transaction>ACCOUNTPAYABLEDOCUMENT</Transaction>
<StandardVersion>1.000</StandardVersion>
<SourceApplication>RM</SourceApplication>
<CompanyId>1</CompanyId>
<BranchId>1</BranchId>
<Product name="RM" version="12.1.11" />
<GeneratedOn>2016-06-23T19:28:10</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessEvent>
<Entity>ACCOUNTPAYABLEDOCUMENT</Entity>
<Event>upsert</Event>
</BusinessEvent>
<BusinessContent>
<InternalId>1|258</InternalId>
<CompanyId>1</CompanyId>
<CompanyInternalId>1</CompanyInternalId>
<BranchId>1</BranchId>
<Origin>RM</Origin>
<DocumentNumber>258</DocumentNumber>
<DocumentParcel />
<DocumentTypeCode>10</DocumentTypeCode>
<VendorCode>000000000001461</VendorCode>
<VendorInternalId>1|000000000001461</VendorInternalId>
<IssueDate>2016-06-20T00:00:00</IssueDate>
<DueDate>2016-12-31T00:00:00</DueDate>
<RealDueDate>2016-12-31T00:00:00</RealDueDate>
<NetValue>460</NetValue>
<GrossValue>460</GrossValue>
<CurrencyCode />
<CurrencyInternalId />
<FinancialNatureInternalId>1|14</FinancialNatureInternalId>
<ApportionmentDistribution>
<Apportionment>
<CostCenterInternalId>1|0335</CostCenterInternalId>
<CostCenterCode>0335</CostCenterCode>
<ProjectInternalId />
<TaskInternalId />
<Value>460</Value>
<AccountingItemCode/ >
<AccountingItemInternalId/>
<ClassValueCode />
<ClassValueInternalId/>
</Apportionment>
</ApportionmentDistribution>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage>
|
Notas:
Cadastros financeiros
Tipo de documento: as informações de "tipo de documento" devem ser cadastradas na tela abaixo e mapeadas manualmente no cadastro de "De/para" de acordo com os tipos de documentos correspondentes do Protheus.
Parâmetros: Parametrização dos lançamentos financeiros
Pasta [identificação]
Tipo Documento: Informação recuperada da tabela de "FTDO - tipos de documentos".
Cód.Fornecedor: Informação recuperada da tabela de "FCFO – cliente/fornecedor". Dados dessa tabela devem ser enviados pelo Protheus.
Pasta [parâmetros]:
Tipo contábil: esse campo ficará desabilitado pois a geração contábil do lançamento financeiro ficará sob responsabilidade do backOffice Protheus.
Global: esse campo ficará desabilitado pois os dados da conta caixa são enviados por coligada;
Conta caixa: Informação recuperada da tabela de "FCXA – conta caixa". Dados dessa tabela devem ser enviados pelo Protheus.
Tabelas opcionais: ficarão desabilitadas nesse tipo de integração visto que o Protheus não as utiliza.
Rateio do fluxo de caixa: esse campo ficará desabilitado. Será criado um parâmetro de integração para preenchimento de um default de natureza financeira.
Obs: Esse default será enviado para o Protheus. No RM a natureza financeira é gravada no rateio de centro de custo, e no Protheus essa informação fica no próprio lançamento.
Geração dos lançamentos financeiros
Usar Conta/caixa do cliente/Fornecedor: Essa opção ficará desabilitada, pois a conta caixa não é enviada para o cliente/fornecedor na mensageria padrão.
Conta caixa Global: Essa opção ficará desabilitada, pois a conta caixa é enviada por coligada.
Gerar lanctos bloqueados para alteração: Essa opção deve ser desabilitada, pois os lançamentos gerados para o Protheus não estarão bloqueados para alteração.
Gerar lanctos rateados por departamento: essa opção ficará desabilitada, pois não haverá rateio por departamento;
Gerar lanctos rateados por centro de custo: em caso de integração com backoffice de terceiro, essa opção sempre ficará habilitada
Tabelas opcionais: as tabelas opcionais ficarão desabilitadas.
Integração dos lançamentos financeiros
Acesse RM.exe | segmento RH| aba Encargos| Grupo Financeiro | Lançamentos | Lançamentos (RM Labore).
Serão listados dados de financeiro gerados pela folha. Até esse momento as informações ainda não foram enviadas para o BackOffice de terceiro (diferentemente da integração da folha com o BackOffice da RM cujo dados são enviados automaticamente). Ao executar o processo de "Integração financeira com outros BackOffice", as informações de financeiro geradas pela folha serão enviadas automaticamente para o BackOffice conforme configuração da mensagem única.
O status do processamento da mensagem poderá ser consultado no anexo "Informações de processamento" conforme figura abaixo.
Lançamentos Contábeis
Identificador da Mensagem: AccountingEntry
Versão: 2.002
Módulo RM: Contabilidade – Lançamentos Contábeis
Módulo Protheus: SigaCTB – Contabilidade Gerencial
Tipo de Envio: Síncrono
Mensagem Padrão | Descrição | RM | Protheus | ||||||||||||
Tabela | Campo | Valor | Tabela | Campo | Valor | ||||||||||
CompanyId | Empresa | PCONTABIIZACAO | CODCOLIGADA | cEmpAnt | |||||||||||
BranchId | Filial | PCONTABILIZACAO | CODFILIAL | cFilAnt | |||||||||||
CompanyInt ernalId | Internal Id da empresa | PCONTABILIZACAO | CODCOLIGADA | Não se aplica. | |||||||||||
OriginCode | Código do Sistema de Origem | PCONTABILIZACAO | ORIGEM | ||||||||||||
PeriodStart Date | Data inicial do período contábil | PCONTABILIZACAO |
|
|
| ||||||||||
PeriodoEnd Date | Data final do período contábil | PCONTABILIZACAO |
| CT2 | CT2_DATA | ||||||||||
BatchNumb er | Código do lote contábil | PCONTABILIZACAO | CODLOTE | CT2 | CT2_LOTE | ||||||||||
|
|
|
| Rh da Rm não tem essa informação no cabeçalho dos lançamentos contábeis. |
|
| |||||||||
|
|
|
| CODLOTE |
|
| cEmpAnt | xFilial ("CT2") | CT2_D ATA | CT2_LOT | CT2_SBLOTE | CT2_DOC | |||
|
| Será enviado um auto-incromento contendo número da linha da partida. |
|
|
|
| |||||||||
|
| ItemType = 3 [ partida dobrada] ItemType = 2 [ partida de crédito] ItemType = 1 [ partida de débito] |
|
|
|
| 1=Debito 2=Credito 3=Partida Dobrada 4=Cont.Hist 5=Rateio 6=Lcto Padrao | ||||||||
|
|
|
| IDPARTIDA | cEmpAnt | xFilial( "CT2") | CT2_DA TA | CT2_LOTE | CT2_SBLOTE | CT2_DOC | CT2 | ||||
Entries/Entr y/Movemen tDate | Data da partida contábil |
|
| CT2 | CT2_DATA | ||||||||||
Entries/Entr y/DebitAcco untCode | Código da conta de débito |
|
| CT2 | CT2_DEBITO | ||||||||||
Entries/Entr y/DebitAcco untInternalI d | Internal Id da conta contábil de débito |
|
| DEBITO |
|
| cEmpAnt | xFilial ("CT1") | CT2_D EBITO | ||||||
Entries/Entr y/CreditAcc ountCode | Código da conta de crédito |
|
| CT2 | CT2_CREDIT | ||||||||||
Entries/Entr y/CreditAcc ountInternal Id | Internal Id da conta contábil de crédito |
|
| CREDITO |
|
| cEmpAnt | xFilial ("CT1") | CT2_C REDIT | ||||||
Entries | Valor do lançamento | PPARTIDA | VALOR | CT2 | CT2_VALOR | ||||||||||
|
| Não será enviada nenhuma informação nesse campo |
|
| |||||||||||
visto que a sincronização do histórico contábil ainda não foi implementada | |||||||||||||||
|
|
|
| As informações de complemento de histórico serão enviadas nesse campo. |
|
| |||||||||
Entries/Entr y/CostCent erCode | Centro de custo de débito |
|
| CT2 | CT2_CCD | ||||||||||
Entries/Entr y/CostCent erDebitInter nalId | InternalId do centro de custo de débito |
| CODCOLDEBIT O | CODCCUST O |
|
| cEmpAnt | xFilial ("CTT") | CT2_C CD | ||||||
Entries/Entr y/CostCent erCreditCod e | Centro de custo de crédito |
|
|
|
| ||||||||||
Entries/Entr y/CostCent erCreditInte rnalId | InternalId do centro de custo de crédito |
| CODCOLCRED ITO | CODCCUS TO |
|
| cEmpAnt | xFilial ("CTT") | CT2_C CC | ||||||
Entries/Entr y/AccountingItemDebitCode | Item Contábil para Conta de Debito |
| IDITEMCONTABIL | ||||||||||||
Entries/Entr y/AccountingItemDebitInternalId | InternalId de Item Contábil para Conta de Debito |
| CODCOLIGADA | IDITEMCONTABIL | |||||||||||
Entries/Entr y/AccountingItemCreditCode | Item Contábil para conta de Crédito |
| IDITEMCONTABIL | ||||||||||||
Entries/Entr y/AccountingItemCreditInternalId | Internal Id de Item Contábil para conta de Crédito |
| CODCOLIGADA | IDITEMCONTABIL | |||||||||||
Entries/Entr y/ClassValueDebitCode | Classe de Valor para Conta de Debito |
| IDCLASSEVALOR | ||||||||||||
Entries/Entr y/ClassValueDebitInternalId | Internal Id de Classe de Valor para Conta de Debito |
| CODCOLIGADA | IDCLASSEVALOR | |||||||||||
Entries/Entr y/ClassValueCreditCode | Classe de Valor para Conta de Crédito |
| IDCLASSEVALOR | ||||||||||||
Entries/Entr y/ClassValueCreditInternalId | Internal Id de Classe de Valor para Conta de Crédito |
| CODCOLIGADA | IDCLASSEVALOR | |||||||||||
Entries/Entr y/AccountantDefaultHistoryInternalId | Internal Id de Histórico Padrão |
| CODCOLIGADA | CODHISTP |
Exemplo de mensagem de saída:
<TOTVSMessage>
<MessageInformation version="2.002">
<UUID>0627d7a4-c11e-4cd5-9a79-975cdb447164</UUID>
<Type>BusinessMessage</Type>
<Transaction>ACCOUNTINGENTRY</Transaction>
<StandardVersion>1.000</StandardVersion>
<SourceApplication>RM</SourceApplication>
<CompanyId>1</CompanyId>
<BranchId>1</BranchId>
<Product name="RM" version="12.1.13.0" />
<GeneratedOn>2016-09-12T18:09:45</GeneratedOn>
<DeliveryType>Sync</DeliveryType>
</MessageInformation>
<BusinessMessage>
<BusinessEvent>
<Entity>ACCOUNTINGENTRY</Entity>
<Event>upsert</Event>
</BusinessEvent>
<BusinessContent>
<InternalId>1|9999999</InternalId>
<BranchId>1</BranchId>
<CompanyInternalId>1|1</CompanyInternalId>
<CompanyId>1</CompanyId>
<OriginCode>P</OriginCode>
<PeriodStartDate>2016-08-16T00:00:00</PeriodStartDate>
<PeriodoEndDate>2016-08-16T00:00:00</PeriodoEndDate>
<BatchNumber>9999999</BatchNumber>
<Document />
<Entries>
<Entry>
<Item>1</Item>
<ItemType>1</ItemType>
<EntryNumber>1|6831</EntryNumber>
<MovementDate>2016-08-16T00:00:00</MovementDate>
<DebitAccountCode>6.2.1.01.01</DebitAccountCode>
<DebitAccountInternalId>1|6.2.1.01.01</DebitAccountInternalId>
<CreditAccountCode />
<EntryValue>300</EntryValue>
<ComplementaryHistory>COMPLEMENTO HST EVENTO</ComplementaryHistory>
<CostCenterCode>5000</CostCenterCode>
<CostCenterDebitInternalId>1|5000</CostCenterDebitInternalId>
<CostCenterCreditCode />
<AccountingItemDebitCode>23</AccountingItemDebitCode>
<AccountingItemDebitInternalId>1|23</AccountingItemDebitInternalId>
<AccountingItemCreditCode>23</AccountingItemCreditCode>
<AccountingItemCreditInternalId>1|23</AccountingItemCreditInternalId>
<ClassValueDebitCode>15</ClassValueDebitCode>
<ClassValueDebitInternalId>1|15</ClassValueDebitInternalId>
<ClassValueCreditCode>15</ClassValueCreditCode>
<ClassValueCreditInternalId>1|15</ClassValueCreditInternalId>
<AccountantDefaultHistoryInternalId>1|00001</AccountantDefaultHistoryInternalId>
</Entry>
<Entry>
<Item>2</Item>
<ItemType>2</ItemType>
<EntryNumber>1|6832</EntryNumber>
<MovementDate>2016-08-16T00:00:00</MovementDate>
<DebitAccountCode />
<CreditAccountCode>6.2.1.01.02</CreditAccountCode>
<CreditAccountInternalId>1|6.2.1.01.02</CreditAccountInternalId>
<EntryValue>300</EntryValue>
<ComplementaryHistory>Teste Teste</ComplementaryHistory>
<CostCenterCode />
<CostCenterCreditCode>5000</CostCenterCreditCode>
<CostCenterCreditInternalId>1|5000</CostCenterCreditInternalId>
<AccountingItemDebitCode>23</AccountingItemDebitCode>
<AccountingItemDebitInternalId>1|23</AccountingItemDebitInternalId>
<AccountingItemCreditCode>23</AccountingItemCreditCode>
<AccountingItemCreditInternalId>1|23</AccountingItemCreditInternalId>
<ClassValueDebitCode>15</ClassValueDebitCode>
<ClassValueDebitInternalId>1|15</ClassValueDebitInternalId>
<ClassValueCreditCode>15</ClassValueCreditCode>
<ClassValueCreditInternalId>1|15</ClassValueCreditInternalId>
</Entry>
</Entries>
</BusinessContent>
</BusinessMessage>
</TOTVSMessage>
Notas:
A informação do "Código do Lote" [BatchNumber] será utilizada como identificador do lote contábil enviado para o Protheus e para o correto recebimento o RM deverá envia-lo com tamanho máximo de 8 caracteres.
Para garantir a integridade dos dados no Protheus já que o processo de contabilização no RM Labore poderá ser executado diversas vezes, será enviada uma mensagem do RM Labore para o Protheus excluir todos os registros contábeis do lote (somente em caso de já existir um mapeamento para o lote em questão no lado RM), e somente após isso, ocorrerá o envio das mensagens de inclusão de lançamentos. Caso ocorra algum erro no envio de algum pacote contábil, o Rm enviará uma mensagem de exclusão do lote em questão.
IMPORTANTE: as mensagens contendo os dados da contabilização serão enviadas de forma síncrona, ou seja, será enviada uma mensagem por vez. A mensagem seguinte somente será enviada se a mensagem anterior estiver com status de sucesso no seu processamento. Sendo assim, o receptor da mensagem deverá também trabalhar com o conceito de mensagem síncrona. Ou seja, antes dele enviar à resposta (ResponseMessage) a mesma deve ser processada pelo receptor. Isso para evitar que a mensagem de exclusão seja processada depois de alguma inserção já realizada.
Obs: As mensagens contábeis enviadas serão divididas em pacotes devido a uma limitação no recebimento das mesmas. Será criado um parâmetro no RM Labore para o usuário informar a quantidade de partidas que deverão ser enviadas em cada pacote.
O processo de envio de pacotes acontecerá no seguinte esquema:
- Será enviada uma mensagem de "exclusão de lote" (somente em caso de já existir uma sincronização do RM com o Protheus do lote em questão, ou seja, se existir um mapeamento para o lote na tabela de De/para). Essa mensagem possuirá somente informações do lote (cabeçalho). Nenhuma partida será enviada nessa mensagem. No campo "TotvsMessage/BusinessMessage/BusinessEvent/Event" será enviada a informação de "delete".
O Protheus deverá receber essa mensagem e excluir o lote e as partidas contábeis gravadas.
- Serão enviadas mensagens contendo os dados dos pacotes contábeis. Essas mensagens possuirão informações do lote (cabeçalho) e das partidas contábeis. No campo "TotvsMessage/BusinessMessage/BusinessEvent/Event" será enviada a informação de "upsert". Caso ocorra algum erro no envio de algum pacote, os pacotes restantes não serão mais enviados, e uma mensagem de exclusão de lote será enviada logo a seguir.
Cadastros contábeis
Alteração de Máscara: ficará desabilitada pois a alteração na máscara de conta será feita somente no backOffice.
Cadastros gerenciais: Todas as opções do menu "Cadastros gerenciais" serão desabilitadas, visto que, não faremos a integração gerencial com o BackOffice do Protheus.
Período para manutenção de lançamentos: Essa opção ficará desabilitada as datas dos períodos contábeis serão enviadas pelo Protheus;
Solicitação de tarefa e tarefas: ficará desabilitado para o usuário pois a manutenção de lotes será feita pelo Protheus.
Lançamentos (RM Saldus): ficará desabilitado pois os lançamentos contábeis gerados pela folha não serão integrados com o RM Saldus.
Lançamentos (RM Labore): ficará habilitado para visualização dos lançamentos contábeis gerados pelo processo de contabilização. Será incluído nessa visão um menu para disparar o "processo para exportação dos dados contábeis para os backoffice de terceiro".
Integrar lote contábil com o Saldus: ficará desabilitada pois os lançamentos contábeis não serão exportados para o RM saldus.
Integração dos lançamentos contábeis
Acesse RM.exe | segmento RH| aba Encargos| Grupo Contabilização | Lançamentos | Lançamentos(RM Labore).
Serão listados dados de lançamentos contábeis gerados pela folha. Até esse momento as informações ainda não foram enviadas para o BackOffice de terceiro (da mesma forma que acontece atualmente com a integração com o BackOffice da RM). Ao executar o processo de "Integração contábil com outros Backoffices", as informações de contabilidade geradas pela folha serão enviadas automaticamente para o BackOffice conforme configuração da mensagem única.
O status do processamento da mensagem poderá ser consultado no anexo "Informações de processamento" conforme figura abaixo.
Processos
Não se aplica.
Como fazer
Os passos para viabilizar a integração são:
- No Protheus, módulo Financeiro (SigaFIN), cadastrar os Fornecedores (SigaFIN > Atualizações > Cadastros > Fornecedores).
- No Protheus, módulo Financeiro (SigaFIN), cadastrar os Bancos (SigaFIN > Atualizações > Cadastros > Bancos).
- No Protheus, módulo Contabilidade Gerencial (SigaCTB), cadastrar um calendário contábil, as moedas contábeis e a amarração de Moeda x Calendário para o período contábil em questão.
- No Protheus, módulo Contabilidade Gerencial (SigaCTB), cadastrar o plano de contas (SigaCTB > Atualizações > Entidades > Plano de Contas).
- No Protheus, módulo Contabilidade Gerencial (SigaCTB), cadastrar os centros de custos (SigaCTB > Atualizações > Entidades > Custos > C Custo).
Para visualizar os arquivos XML gerados nos processos integrados, através do sistema Protheus, siga os passos abaixo:
- Acesse, no módulo configurador (SigaCFG), Ambiente > Schedule > Schedule > EAI.
- Selecione a mensagem da qual deseja visualizar o XML e clique na lupa, conforme abaixo:
Situações comuns
Não se aplica.
- Checklist de suporte da aplicação
Protheus:
Para verificar erros na integração:
- Verificar se o Protheus está na versão 11.80 ou superior.
- Verificar se as datas dos programas envolvidos estão de acordo com as especificadas nos pré-requisitos.
- Verificar se os webservices estão ativos e acessíveis (é possível testar acessando-o através de um navegador).
- Se a mensagem estiver no modo Assíncrono, verificar se os serviços de agendamento e se os agentes estão iniciados, conforme indicado no capítulo 6.1 (instalação).
Anexos
Não se aplica.
Novidades da Integração
Foi adaptado para que seja levado o Histórico Financeiro na Integração 1.0
- RM: Preenchido o campo 'Complemento de Histórico' e utilizando uma Fórmula para complemento de histórico que retorna o valor 2000.
- Protheus: Note que as informações informadas no RM, foram corretamente para o lançamento financeiro para o Protheus.
Quando Utilizado o Histórico Padrão é levado corretamente também.
Obs: Lembrando que o Protheus existe um limite de 40 caracteres.