Manual da Integração Rental x Backoffice RM - Mensagem Única EAI 2.0

Contexto de negócio

A integração Rental x Backoffice RM - que contempla o Rental - entrega aos clientes uma experiência diferenciada nos processos e controle da gestão de locação de equipamentos a partir da integração de diferentes setores da empresa. Garantindo uma comunicação eficiente e segura entre os departamentos, facilitando fluxos de informações e de rotinas operacionais e administrativas a integração reflete em uma otimização no processo de locação como um todo tornando-os processos mais eficientes, lucrativos e satisfatórios para os consumidores.

Por meio da integração os clientes podem usufruir da potencialidade do Rental e suas avançadas funcionalidades comunicando-se com o módulo BackOffice RM de maneira que o departamento de faturamento, estoque, financeiro e o setor comercial possam negociar e efetivar contratos de locações e o sistema de locações realize a gestão operacional das locações com mais agilidade e segurança.

Melhor controle das receitas, alocação e disponibilidade dos ativos, entregas e devoluções de equipamentos, proporcionando muito mais eficiência em todos os processos operacionais e administrativos da sua empresa;
Controle mais rigoroso e focado sobre a medição e execução dos seus contratos deixando o BackOffice se encarregar dos processos administrativos, legais, fiscais do negócio;
Indicadores de medições e execuções de contratos, receitas, produtividade, qualidade permitem uma visão mais ampla ao gestor facilitando identificação de processos que precisam ser melhorados dentro da empresa e a criação de estratégias para aumentar a rentabilidade do seu negócio alinhadas à meta da organização.

A integração do Rental com os produtos da linha TOTVS RM ficou muito mais simples e transparente. Com a atualização do Rental basta efetuar as devidas configurações e parametrizações em ambos módulos, Backoffice RM e Rental, para que a comunicação entre os sistemas esteja disponível imediatamente.

Por exemplo: fechou uma locação no Rental? A informação já pode ser usada para gerar o pedido de venda, notas ficais de remessa, retorno, fatura no TOTVS Backoffice – Linha RM. Tudo de forma rápida e sem complicação.

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

Rental - Sistema de locação de equipamentos através dos seguintes módulos:
- TOTVS Rental (SIGALOC): Módulo responsável pelo sistema de locação.
TOTVS Backoffice - Linha RM através dos seguintes módulos:
- TOTVS Gestão de Estoque, Compras e Faturamento (RM Nucleus): Módulo utilizado pelo cliente, sendo responsável pela manutenção dos cadastros (Unidade de medida, Produto, Local de Estoque, Condição de Pagamento, Movimentações [solicitação/pedido de venda], Gestão de estoque, integrações fiscais, financeiras e demais processos da empresa;
- TOTVS Gestão Financeira (RM Fluxus): Módulo utilizado pelo cliente, sendo responsável pela manutenção dos cadastros (Cliente/Fornecedor, Moedas), integrações financeiras e demais processos da empresa;
- TOTVS Gestão Contábil (RM Saldus): Módulo utilizado pelo cliente, sendo responsável pela manutenção dos cadastros (Centro de Custo) e demais processos da empresa;
- TOTVS Framework: Módulo responsável pelo framework de integração.

Carga de Dados
Posição de Estoque
Solicitação emissão nota fiscal ou fatura locação
Consulta de dados da nota fiscal ou fatura locação emitida no RM
Envio de dados de nota fiscal cancelada no RM
Processos de nota fiscal de retorno do equipamento

Para atender a demanda de clientes que possuem o TOTVS Backoffice - Linha RM e o Rental foi desenvolvida esta integração que possibilita a gestão das movimentações (produtos, estoque, posição de estoque, nota fiscal, nota remessa, nota retorno, fatura) a partir do Backoffice RM e a gestão de locação de equipamentos através do Rental sincronizando informações entre tais módulos utilizando a plataforma de integração baseada na Mensagem Única TOTVS.

Entidade	Origem	Processo	Destino	Observação
Cliente	RM	Cadastro	Protheus
Moedas	RM	Cadastro	Protheus
Condição de pagamento	RM	Cadastro	Protheus
Centro de Custo	RM	Cadastro	Protheus
Fornecedores	RM	Cadastro	Protheus
Vendedores	RM	Cadastro	Protheus
Produto	RM	Cadastro	Protheus
Unidade de medida	RM	Cadastro	Protheus
Local de Estoque	RM	Cadastro	Protheus
Consulta Estoque	RM	Consulta de saldo estoque	Protheus	Protheus consulta saldo de estoque dos produtos no RM
Pedido de venda	Protheus	Inclusão Pedido de Venda	RM	Possibilidade de parametrizar 4 tipos de movimentos diferentes
Nota de remessa (NFe)	RM	Rastreabilidade do Pedido	Protheus	Protheus consulta NF emitida no RM e inclui documento no Protheus
Nota de produto (NFe)	RM	Rastreabilidade do Pedido	Protheus	Protheus consulta NF emitida no RM e inclui documento no Protheus
Nota de fatura de locação	RM	Rastreabilidade do Pedido	Protheus	Protheus consulta NF emitida no RM e inclui documento no Protheus
Nota de serviço (NFSe)	RM	Rastreabilidade do Pedido	Protheus	Protheus consulta NF emitida no RM e inclui documento no Protheus
Nota de retorno (NFe)	RM	Rastreabilidade do Pedido	Protheus	Protheus consulta NF emitida no RM e inclui documento no Protheus

Durante o processo de consolidação de marcas, iniciado pela TOTVS, várias empresas diferentes foram adquiridas e com elas vários produtos passaram a compor o portfólio de ofertas disponível aos clientes. Esta expansão de ofertas permitiu que clientes de uma marca, antes limitados pelas opções com aquela “etiqueta”, pudessem agora compor o seu ambiente de TI utilizando produtos de origens diferentes (Exemplo: Backoffice RM x SigaMNT Protheus, TOTVS Gestão Hospitalar x EAI Datasul, TOTVS Educacional x Backoffice Protheus, TOTVS Folha de Pagamento RM x Backoffice Protheus, TOTVS Construção Gestão Imóveis (TCGI) x Backoffice Protheus, TOTVS Obras e Projetos x Backoffice Protheus ).

Esta mesma iniciativa já era uma prática comum nos clientes, porém todo o custo envolvido na integração entre estes aplicativos era visto pelo cliente como parte da escolha de utilizar-se de produtos de diferentes fornecedores. Uma vez que estes produtos passam a fazer parte de uma mesma oferta, os clientes TOTVS passam a demandar que estes produtos sejam naturalmente integrados. Isto significa que se antes o cliente arcava com o custo e o risco envolvido em uma integração (como corrupção da base de dados, por exemplo), ele agora entende que a TOTVS deve prover soluções já integradas, independente da origem dos produtos oferecidos.

Com o objetivo de padronizar as integrações com os produtos TOTVS, foi definida uma nova diretriz para os projetos de integração: A de que todos os produtos TOTVS devam trabalhar com uma mensagem XML ou REST/JSON único evitando, desta forma, o processo de transformação de mensagens. Neste cenário, teríamos o seguinte quadro:

Integrações > Rental x BackOffice RM - EAI 2.0 > worddavbea2b57302a5df2756b3b2bf0ae25638.png

Neste cenário, qualquer produto TOTVS trabalhará com o mesmo XML ou REST/JSON para uma mesma entidade, vamos supor que tenhamos um XML ou REST/JSON correspondente à mensagem de CLIENTES, ela poderá ser enviada para qualquer um dos produtos que suporte o recebimento desta entidade.
Uma vez que os vários produtos TOTVS terão um "idioma" comum (o XML único), as integrações entre estes produtos não exigirão mais que as mensagens sejam transformadas de um formato para outro. Com isto, será possível conectar diretamente dois produtos, sem a necessidade do TOTVS ESB, como no diagrama abaixo:

Integrações > Rental x BackOffice RM - EAI 2.0 > worddav8bbd00aae32dd670e6ebafc6a86e7c85.png

Além de questões referentes ao formato das mensagens, a mensagem única também torna uniforme o tratamento destas mensagens XML ou REST/JSON pelos aplicativos, principalmente no que diz respeito à capacidade de rastreamento.

Escopo

O escopo deste projeto se restringe aos processos de integração com o Rental e os cadastros utilizados por estes.

Todos os processamentos de BackOffice se manterão no RM, sendo eles a geração de escrituração, relatórios, emissão de notas fiscais e outros.

Transações/Entidades/Mensagens únicas

Segue abaixo tabela com informações sobre as entidades trafegadas na integração.

Método	ID	Descrição	Origem	Destino	Mensagem Única	Versão da Mensagem	Observação
Cadastros	01	Cliente/Fornecedor	RM	Rental	CustomerVendor	2.003
	02	Moeda	RM	Rental	Currency	2.001
	03	Unidade de Medida	RM	Rental	UnitOfMeasure	2.000
	04	Produto	RM	Rental	Item	4.005
	05	Local de estoque	RM	Rental	WareHouse	1.000
	06	Vendedor	RM	Rental	Seller	2.001
	07	Condição de pagamento	RM	Rental	PaymentCondition	3.000
	08	Centro de custo	RM	Rental	CostCenter	2.000
Processos
	09	Pedido de venda	TOTVS Rental	RM	Order	3.002
	10	Consulta Saldos e Custos	TOTVS Rental	RM	StockLevel	1.001	TOTVS Rental solicita ao RM e o RM retorna com os dados solicitados
	11	Consulta rastreabilidade de pedidos e movimentações decorrentes	TOTVS Rental	RM	TraceAbilityOrder	1.000	TOTVS Rental solicita ao RM e o RM retorna com os dados solicitados
	12	Notifica Cancelamento de Nota Fiscal / Fatura de Locação	RM	Rental	CancelInvoiceNotify	1.000

Cadastros

Para esta integração todos os cadastros possuem sua origem no BackOffice RM sendo enviados ao Rental.

Cadastro de Cliente/Fornecedor

Identificador da Mensagem: CustomerVendor
Versão: 2.003
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos RM: https://tdn.totvs.com/x/Uh8ZE

Notas:

Os Clientes e Fornecedores devem ser cadastrados no Backoffice RM e sincronizados automaticamente para o Protheus através da mensagem única CustomerVendor.

Uma vez que o Cliente e Fornecedor são tratados na mesma mensagem (CustomerVendor), ao cadastrar um registro do tipo Ambos no RM é gerado no Protheus um registro em cada tabela, SA1 (Clientes) e SA2 (Fornecedor).

Mesmo que a empresa não utilize Cliente/Fornecedor global no RM, deve-se compartilhar a tabela referente no Protheus por empresa.

Para utilizar esta integração é premissa que o cadastro de Cliente\Fornecedor esteja parametrizado como Global, obrigatoriamente deve-se compartilhar a tabela referente no Protheus por empresa, para integrações oriunda do EAI 1.0. Para mais informações Conversão Cliente/Fornecedor para Global#-2077675666.

Cadastro de Moeda

Identificador da Mensagem: Currency
Versão: 2.001
Mandatário: Backoffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos RM: https://tdn.totvs.com/x/Wv8pE

Notas:

As Moedas devem ser cadastrados somente no Backoffice RM e sincronizados automaticamente para o Protheus através de mensagem única Currency. Serão integrados somente os dados dos registros do tipo Moeda, desconsiderando registros do tipo Índices.

O Protheus, por default, aceita no máximo 5 tipos de Moedas, portanto na carga de dados deverá ser filtrado as moedas que serão utilizadas.

O campo Código da Moeda é gerado pelo Protheus, uma vez que não existe o campo código no RM.

Cadastro de Unidades de Medida

Identificador da Mensagem: UnitOfMeasure
Versão: 2.000
Mandatário: Backoffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos RM: https://tdn.totvs.com/x/DYcpE

Notas:

As Unidades de Medida devem cadastrados somente no BackOffice RM e sincronizados automaticamente para o Protheus através de mensagem única UnitOfMeasure.

As unidades de medida referentes à Hora (H), Quilometragem (KM), Unidade (UN) e Litro (L) devem possuir o mesmo código tanto no RM quanto no Protheus.

Na base de dados do Protheus e do RM já existem unidades padrões, foi implementado no EAI 2.0 a compatibilidade dos cadastros, quando o RM for enviar para o Protheus caso exista a unidade esta será atualizada e criado o de-para automaticamente.

O campo Código da Unidade de Medida no PROTHEUS será gerado pelo Adapter, uma vez que este campo no RM tem tamanho de 5 caracteres, no PROTHEUS 2 caracteres e na mensagem única 6 caracteres.

Cadastro de Produto/Serviço

Identificador da Mensagem: Item
Versão: 4.005
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos RM: https://tdn.totvs.com/x/sBzHG

Notas:

Os Produtos/Serviços devem cadastrados somente no BackOffice RM e sincronizados automaticamente para o Protheus através de mensagem única Item.

As regras referente à esta entidade podem ser conferidas no documento de Integração de Produto/Serviço, é de suma importância o entendimento da regra definida neste documento.

Dentro do cadastro de produto na aba integrações deve estar marcado Disponível para Manutenção/Locação para que sejam integrados.

Cadastro de Local de Estoque

Identificador da Mensagem: Warehouse
Versão: 1.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/kkstE

Notas:

Os Locais de Estoque devem cadastrados somente no BackOffice RM e sincronizados automaticamente para o Protheus através de mensagem única Warehouse.

Caso o código do Local de Estoque no RM seja maior que 6 (seis) caracteres, no Protheus o código do local de estoque deverá ser parametrizado por auto-incremento.

Por padrão, o tamanho máximo da descrição do local de estoque no Protheus é de 20 caracteres. Para compatibilizar com o RM, acesse SIGACFG e na tabela NNR altere o campo NNR_DESCRI para ter o tamanho = 40.

Cadastro de Vendedor

Identificador da Mensagem: Seller
Versão: 2.001
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos RM: https://tdn.totvs.com/x/1ANZIQ

Notas:

Os vendedores devem ser cadastrados somente no BackOffice RM e sincronizados automaticamente para o Protheus através de mensagem única Seller.

Devem ser cadastrados na tabela Funcionários (TVEN)

Cadastro de Condição de Pagamento

Identificador da Mensagem: PaymentCondition
Versão: 3.000
Mandatário: Backoffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos RM: https://tdn.totvs.com/x/mYYpE

Notas:

As Condições de Pagamento devem ser cadastradas somente no Backoffice RM e sincronizados automaticamente para o Protheus através de mensagem única PaymentCondition.

O cadastro de condições de pagamento deve ser compatibilizado com as limitações do Protheus quanto aos tipos de período, que são mais bem especificadas na seção de mapeamento da mensagem, é de suma importancia o entendimento da regra definido neste documento. Acessar o Configurador do Protheus (SIGACFG) e na tabela SE4 alterar o tamanho do campo E4_COND para 100 caracteres

Cadastro de Centro de custo

Identificador da Mensagem: CostCenter
Versão: 2.000
Mandatário: BackOffice RM
Tipo de Envio: Síncrono
Mapeamento de Campos: http://tdn.totvs.com/x/w9b0E

Notas:

Os Centros de Custo devem ser cadastrados somente no BackOffice RM e sincronizados automaticamente para o Protheus através de mensagem única CostCenter.

Para manter a compatibilidade entre os sistemas, os campos Centro de Custo e Código Reduzido do Centro de Custo no Protheus deve ser alterado para tamanho de 20 caracteres, uma vez que no RM estes campos permitem até 25 caracteres.

Processos

Conforme descrito na seção de apresentação do escopo, o escopo da integração se restringe a alguns processos relacionados, ou que se iniciam, no TOTVS Rental mas que sejam de alçada, controle e manipulação no Backoffice, como integrações fiscais, financeiras ou controle de estoque. Abaixo são listados os processos integrados.

Solicitação de Emissão NF\Fatura - Pedido de venda

Tipo de Fluxo: Rental -> RM
Mensagem: Order
Versão: 3.002
Mapeamento de Campos: https://tdn.totvs.com/x/C0fQHw

Notas:

As Solicitações de Emissão de NF/Fatura (Pedido de Vendas) serão registradas no TOTVS Rental e enviadas para o Backoffice RM, via mensagem única Order.

Poderão ser utilizadas quatro tipos de solicitações: Solicitações de Emissão NF de Remesssa, Solicitações de Emissão de Fatura Locação, Solicitações de Emissão NFe e Solicitações de Emissão de NFSe.

Para cada tipo de solicitação deverá ser criado e parametrizado um tipo de movimento e este vinculado ao parâmetro do sistema.

Restrição do Processo:

Não é possível agrupar "n" solicitações para faturamento em uma NF/Fatura, ou seja, uma solicitação só é possível ser fatura para um movimento de NF/Fatura.

Ponto de Atenção:

O cadastro de bens não fazem partem do escopo desta integração, portanto os equipamentos devem ser cadastrados no Protheus.

Para emitir as NF de remessa de equipamentos deverá ser realizado o cadastro dos equipamentos com os seu respectivos valores.

Consulta de Saldos e Custos

Tipo de Fluxo: Rental -> RM

Mensagem: StockLevel

Versão: 1.001
Mapeamento de Campos: http://tdn.totvs.com/x/L5r6E

Notas:

A consulta dos saldos de estoque será realizada sempre que for necessário verificar a posição de estoque do produto.

Consulta Rastreabilidade de Pedido de Vendas

Tipo de Fluxo: Rental -> RM
Mensagem: TraceAbilityOrder
Versão: 1.000
Mapeamento de Campos: https://tdn.totvs.com/x/BQFAJQ

Notas:

O serviço de consulta de rastreabilidade de pedidos de vendas será utilizado pelo TOTVS Rental atravês da mensagem única TraceAbilityOrder. para consultar as notas fiscais geradas no BackOffice RM a partir das solicitações de emissão das notas fiscais ou faturas. Ao receber a mensagem o BackOffice RM com base nesta consulta , será retornado os dados da NF para o TOTVS Rental, atualizando o orçamento.

As séries utilizadas nos movimentos devem ter até 3 dígitos, para integrarem com o Totvs Rental.

Para que sejam enviados os dados da NF-e e NFS-e emitidas no RM para o Rental, deverá ser realizado o processo de emissão da NF eletrônica por completo no RM.

Para as NFS emitidas manualmente nos sites das Prefeituras, o tipo de movimento que registrar as informações da NF, deverá ser parametrizado com Integrado por Terceiro, conforme tela abaixo:

Integrações > Rental x BackOffice RM - EAI 2.0 > image-2024-11-27_12-16-44.png

Notifica Cancelamento de Nota Fiscal/Fatura de Locação

Tipo de Fluxo: RM -> Rental
Mensagem: CancelInvoiceNotify
Versão: 1.000
Mapeamento de Campos: Notifica Cancelamento de Nota Fiscal/Fatura

Notas:

Quando for executado o processo de Cancelamento de Movimento, caso o movimento seja Nota Fiscal e tenha como origem um Pedido de Venda gerado pelo TOTVS Rental, o BackOffice RM irá enviar ao TOTVS Rental a mensagem CancelInvoiceNotify, contendo os dados da nota fiscal cancelada. Os dados que serão enviados são: Data de emissão da NF, Número da NF Série da NF, Tipo da Nota (Entrada ou Saída).