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 | TOTVS Gestão de Estoque, Compras e Faturamento | Módulo | Faturamento |
Segmento Executor | Construção e Projetos | ||
Projeto1 | Integração BackOffice RM x PDV Protheus | IRM1 | PCREQ-7769 |
Requisito1 | PCREQ-8879 | Subtarefa1 | PDR_CP_MOV010-37 |
Chamado2 |
| ||
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( ) Outro _____________. | ||
Outros | <Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>. |
Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos).
(Obrigatório)
Objetivo
Implementação do adapter de integração via Mensagem Única TOTVS do Mapa Resumo - Redução Z. Este adapter irá viabilizar o recebimento da mensagem de Mapa Resumo (Redução Z) gerado pelo PDV PROTHEUS.
(Obrigatório)
Definição da Regra de Negócio
<Regra de negócio é o que define a forma de fazer o negócio, o processo definido e/ou as regras que devem ser contempladas. Devem ser descritas restrições, validações, condições e exceções do processo. Caso necessário, incluir neste capítulo também regras de integridade que devem ser observadas no momento do desenvolvimento>.
Considera-se como escopo deste requisito a implementação do adapter de recebimento de Mensagens Únicas TOTVS para integração do Mapa Resumo (Redução Z), estando o adapter de envio desta mesma mensagem fora do escopo do requisito.
A análise e o desenvolvimento do adapter será efetuado considerando a integração com o PDV Protheus, mas também viabilizará a integração com outras fontes de dados desde que respeitado o layout da mensagem<Na tabela abaixo informe quais são as rotinas envolvidas, o tipo de operação, a opção de menu e se necessário uma breve descrição das regras de negócio relacionadas a rotina>.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
[ACAA040 – Parâmetros] | [Alteração] | [Atualizações -> Acadêmico-> Tesouraria] | - |
[ACAA050 – Negociação Financeira] | [Envolvida] | [Atualizações -> Acadêmico-> Tesouraria] | - |
[ACAA060 – Cadastro de Pedidos] | [Criação] | [Atualizações -> Acadêmico-> Cadastros] | - |
Exemplo de Aplicação:
- Criar o campo “% Mínimo Espécie” (AAA_PERESP) onde o usuário informará o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação.
- Criar o campo “Referência Mínima para Cálculo” (AAA_REFCAL) onde o usuário informará um dos 4 valores disponíveis para pagamento das mensalidades como a referência mínima para calcular o débito total do aluno.
- Criar o parâmetro MV_ACPARNE que definirá se as informações de “% Mínimo Espécie” e “Referência Mínima para Cálculo” serão obrigatórias.
- O parâmetro MV_ACPARNE deve ter as seguintes opções: 1=Obrigatório e 2=Opcional. Deve ser inicializado como opcional>.
Tabelas Utilizadas
- SE2 – Cadastro de Contas a Pagar
- FI9 – Controle de Emissão de DARF>.
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
Redução Z | Inclusão | RM \ BackOffice \ Gestão de Estoque, Compras e Faturamento \ Cadastros \ Fiscais\ Mais...\ Redução Z | - |
A Redução Z permite que o usuário, por exigência legal, informe diariamente os totais acumulados de cada contador ao término do expediente.
Tabelas Utilizadas
- TREDUCAOZ – Redução Z
- TREDUCAOZITEM – Item da Redução Z
- TCUPOMFISCAL – Cupom Fiscal
- TCUPOMFISCALITM – Itens de Cupom Fiscal
- TTRIBUTACAOECF – Tributação ECF
Entidades de Integração
- DataServer envolvido
- MovReducaoZData
- Transformação
- Id: Reduction
- Versão: 1_001
- SourceCode (Evento)
- GUID: c68d7d06-46c4-40f1-8e9d-245c45244eab
Regras de Integridade
Inclusão de Redução Z
A inclusão de Redução Z no RM considera como obrigatórios a informação dos seguintes dados: Ponto de Venda, Número da Redução, Série e Cliente.
- O Ponto de Venda será enviado na mensagem única Reduction_1.001 na tag StationSalePointInternalId. Ao receber a mensagem deve-se buscar na tabela De-Para qual é o código do ponto de venda do RM.
- Número da Redução: será considerado o valor enviado pelo PDV Protheus na tag ReductionCode.
- Série: como esta informação não é trafegada na mensagem será buscado a Série do Ponto de Venda.
- Cliente: como esta informação não é enviada pelo PDV Protheus na mensagem, é necessário cadastrar o Cliente/Fornecedor Default nos Parâmetros de Integração Frente de Loja do TOTVS Gestão de Estoque, Compras e Faturamento. Acesse RM menu BackOffice >> Gestão de Estoque, Compras e Faturamento >> Ambiente >> Configuração >> Parâmetros >> 04.03 - Integrações >> 04.03.04 - Frente de Loja.
Além dos campos obrigatórios acima o campo Contador Não Sujeito ICMS receberá como valor default zero.
Itens de Redução Z
Estes dados são gerados com base nas seguintes informações recebidas da mensagem única:
- Lista de Alíquotas(ListOfAliquot)
- Nesta lista serão enviados os valores tributados de ICMS e ISS, onde na tag AliquotCode será enviado o código da tributação ECF e na tag AliquotBase será enviado o valor base da alíquota informada.
- Valor de Substituição tributária (TaxReplacementValue);
- Valor de Isentos (FreeValue);
- Valor de Não Tributado (UntaxedValue).
O PDV Protheus deverá enviar os Códigos dos Tributos ECF utilizados nos Cupons para que os Itens de Redução Z seja gerados corretamente.
Cálculo da Redução Z
Devido ao recálculo do rateio de descontos e acréscimos pode haver diferenças de arredondamento entre o valor líquido de alguns itens e assim gerando diferenças nos totalizadores de Tributação ECF, mas não nos valores absolutos do cupom.
Caso esta diferença ocorra no Cálculo da Redução Z o processo de "Recalculo dos Totalizadores Parciais" deve ser executado e posteriormente reexecutar o Cálculo da Redução Z.
Ponto de Atenção
- Valor dos Acréscimos: os acréscimos aplicados aos cupons fiscais nas vendas, devem ser enviados na Redução Z para que o cálculos dos valores sejam feitos corretamente. Para isso o PDV Protheus deve somar os acréscimos aplicados aos cupons enviados na Redução Z e enviar esta informação na tag "IncreasesValue'.
- Grande Total (GT): O grande total enviado deverá considerar os acréscimos.
- Acréscimo Financeiro: Devido os dois pontos listados acima e considerando que o Protheus somente utiliza acréscimos no Cupom Fiscal e não nos seus itens, o campo "IncreasesValue" será mapeado para o campo "Acréscimos Financeiros" do RM.
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
Mapeamento dos Campos
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 |
Mensagem: Reduction_1_000
Mensagem Padrão | Descrição | RM | ||
Tabela | Campo | Observação | ||
CompanyId | Código da empresa. | TREDUCAOZ | CODCOLIGADA | Código da Coligada é obtido a partir do De-Para de Filial. |
BranchId | Código da filial |
|
| |
CompanyInternalId | InternalId da chave completa de empresa do produto |
| ||
InternalId | InternalId de Integração | TREDUCAOZ | CODCOLIGADA|IDREDUCAOZ |
|
MovementDate | Data do Movimento | TREDUCAOZ | DATAMOVIMENTO | |
ReductionCode | Código da Redução | TREDUCAOZ | NUMEROREDUCAO | |
InitialValue | Grande Total Final do dia anterior | TREDUCAOZ | GRANDETOTALANT | Valor default Zero, caso não seja enviado na mensagem. |
FinalValue | Grande Total Final do dia | TREDUCAOZ | GRANDETOTAL | |
InitialCounter | Número do Cupom Inicial do Dia | TREDUCAOZ | COOANT | |
FinalCounter | Número do Cupom Final do Dia | TREDUCAOZ | COO | |
ValueCancellations | Valor Total de Cancelamento | TREDUCAOZ | CANCELAMENTOS | |
SalesValueNet | Valor Contábil | -- | -- | Não utilizado no RM. |
TaxReplacementValue | Valor Substituição Tributária | TREDUCAOZITEM | TOTALPARCIAL | Quando enviado o valor preencher o total parcial do Item de Redução Z e utilizar como código de tributação ECF o valor fixo F1. |
DiscountValue | Valor de Descontos | TREDUCAOZ | DESCONTOS | |
FreeValue | Valor de Isentos | TREDUCAOZITEM | TOTALPARCIAL | Quando enviado o valor preencher o total parcial do Item de Redução Z e utilizar como código de tributação ECF o valor fixo I1. |
UntaxedValue | Valor de Não Tributado | TREDUCAOZITEM | TOTALPARCIAL | Quando enviado o valor preencher o total parcial do Item de Redução Z e utilizar como código de tributação ECF o valor fixo N1. |
CounterCode | Contador de Ordem de Operação | TREDUCAOZ | COORZ | |
ValueOfOthersReceivables | Valor de Outros Recebimentos | -- | -- | Não utilizado no RM. |
AmountOfTaxDue | Valor do Imposto Devido | -- | -- | Não utilizado no RM. |
IssValue | Valor Base do ISS | -- | -- | Não utilizado no RM. Os valores de ISS serão mapeados pela lista de alíquotas (ListOfAliquotType). |
CounterReset | Contador de Ordem de Reinicio | -- | -- | Não utilizado no RM. |
IssueDateReduction | Data de Emissão da Redução | TREDUCAOZ | DATAREDUCAO | |
StationSalePointCode | Código Ponto de Venda | TREDUCAOZ | PONTOVENDA | |
StationSalePointInternalId | InternalId do Ponto de Venda | TREDUCAOZ | CODCOLIGADA|PONTOVENDA | |
IncreasesValue | Valor dos Acréscimos da Venda | TREDUCAOZ | ACRESCIMOSFIN | |
ListOfAliquot\ListOfAliquotType | Lista de Alíquotas da Redução Z | As informações desta lista serão preenchidas para cada tipo de alíquota ICMS e ISS. Ver AliquotType. | ||
AliquotType | ||||
---|---|---|---|---|
AliquotCode | Identificador da Base ICMS | TREDUCAOZITEM | TRIBUTACAOECF | |
AliquotBase | Valor da Base ICMS | TREDUCAOZITEM | TOTALPARCIAL |
- Somente os campos marcados em negrito são tratados no Adapter.
(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 |
Log Exec. | 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. |
---|