Informações Gerais

Objetivo

Ajustar e criar novas mensagens únicas, relacionadas a controladoria, em prol de atender as necessidades na integração do backoffice Protheus com o software de gestão de hotelaria da Bematech, CMNet.

Definição da Regra de Negócio 

O backoffice Protheus será responsável pelo controle financeiro, fiscal e contábil das operações de hotelaria realizadas através do software CMNet.

Para tais fins, os seguintes processos serão integrados com o uso de mensagem única:

• Cadastro de cliente (pessoa física e jurídica, nacional e internacional).
• Cadastro de fornecedor (para empresa comissionada, nacional e internacional)
• Cadastro de vendedor (para empresa comissionada)
• Inclusão de recebimento antecipado (RA)
• Inclusão de provisionamento de reserva (PR a receber)
• Inclusão de adiantamento com cartão (CC / CD + NCC)
• Cancelamento de adiantamento
• Devolução de adiantamento
• Cancelamento de devolução de adiantamentos
• Alteração de valores provisionados em prol da reserva (alteração de PR a receber)
• Análise de crédito de empresas (cliente pessoa jurídica)
• Inclusão de bloco F100
• Cadastro de Produtos
• Inclusão de cupom fiscal
• Cancelamento de cupom fiscal
• Inclusão de recibo provisório de serviço (RPS)
• Cancelamento de RPS
• Redução Z
• Geração de Danfe sobre cupom
• Sincronização de RPS transmitida (envio dos números eletrônicos após transmissão ao SEFAZ)
• Cadastro de Comissões
• Faturas de Hotelaria
• Cancelamento de Faturas de Hotel
• Verificação da possibilidade de cancelamento de um título a receber
• Verificação da possibilidade de cancelamento de uma venda de varejo
• Verificação da possibilidade de cancelamento de uma fatura de hotel
  
  

Os itens marcados em negrito são processos do loja e não serão tratados nessa especificação.

Para que todos esses processos sejam adequadamente integrados, serão necessárias algumas melhorias nas rotinas de Controladoria e Loja. Esta especificação tratará apenas as alterações necessárias voltadas a controladoria.

O cadastro de cliente terá origem no sistema de hotelaria, ou seja, o Protheus irá apenas receber as informações. Essa rotina será utilizada para a integração dos cadastros de clientes do hotel.

Será necessário realizar as seguintes alterações relacionadas ao cadastro de clientes:

• Adicionar um tratamento para gerar o código do cliente automaticamente de forma sequencial, caso a integração com hotelaria esteja ativa. Para saber se a integração com hotelaria está ativa, será criado um novo parâmetro MV_INTHTL.
  
  

• Para gravação de clientes estrangeiros, será necessário adicionar uma nova tag na mensagem única de cliente (CUSTOMERVENDOR). Essa tag será utilizada para informar o tipo de cliente (Cons. Final, Revendedor, Exportação, etc). Para isso será necessário criar uma nova versão do XSD dessa mensagem (CustomerVendor_2.005) e deverá haver um tratamento no adapter (MATI030) para considerar essa tag apenas à partir dessa versão da mensagem. A nova tag será definida conforme abaixo:

• Atualmente o adapter de cliente não está gravando o código de país recebido corretamente. Isso deverá ser ajustado.
  
  

• Atualmente o adapter de cliente não está gravando o CPF/CNPJ recebido corretamente. Isso deverá ser ajustado.
  
  
• Criação de dois novos campos (AI0_CTEVEN e AI0_CTADT) na tabela de complementos de cliente (AI0), para definição de contas contábeis diferentes, uma para adiantamentos e outra para adiantamentos de eventos de hotel. Assim, quando um adiantamento é lançado no software de hotelaria e chega no Protheus, a contabilização do mesmo poderá ser feita conforme o tipo do adiantamento (verificando se é ou não de evento) e conforme a conta definida em um desses dois novos campos no cliente (correspondente ao tipo de adiantamento recebido).

O cadastro de fornecedor terá origem no sistema de hotelaria, ou seja, o Protheus irá apenas receber as informações. Essa rotina será utilizada para a integração dos cadastros de empresas comissionadas no hotel. Sempre que um cliente do tipo empresa comissionada for inserida no sistema de hotelaria, serão enviadas ao Protheus as mensagens de integração de Cliente, Fornecedor e Vendedor, exatamente nessa ordem. Isso se faz necessário para que seja possível, posteriormente, gerar o título de comissão a pagar para tal comissionado (vendedor).

Será necessário realizar as seguintes alterações relacionadas ao cadastro de fornecedores:

• Quando há o uso das integrações de Cliente de Fornecedor de forma simultânea em um ambiente, há um problema com as acentuações do cliente que será cadastrado. Esse problema está relacionado a codificação do XML que é passado do MATI020 (fornecedor) para o MATI030 (cliente). Por se tratar de duas rotinas utilizando uma mesma mensagem única (CUSTOMERVENDOR), nesse cenário descrito, o recebimento da mensagem sempre passará primeiro pelo adapter de fornecedor (mesmo sendo a mensagem de cliente). Portanto, ao chamar o adapter de cliente, através do adapter de fornecedor, deve-se decodificar o XML a ser passado para que não haja problema com a acentuação.
   

• Atualmente o adapter de fornecedor não está gravando o código de país recebido corretamente. Isso deverá ser ajustado.
  
  

• Adicionar um tratamento para gerar o código do fornecedor automaticamente de forma sequencial, caso a integração com hotelaria esteja ativa.
   

• Adicionar um tratamento no adapter para, caso seja integração com hotelaria, preencher o campo de natureza do cadastro de fornecedor, para uso nos títulos de comissão. A natureza a ser utilizada deverá ser lida em um dos seguintes novos parâmetros: MV_HTLNAPJ (para fornecedor pessoa jurídica) ou MV_HTLNAPJ (para fornecedor pessoa física).

O cadastro de vendedor terá origem no sistema de hotelaria, ou seja, o Protheus irá apenas receber as informações. Essa rotina será utilizada para a integração dos cadastros de empresas comissionadas no hotel. Um vendedor se faz necessário no Protheus para que seja possível gerar os títulos de comissão do mesmo.

Será necessário realizar a seguinte alteração relacionada ao cadastro de vendedores

• Incluir um tratamento para gravar as informações de comissão do vendedor (fornecedor associado e interface de comissão). Para isso será necessário criar uma nova versão do XSD dessa mensagem (Seller_2.000) e deverá haver um tratamento no adapter (MATI040) para considerar as duas novas tags. As novas tags serão definidas conforme abaixo: 

Será necessário realizar as seguintes alterações relacionadas ao cadastro de contas a receber:

• Incluir um tratamento no adapter (FINI040) para definir o prefixo do título através de um novo parâmetro, caso a integração com hotelaria esteja ativada. Para isso, será criado o novo parâmetro MV_HTLPREF.
  
  

• Incluir um tratamento no adapter (FINI040) para definir a natureza do título através de novos parâmetros que serão criados, caso a integração com hotelaria esteja ativada. Para isso serão criados os seguintes parâmetros:
  
  

1. 1. MV_HTLNARA – Natureza para títulos do tipo RA.
   2. MV_HTLNAPR – Natureza para títulos do tipo PR.
   3. MV_HTLNACC – Natureza para títulos do tipo CC.
   4. MV_HTLNACD – Natureza para títulos do tipo CD.
   5. MV_HTLNANC – Natureza para títulos do tipo NCC.
   6. MV_HTLNADH – Natureza para títulos do tipo R$. 
      
      

Para saber qual parâmetro deverá ser lido para definição da natureza, ao receber a mensagem de contas a receber (ACCOUNTRECEIVABLEDOCUMENT), deverá ser lida a tag de tipo de título (DocumentTypeCode) e à partir do tipo definido nessa tag, deve-se ler o parâmetro correto para a natureza.Caso o parâmetro esteja vazio, retornar uma mensagem informando que a natureza não foi informada corretamente nos parâmetros correspondentes. Exemplo: Se o tipo de documento for “RA”,  deve-se ler o parâmetro MV_HTLNARA para definir a natureza desse título.

• Corrigir o Adapter (FINI040) para tratar as tags <CustomerCode> e <StoreId> no recebimento da mensagem. Hoje essas tags não são consideradas. Isso será necessário para recebimento de um título em nome de uma administradora financeira, a qual será informada na mensagem com o código Protheus nas tags em questão, e não com o código interno na tag <CustomerInternalID>.
  
  

• Será necessário adicionar quatro novas tags na mensagem única de contas a receber (ACCOUNTRECEIVABLEDOCUMENT), para os seguintes propósitos:
  
  
  1. Receber o valor real do título, para tratamento de taxa de administradora em caso de título de cartão (crédito ou débito).
  2. Receber a NSU (número único para identificação da transação de cartão), que será utilizado para conciliação de cartão.
  3. Receber e enviar o número de conta hoteleira (numero da reserva). Essa conta é utilizada para amarrar todo o processo financeiro de uma reserva de hotel.
  4. Receber e enviar o tipo de conta hoteleira (avulsa, individual, grupo ou evento).
     
     

Para isso será necessário criar uma nova versão do XSD dessa mensagem (AccountReceivableDocument_2.006) e deverá haver um tratamento no adapter (FINI040) para considerar as três novas tags. As novas tags serão definidas conforme abaixo:

Será necessário criar uma nova mensagem única para realizar a análise de crédito dos clientes pessoa jurídica integrados ao backoffice e informar tais dados ao software de gestão hoteleira, para que o mesmo possa saber se um cliente tem crédito e se pode faturar contra o mesmo.

O novo adapter Protheus para essa rotina (FINMI060) adotará o processo já existente no backoffice (função MaAvalCred), que se baseia no grau de risco do cliente, na sua classe de crédito (informados no cadastro do cliente) e nos títulos que estão em aberto com pagamento atrasado. Após a análise, é determinado se o cliente possui crédito ou não e, sendo este o caso, é indicado o motivo através de um código (status): 01 – limite de crédito ultrapassado; 04 – validade do crédito expirada.

O envio dessa mensagem partirá do Protheus, através de tela (SIGAFIN > Miscelânea > Integrações > Análise de Crédito) ou através de um job agendado. A rotina deve ser preparada para trabalhar de ambas as maneiras. A função a ser executada por job terá a seguinte nomenclatura: FM060JOB. A mensagem a ser enviada será do tipo Event e conterá uma lista com todos os clientes (PJ) integrados e seus respectivos saldos e status de crédito. Após recebimento de tais dados, o software de gestão hoteleira deverá responder com a lista de clientes cujas análises foram lidas e processadas com sucesso.

A nova mensagem única se chamará CreditRiskAnalysis e terá a seguinte estrutura:

Definições técnicas do adapter para a análise de crédito

A lista a ser enviada deverá conter somente os clientes pessoa jurídica que tiveram alteração no seu status de crédito ou no seu saldo, desde a última execução de análise de crédito. Para controlar as modificações no status dos clientes deverá ser criada uma nova tabela (AI0) para registrar o status e o saldo de cada cliente no momento de uma execução.

A análise será feita pela MaAvalCred, baseada nos dados do cadastro do cliente e nos seus títulos no financeiro. Para essa função deverá ser enviado o valor a ser analisado, no caso de integração com hotelaria, esse valor é a soma dos valores das reservas (títulos a receber do tipo PR, que provisionam os valores das reservas) e dos títulos que estão em aberto no financeiro.

A MaAvalCred, após a análise, retorna se o crédito do cliente está liberado  (.T.) ou bloqueado (.F.). Além disso, disponibiliza o motivo de estar bloqueado (deve-se passar um parâmetro “por referência”, veja o cabeçalho da função no fatxfun). Será adotado o código “00” quando o crédito estiver liberado, pois a MaAvalCred não possui um código para este caso.

Procedimentos da análise de crédito:

1. Localizar na tabela “de – para” (XXF) os clientes cadastrados por integração, com o software de hotelaria, e obter seus códigos no backoffice
   
   
2. Para cada cliente localizado:
   
   1. determinar o valor em aberto (A1_SALDUP)
   2. determinar o limite de crédito estabelecido no seu cadastro (A1_LC)
      
      
   Os itens 3 e 4 apenas deverão ser executados caso a integração com hotelaria esteja ativada
   
   
3. Apurar o valor das reservas que o cliente possui no backoffice, ou seja, o valor total dos títulos provisórios (PR)
   
   
4. Acrescentar o valor das reservas ao valor em aberto.
   
   
5. Executar a MaAvalCred, passando o valor em aberto e o parâmetro “por referência” para obter o código do bloqueio do crédito.
   
   Caso a integração com hotelaria esteja ativada, os pedidos de venda não deverão ser considerados na análise de crédito. Para isso, existe um parâmetro a ser informado na função MaAvalCred.
   
   
   
6. Calcular o saldo do cliente: saldo = limite de crédito – valor em aberto.
   
   
7. Verificar os clientes cujas informações de crédito foram alteradas, ou seja, que tiveram o status de crédito ou saldo alterados. Para isso, seguir os seguintes passos:
   1. recuperar da tabela de controle (AI0) o saldo e o status de crédito anteriores;
   2. compará-los aos novos;
   3. caso haja alteração, registrá-la na tabela de controle (AI0), com status (AI0_INTEG) = “2” – não atualizado .
8. Criar uma lista com os clientes, cujas informações de crédito foram alteradas, contendo o saldo e o status (código do bloqueio) do crédito. Os possíveis valores de status são:
   
   
   • “00” – crédito liberado;
   • “01” – ultrapassa o limite de crédito;
   • “04” – data de vencimento do limite de crédito expirada.
     
     
9. Enviar a lista de clientes. Caso a lista (xml) seja muito extensa, dividi-la em partes e realizar múltiplos envios. Um exemplo desse tratamento pode ser visto no fonte CTBA102.
   
   

Após receber a análise de crédito, o software de gestão de hotelaria deverá processar os valores recebidos e devolver ao backoffice uma lista com os clientes cujas análises foram  lidas e processadas com sucesso. O adapter (FINMI060) deverá ser preparado para tratar a resposta recebida (response message). Para cada item da lista recebida, o backoffice deverá localizar o seu registro na tabela de controle (AI0) e marcar o seu status com “1” – integrado.

Considerações sobre o uso da MaAvalCred

1. Para que a análise seja executada, é necessário ativá-la, configurando o parâmetro MV_BLOQUEI.
2. O parâmetro MV_CREDCLI indica se a análise será feita considerando código do cliente / loja ou somente código do cliente.
3. Caso o cliente seja classificado com risco A, não é feita a analise e o crédito é considerado liberado.
4. Caso o cliente seja classificado com risco E, não é feita a analise e o crédito é considerado bloqueado.

Será necessário criar uma nova mensagem única para integrar os cadastros para o bloco F100 (Outros Documentos Pis Cofins – FISA048). Essa mensagem partirá do Newhotel PMS e será enviada ao Protheus, no intuito de informar ao backoffice os valores em aberto (sem documento fiscal gerado) dos consumos (serviços) relacionados aos “hóspedes na casa” no último dia do mês, para composição do registro F100 no Protheus para o SPED EFD.

O Adapter no Protheus será o fonte FISI048. A nova mensagem única terá a seguinte nomenclatura: OtherDocumentsF100 e terá a seguinte estrutura:

Quando um cliente efetua um pagamento, é gerado um recibo provisório de serviços (RPS). Posteriormente, esse RPS é transmitido ao SEFAZ e é gerada uma Nota Fiscal de Serviço Eletrônica (NFS-e), que possuí uma identificação numérica. Esse processo de transmissão é realizado através das rotinas padrões do backoffice Protheus, porém o software de gestão de hotelaria precisa ter conhecimento desse número da nota eletrônica gerada, afim de facilitar alguns processos gerenciais. Para maiores informações sobre a transmissão de RPS no Protheus, consulte o seguinte link: 

Visto isso, será necessário desenvolver uma nova mensagem única para que essa informação trafegue do Protheus ao software de hotelaria. A mensagem terá a seguinte nomenclatura: InvoiceTransfer e terá a seguinte estrutura: 

O envio dessa mensagem partirá do Protheus, através de tela (SIGAFIN > Miscelânea > Integrações > Envio de NFS-e transmitida, FINM061) ou através de um job agendado. A rotina deve ser preparada para trabalhar de ambas as maneiras. A função que será chamada via job terá a seguinte nomenclatura: FM061JOB. A mensagem a ser enviada será do tipo Event e conterá uma lista com todos os recibos (RPS) que foram transmitidos e seus respectivos números de nota eletrônica. Após recebimento de tais dados, o software de gestão hoteleira deverá responder com a lista de recibos cujas identificações de notas eletrônicas foram lidas e processadas com sucesso.

Os números de notas fiscais serão obtidos do TAF – Totvs Automação Fiscal, que registrará os RPS juntamente com as notas correspondentes, em uma nova tabela (FLY) para que o backoffice Protheus os envie ao software de hotelaria.

A tabela FLY, além dos dados das notas fiscais e RPS, terá um status (campo FLY_TRANSM), que indicará se número de nota fiscal eletrônica foi integrado ao software de hotelaria com sucesso.  0 – aguardando envio; 1 – enviado / recebido.

Alterações no TAF

O TAF será alterado (pela equipe responsável pelo produto) para que, após a geração da nota fiscal (transmissão do RPS), ela e o RPS sejam registrados  em uma tabela nova de controle desse processo (FLY). O registro será feito por uma rotina do módulo financeiro (a ser desenvolvida) que será executada pelo TAF.

No módulo financeiro deverá ser disponibilizada uma nova função – FinRegNFE – para registro do número da nota, através do TAF. Essa função deverá receber  três parâmetros, sendo eles: série do RPS, número do RPS e o número da nota fiscal. No registro, a função verificará se o RPS existe ou não e fará a ação correspondente (incluir ou alterar), marcando o status como 0 (zero) – aguardando envio.

Considerações para o adapter da mensagem – FINMI061

Após receber a relação de RPS / Número de NFS-e, o software de hotelaria  processará seus itens e devolverá ao backoffice uma lista RPS cujos números de nota eletrônica foram lidos e processados com sucesso. Portanto, o adapter (FINMI061) deverá ser preparado para tratar a resposta recebida (response  message), sendo que, para cada item da lista de RPS recebida, deverá ser localizado o registro  correspondente na tabela de controle (FLY) e marcado o seu status como 1 – enviado / recebido.

A tabela de controle (FLY) armazenará temporariamente os registros. Após serem integrados com sucesso, serão apagados “fisicamente” dessa tabela.

O fluxo da rotina deverá ser o seguinte:

1. Apagar os registros já processados pelo Newhotel (status 1). Os registros deverão ser apagados “fisicamente”, não apenas marcados como apagados, como normalmente é feito.
   
   
2. Enviar os registros existentes. Para isso, selecionar os registros que estejam com status em branco ou com 0.

Será necessário fazer uma alteração no adapter de movimentos bancários (FINI100) para ler a natureza financeira de um novo parâmetro (MV_HTLNAMB), caso a integração com hotelaria esteja em uso. 

Na hotelaria existe a possibilidade de uma empresa ter um contrato com o hotel, de forma a permitir que seus funcionários fiquem hospedados em um período e, ao fazer checkout, as despesas da estadia desse hóspede podem ser faturadas contra a empresa em questão, gerando títulos para recebimentos futuros dos valores referentes aos serviços e produtos consumidos (RPS e Cupons Fiscais). Ou seja, nesse exemplo o hóspede não paga nada ao sair do hotel e a empresa é quem paga isso em um momento futuro, conforme regras estabelecidas em seu contrato.

Esse processo precisará ser integrado ao Protheus, pois o mesmo gera títulos financeiros que estão associados a determinados Recibos Provisórios de Serviços (RPS) e Cupons Fiscais. Para isso, serão necessários os seguintes pontos:

• Criação de novas tabelas: FO8 - Cabeçalho da Fatura ,FO9 - Amarração da Fatura x Notas (RPS/Cupom) e FOA - Amarração da Fatura x Títulos a Receber;
• Criação de uma nova mensagem única para recebimento das informações de Faturas de Hotel (HotelInvoice);
• Criação de uma nova rotina de menu no Protheus (FINA791), para apenas visualização das informações de Faturas (Não haverá opção de Inclusão, Alteração e Exclusão no Protheus);
• Criação de um adapter para tratar o recebimento da mensagem única de Faturas (FINI791);
• Criação de novo parâmetro para definição de Natureza dos títulos gerados no processo de faturas de hotel: MV_HTLNAFT;

Detalhes técnicos:

• A rotina de faturas de hotelaria, no Protheus, será apenas para visualização dos registros e estará divida em três partes, conforme proposto no Protótipo 01 - Tela de Faturas de Hotelaria. As três partes são: Cabeçalho da Fatura (tabela FO8), Notas (Tabela FO9) e Títulos a Receber. Essa rotina deverá ser codificada em MVC;
  
  
• O adapter (FINI791) deverá ser codificado seguindo o padrão de gravação MVC com os modelos de dados da rotina FINA791, ao invés de utilizar ExecAuto. Também deverá ser utilizado a classe mais atual para manipulação de XML, tXmlManager, ao invés de XMLParser;
  
  
• Para criação dos títulos a receber da fatura, na mensagem trafegará apenas os valores e data de vencimento de cada título. Portanto, o adapter deverá complementar a chave para inclusão do título via ExecAuto da rotina FINA040, seguindo os seguintes critérios:
  
  
  • Prefixo: Pegar do parâmetro MV_HTLPREF;
  • Número: Será o número da Fatura (tag Code);
  • Parcela: Se houver apenas um título (na tag ListOfAccountReceivableInformation), poderá ficar em branco. Se houver mais de um título, então será um sequencial conforme o número de títulos. Ou seja, se houver três informações de títulos no XML, então haverá a parcela 01, 02 e 03, respectivamente.
  • Tipo: Pegar do parâmetro MV_HTLFT, que por padrão terá o valor FT (Fatura).
  • Natureza: Esse campo não faz parte da chave, mas o mesmo deverá ter seu valor definido através do parâmetro MV_HTLNAFT.
    
    
• Os títulos gerados no processo de faturas de hotel, deverão ser gravados com origem na rotina FINI791 (E1_ORIGEM = FINI791);
  
  
• Os títulos gravados no recebimento da mensagem de Fatura de Hotel, não terão seus IDs retornados na resposta do processamento dessa mensagem. O único InternalId que será retornado é o da própria fatura.
  
  
• Na visualização da tela deverá haver um grid com os títulos da fatura em questão. Para filtrar esses títulos, considerar a lógica de chave acima informada;
  
  
• O adapter possuirá apenas tratamentos para o recebimento da mensagem em questão, visto que o detentor da lógica de geração de faturas é o sistema de hotelaria (CMNet);
  
  
• Se uma fatura precisar ser alterada ou excluída, a mesma deverá ser cancelada e uma nova será incluída. Deverá ser enviado um novo numero de fatura.
  
  
• Criar uma função no adapter (FINI791) para encontrar a chave do registro de fatura de hotel no Protheus, à partir da chave externa recebida na mensagem.
  
  
• Criar uma função no adapter (FINI791) para criar o valor de InternalId com a chave da fatura no Protheus.
  
  
• Caso a tag HotelInvoiceCancellation esteja preenchida com '1' o sistema irá executar o processo de cancelamento de fatura, assim o sistema irá executar as seguintes operações:
  • O sistema irá excluir os títulos utilizando a execauto da rotina FINA040.
  • Caso todos os titulo tenham sido excluídos com sucesso, o sistema irá alterar o status da fatura como cancelado.
  • Caso o sistema não permita a exclusão dos títulos, a mensagem irá retornar o erro e não irá cancelar a fatura.
    

Faturas com comissão descontada:

Existe também a possibilidade de uma fatura ser gerada para um cliente que também é um comissionado no processo em questão. Exemplo: Um hóspede compra o serviço de hospedagem em um hotel através de uma agência de viagens. O hóspede é cliente da agência e paga para a mesma. A agência, por sua vez, paga ao hotel e, portanto, é cliente do hotel. Contudo, pelo fato da agência ter vendido o serviço do hotel ao hóspede, o hotel pagará uma comissão a essa agência.

Visto esse cenário, se imaginarmos que essa agência tem um contrato com o hotel para geração de faturas, o hotel pode gerar uma fatura já com o valor descontado da comissão que ele pagaria para a agência. Exemplo: A agência deve ao hotel R$ 1.000,00 que foram gastos em serviços de hospedagem e deve pagar R$ 100,00 de comissão para essa agência pois o hóspede que está usufruindo dos serviços de hospedagem, os adquiriu através da agência. No final da estadia do hóspede o hotel ao invés de gerar uma fatura de R$ 1.000,00 e uma comissão a pagar de R$ 100,00, gera apenas uma fatura de R$ 900,00 (1000 -100) para o cliente (agência) pagar. Ou seja, desconta a comissão na fatura.

Nesse caso, o cálculo de impostos da comissão que está sendo descontada não deixa de existir e precisaremos ter esse controle no backoffice. Para isso, a ideia é trafegar na mensagem de faturas (tag SalesChargeDiscount) o valor de comissão que foi descontado na fatura. Com essa informação, será feito um tratamento no adapter de fatura (FINI791) para gerar um contas a pagar e baixar o mesmo, representando a comissão que foi descontada e gerando os tratamentos de impostos padrão do Protheus, com base nos dados da natureza e fornecedor utilizados para tal título a pagar. Para definição da natureza e da chave do título a pagar a ser gravado, o adapter deverá seguir as seguintes regras:

• Prefixo: Pegar do novo parâmetro MV_HTLPREC, que por padrão terá o valor "CDF" (Comissão descontada em Fatura);
• Número: Será o número da Fatura (tag Code);
• Parcela: Poderá ficar em branco.
• Tipo: Pegar do novo parâmetro MV_HTLTCDF que por padrão terá o valor DP (Duplicata).
• Natureza: Esse campo não faz parte da chave, mas o mesmo deverá ter seu valor definido através do parâmetro MV_HTLNCPF ou MV_HTLNCPJ.

Para definir a natureza, será necessário fazer um tratamento no adapter para ver se o fornecedor (tag CustomerVendorInternalId) é pessoa física ou pessoa jurídica. Caso seja pessoa física, a natureza será definida conforme o valor do parâmetro 

MV_HTLNCPF. Caso seja pessoa jurídica, então o parâmetro que será utilizado é o MV_HTLNCPJ.

Detalhes da Mensagem (XSD):

Nome da Mensagem: HotelInvoice

Versão: 1.000

Tipo: Event

Estrutura:

Visto que quem possuí a regra de cálculo é o sistema de hotelaria, não será possível fazer o recálculo dos registro de comissão gerados por essa integração. Logo, deverá haver uma trava na rotina de Recalculo de Comissão (FINA440) para não permitir tal processo caso a origem da comissão seja integração (E3_ORIGEM = I). Também deverá haver uma trava para não permitir a alteração e exclusão de registros integrados através da rotina de manutenção de comissão (MATA490).

Nesta integração o detentor da regra de negócio para cálculo de comissões é o CMNet, que atende as regras especificas para a hotelaria. Portanto, o Protheus precisará estar preparado para receber essas comissões já calculadas. Para isso, será criada uma nova mensagem única: SalesCharge. 

A rotina de Atualização de Comissões (MATA490) deverá ser alterada para trabalhar com mensagem única, ou seja, passará a ter uma IntegDef e será necessário criar o Adapter dessa rotina (MATI490). O Protheus terá tratamentos para recebimento e para envio também. Embora o envio, partindo do Protheus, não seja utilizado nessa integração com hotelaria, o adapter já ficará preparado para trabalhar com envio para quando se fizer necessário.

Ao receber as informações, o Protheus irá gravar a comissão (SE3) através da Execauto da rotina MATA490. Caso grave com sucesso, deverá também gravar o de/para na XXF, relacionando as chaves dos registros dos dois sistemas e deverá retornar um ListOfInternalId padrão de mensagens do tipo Event (cadastro). Para gravação da tabela XXF, deve-se utilizar a seguinte função de Framework: CFGA070Mnt.

Exemplo de retorno de ListOfInternalId:

<ListOfInternalId>
    <InternalId>
        <Name>SalesChargeInternalId</Name>  <- Nome do InternalId
        <Origin>000000001</Origin> <- Chave do registro gerado na origem da mensagem
        <Destination>99|01|COM|TIT001|01|001|VEND01</Destination> <- Chave gerada no Protheus após gravação do registro
    </InternalId>
</ListOfInternalId>

Exemplo de gravação de de/para na XXF:

CFGA070Mnt( "BEMATECH", "SE3", "E3_NUM", "000000001", "99|01|COM|TIT001|01|001|VEND01", .F. )

Após gravadas as informações da SE3, o processo de pagamento das comissões (geração do contas a pagar, a baixa do mesmo e tratativas de impostos) seguirá o fluxo padrão do backoffice, de forma manual conforme melhor determinado pelo cliente que utilizará a integração.

Detalhes técnicos:

• Toda comissão deve estar associada à um contas a receber. Porém, na hotelaria, a comissão pode nascer de um processo de fatura de hotel e não estará associado à um título a receber, mas sim à fatura em questão. Nesses casos, o número da fatura deverá trafegar na mensagem. Com essa informação, o adapter deverá buscar a fatura no Protheus e ver qual título foi gerado para a mesma. Então a chave do título encontrado será utilizado no registro de comissão. Caso a fatura tenha mais de um título gerado (fatura parcelada), associar a comissão ao primeiro título dessa fatura (título com a menor data de vencimento). 

• Para toda comissão gravada através de mensagem única, gravar o campo E3_ORIGEM com o novo valor I, indicando integração (rotina MATI490).

IMPORTANTE: Esse novo valor deverá ser documentado na página do TDN:

http://tdn.totvs.com/pages/releaseview.action?pageId=184781116

• Codificar o adapter de forma atualizada, utilizando a classe tXmlManager ao invés de XmlParser.
  
  
• O Adapter deverá tratar os eventos de Inclusão, Alteração e Exclusão. Na inclusão e alteração, deverá retornar o ListOfinternalId na resposta. Na exclusão, deverá apagar o de/para na XXF e não deve retornar ListOfInternalId na resposta. Para saber a operação do cadastro, deve-se olhar a tag "Event", que por sua vez pode ter dois valores: "UPSERT" ou "DELETE". Se for delete, é uma operação de exclusão. Se for upsert, deve-se primeiramente buscar a chave externa (recebida na tag InternalID) no de/para do Protheus. Se encontrar algum registro, deve-se considerar que é uma operação de alteração. Do contrário, é um processo de inclusão.
  
  

  Exemplo de exclusão de de/para na XXF:

  CFGA070Mnt( "BEMATECH", "SE3", "E3_NUM", "000000001", "99|01|COM|TIT001|01|001|VEND01", .T. )

   

• Adicionar um tratamento para considerar a rotina MATI490 na função FA440Origem, no fonte FINA440. Para esse caso o retorno deverá ser "I".
  
  
• Criar uma função no adapter (MATI490) para encontrar a chave do registro de comissão no Protheus, à partir da chave externa recebida na mensagem.
  
  
• Criar uma função no adapter (MATI490) para criar o valor de InternalId com a chave da comissão no Protheus.

Detalhes da Mensagem (XSD):

Nome da Mensagem: SalesCharge

Versão: 1.000

Tipo: Event

Estrutura:

A mensagem de cadastro de produtos (Item) deverá ser alterada para poder receber as informações tributárias necessárias para o processo fiscal no protheus (sped, sintegra, transmissão de nfs-e). Para isso, uma nova versão da mensagem será criada (3.005), na qual serão adicionadas novas tags para trafegar tais informações. O adapter (MATI010)  também deverá ser alterado para tratar o recebimento dessas informações.

Detalhes da Mensagem (Alteração de XSD):

Nome da Mensagem: Item

Versão: 3.005

Tipo: Event

Novas tags:

Anexos:

XSD - SalesCharge_1_000

XML - SalesCharge_1_000

XSD - HotelInvoice_1_000

XML - HotelInvoice_1_000

XSD - Item_3_005

Exemplo - ExecAuto de Comissões

Tabelas Utilizadas

• SA1 – Clientes
• SA2 – Fornecedores
• SA3 – Vendedores
• SE1 – Títulos a receber
• SE3 – Comissão de Vendas
• AI0 – Complementos de Clientes
• FLY – RPS x NFe
• SF3 – Livros Fiscais
• SFT – Livro Fiscal por Item de NF
• CF8 – Demais Docs. Pis Cofins
• FO8 – Fatura Hotel 
• FO9 – Fatura Hotel x Notas
• FOA - Fatura Hotel x Títulos

Protótipo de Tela

Protótipo 01 - Tela de Faturas de Hotelaria

Dicionário de Dados

Arquivo: SE1 – Títulos a receber

Arquivo: FLY – Controle de RPS e notas fiscais para envio

Arquivo: AI0 – Complementos de clientes

Arquivo: FO8 – Fatura de Hotel

Arquivo: FO9 – Fatura Hotel x Notas

Arquivo: FOA – Fatura Hotel x Títulos

Tabela

Campos