Histórico da Página
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Informações Gerais
Especificação | |||
Produto | Microsiga Protheus | Módulo | SIGAFIN |
Segmento Executor |
| ||
Projeto | PDR_SER_CTR011 | IRM | PCREQ-7939 |
Requisito | PCREQ-7940 | Subtarefa | PDR_SER_CTR011-124 |
Chamado | Não se aplica. | ||
Release de Entrega Planejada | 12.1.7 Abril/16 | Réplica | Não se aplica. |
País | ( ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( X ) Outro Todos. | ||
Outros | .Não se aplica. |
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
Rotinas Envolvidas | ||
Rotina | Tipo de Operação | Opção de Menu |
FINI040 | Alteração | Não se aplica. |
MATI020 | Alteração | Não se aplica. |
MATI030 | Alteração | Não se aplica. |
MATI040 | Alteração | Não se aplica. |
MATA490 | Alteração | SigaFIN > Atualizações > Comissoes > Atualização das Comissões. |
MATI490 | Criação | Não se aplica. |
FINA440 | Alteração | SigaFIN > Miscelanea > Recalculos > Recálculo de Comissão. |
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
Os itens marcados em negrito são processos do loja e não serão tratados nessa especificação.
Cadastro de Cliente |
Será necessário realizar as seguintes alterações relacionadas ao cadastro de clientes:
- Adicionar novas tags na mensagem única de cliente (CUSTOMERVENDOR), para que seja possível trafegar todas as informações fiscais necessárias no momento de integrar os registros. Para isso será necessário criar uma nova versão do XSD dessa mensagem (CustomerVendor_2.006) e deverá haver um tratamento no adapter (MATI030) para considerar essas tags apenas à partir dessa versão da mensagem. As novas tags serão definidas conforme abaixo:
TAG SUPERIOR | TAG | Obrigatória | Observação |
BusinessContent | StrategicCustomerType | Não | Tipo do Cliente (Cons.Final / Produtor / Revendedor / Solidario / Exportação). |
Cadastro de fornecedor |
Cadastro de vendedor |
Contas a Receber |
Será necessário realizar as seguintes alterações relacionadas ao cadastro de contas a receber:
- Remover o campo de conta hoteleira (E1_CONHTL), pois o mesmo se tornou obsoleto na integração com hotelaria.
Análise de crédito |
Bloco F100 |
Sincronização de RPS transmitida |
Produtos |
Será necessário realizar as seguintes alterações relacionadas ao cadastro de Produtos:
Faturas de Hotelaria |
Cancelamento de Faturas de Hotelaria |
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.
Comissões |
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 um IntegDef e será necessário criar o Adapter dessa rotina (MATI490). O Protheus irá apenas receber essa mensagem, portanto, no adapter não haverá tratamentos para envio.
Ao receber as informações, o Protheus irá gravar a comissão (SE3) através da Execauto da rotina MATA490 e deverá retornar um ListOfInternalId padrão de mensagens do tipo Event (cadastro).
Após gravadas as informações da SE3, o processo de pagamento das comissões (geração do contas a pagar e baixa do mesmo) seguirá o fluxo padrão do backoffice, de forma manual conforme melhor determinado pelo cliente que utilizará a integração.
Visto que quem possuí a regra de cálculo é o sistema de hotelaria, não será possível fazer o recáluclo dos registro de comissão gerados por essa integração. Logo, deverá haver uma trava na rotina de Récalculo de Comissão (FINA440) para não permitir tal processo caso a origem da comissão seja integração (E3_ORIGEM = I).
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 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 tag onde normalmente trafegaria o número do título a receber. 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.
Detalhes da Mensagem (XSD):
Nome da Mensagem: SalesCharge
Versão: 1.000
Tipo: Event
Estrutura:
TAG SUPERIOR | TAG | Obrigatória | Descrição |
BusinessContent | CompanyId | Não | Código da Empresa. |
BusinessContent | BranchId | Não | Código da Filial. |
BusinessContent | CompanyInternalId | Não | InternalId das informações da empresa. |
BusinessContent | InternalID | Não | Identificador Único da Comissão |
BusinessContent | SellerInternalId | Não | InternalId do Vendedor |
BusinessContent | AccountReceivableDocumentInternalId | Não | InternalId do Título a Receber que originou a comissão |
BusinessContent | AccountReceivableDocumentPrefix | Não | Prefixo do Título a Receber que originou a comissão |
BusinessContent | AccountReceivableDocumentNumber | Não | Número do Título a Receber que originou a comissão |
BusinessContent | AccountReceivableDocumentParcel | Não | Parcela do Título a Receber que originou a comissão |
BusinessContent | AccountReceivableDocumentTypeCode | Não | Tipo do Título a Receber que originou a comissão |
BusinessContent | CustomerVendorInternalId | Não | Identificador único do Cliente do título a Receber que originou a comissão |
BusinessContent | CustomerVendorCode | Não | Código do Cliente do título a Receber que originou a comissão |
BusinessContent | CustomerVendorStore | Não | Loja do Cliente do título a Receber que originou a comissão |
BusinessContent | IssueDate | Não | Data de Emissão da Comissão |
BusinessContent | BaseValue | Não | Valor Base da Comissão |
BusinessContent | SalesChargePercentage | Não | Percentual de comissão sobre valor base |
BusinessContent | Value | Não | Valor da Comissão |
BusinessContent | DueDate | Não | Data de Vencimento da Comissão |
BusinessContent | Currency | Não | Moeda da Comissão |
ReturnContent | ListOfInternalId | Não | Lista de InternalIds gerados no cadastro |
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
Opcional
Protótipo de Tela
<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.
Protótipo 01
Opcional
Fluxo do Processo
<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>.
Opcional
Dicionário de Dados
Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/
Índice | Chave |
01 | <FI9_FILIAL+FI9_IDDARF+FI9_STATUS> |
02 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_EMISS+FI9_IDDARF> |
03 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_PREFIX+FI9_NUM+FI9_PARCEL+FI9_TIPO> |
Campo | <AAA_PERESP> |
Tipo | <N> |
Tamanho | <6> |
Valor Inicial | <Varia de acordo com o tipo informado. Por exemplo, quando o campo “tipo” for date, neste campo pode ser informado uma data>. |
Mandatório | Sim ( ) Não ( ) |
Descrição | <Referência Mínima para Cálculo> |
Título | <Ref.Calc.> |
Picture | <@E999.99> |
Help de Campo | <Informar o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação> |
(Opcional)
Grupo de Perguntas
<Informações utilizadas na linha Protheus>.
Nome: FINSRF2
X1_ORDEM | 01 |
X1_PERGUNT | Emissão De |
X1_TIPO | D |
X1_TAMANHO | 8 |
X1_GSC | G |
X1_VAR01 | MV_PAR01 |
X1_DEF01 | Comum |
X1_CNT01 | '01/01/08' |
X1_HELP | Data inicial do intervalo de emissões das guias de DARF a serem consideradas na seleção dos dados para o relatório |
(Opcional)
Consulta Padrão
<Informações utilizadas na linha Protheus>
Consulta: AMB
Descrição | Configurações de Planejamento |
Tipo | Consulta Padrão |
Tabela | “AMB” |
Índice | “Código” |
Campo | “Código”; ”Descrição” |
Retorno | AMB->AMB_CODIGO |
(Opcional)
Estrutura de Menu
<Informações utilizadas na linha Datasul>.
Procedimentos
Procedimento |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Módulo |
|
|
|
Programa base |
|
|
|
Nome Menu | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Registro padrão | Sim | Sim | Sim |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Release de Liberação |
|
|
|
Programas
Programa
Descrição
(Max 40 posições)
(Max 40 posições)
(Max 40 posições)
Nome Externo
Nome Menu/Programa
(Max 32 posições)
(Max 32 posições)
(Max 32 posições)
Nome Verbalizado[1]
(Max 254 posições)
(Max 254 posições)
(Max 254 posições)
Procedimento
Template
(Verificar lista de opções no man01211)
(Verificar lista de opções no man01211)
(Verificar lista de opções no man01211)
Tipo[2]
Consulta/Manutenção/ Relatório/Tarefas
Consulta/Manutenção/ Relatório/Tarefas
Consulta/Manutenção/ Relatório/Tarefas
Interface
GUI/WEB/ChUI/Flex
GUI/WEB/ChUI/Flex
GUI/WEB/ChUI/Flex
Categoria[3]
Executa via RPC
Sim/Não
Sim/Não
Sim/Não
Registro padrão
Sim
Sim
Sim
Outro Produto
Não
Não
Não
Visualiza Menu
Sim/Não
Sim/Não
Sim/Não
Query on-line
Sim/Não
Sim/Não
Sim/Não
Sim/Não
Sim/Não
Sim/Não
Rotina (EMS)
Sub-Rotina (EMS)
Localização dentro da Sub Rotina (EMS)
Compact[4]
Sim/Não
Sim/Não
Sim/Não
Home[5]
Sim/Não
Sim/Não
Sim/Não
Posição do Portlet[6]
0 – Top Left
1 – Top Right
2 – Bottom Left
3 – Bottom Right
0 – Top Left
1 – Top Right
2 – Bottom Left
3 – Bottom Right
0 – Top Left
1 – Top Right
2 – Bottom Left
3 – Bottom Right
Informar os papeis com os quais o programa deve ser vinculado
Cadastro de Papéis
<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.
<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.
Código Papel | (máx 3 posições) |
Descrição em Português* |
|
Descrição em Inglês* |
|
[1] Nome Verbalizado é obrigatório para desenvolvimentos no Datasul 10 em diante.
[2] Tipo é obrigatório para desenvolvimento no Datasul 10 em diante
[3] Categorias são obrigatórias para os programas FLEX.
[4] Obrigatório quando o projeto for FLEX
[5] Obrigatório quando o projeto for FLEX
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|