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-8877 | Subtarefa1 | PDR_CP_MOV009-100 |
Chamado2 |
Release de Entrega Planejada | 12.1.10 | Réplica | Não |
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 cadastro de Cupom Fiscal com o PDV PROTHEUS, viabilizando assim o CRUD completo do cadastro por recebimento de mensagem de integração.
Definição da Regra de Negócio
Considera-se como escopo deste requisito a implementação do adapter de recebimento de Mensagens Únicas TOTVS para integração do cadastro de Cupom Fiscal, 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.
Rotina | Tipo de Operação | Opção de Menu | Regras de Negócio |
Cupom Fiscal | Inclusão/Alteração |
RM \ BackOffice \ Gestão de Estoque, Compras e Faturamento \ Cadastros \ Fiscais\ Mais...\ Cupom Fiscal | - |
Exemplo de Aplicação:
Movimento | Inclusão/Alteração | RM \ BackOffice \ Gestão de Estoque, Compras e Faturamento \ Vendas \ Faturamento\ Movimentação | - |
Tabelas Utilizadas
- TCUPOMFISCAL – Cupom Fiscal
- TCUPOMFISCALITM - Itens de Cupom Fiscal
- TCUPOMFISCALFIN - Pagamentos do Cupom Fiscal
- TMOV - Movimentos
- TITMMOV - Itens de Movimento
Entidades de Integração
- DataServer envolvido
- MovCupomFiscalData
- Transformação
- Id: RetailSales
- Versão: 2.009
- SourceCode (Evento)
- GUID:
- GUID:
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 |
- 1efe6424-027b-44af-8dd3-ef18a527d6b6
- 1efe6424-027b-44af-8dd3-ef18a527d6b6
Regras de Integridade:
Ao receber mensagem de Cupom Fiscal serão realizadas as seguintes ações para os campos abaixo:
Cupom Fiscal:
- COO: será utilizado o mesmo campo que o número.
- CRO: será obtido a partir do default do cadastro de Estação no RM, sendo assim é necessário ao cadastrar o Ponto de Venda informar este campo.
Redução Z: deve ser preenchido após a integração do cupom fiscal, não sendo então integrado.
- Acréscimo: No Protheus o acréscimo é por cupom, com rateio para os itens. No RM esta informação será preenchido no campo VALORDESP que é a soma das despesas dos itens ou despesa aplicada ao cupom, NÃO irá incluir itens CANCELADOS. Caso não seja enviado acréscimo, será considerado como valor default o valor 0 (zero).
- Valor Líquido: a fórmula de cálculo para obter o valor líquido é: VALORLIQUIDO = ( ∑ ( Preço item X Quantidade item) - Desconto + Acréscimo total ). Não deve ser considerado Itens Cancelados. Caso não seja enviado o valor líquido será considerado como valor default o valor 0 (zero).
- Valor Recebido: será preenchido com o mesmo valor do campo Valor Líquido.
- Desconto: No RM o campo que armazena esta informação é VALORDESC. Este campo é soma dos descontos dos itens ou desconto aplicado ao cupom, NÃO inclui itens CANCELADOS! Caso não seja enviado o valor líquido será considerado como valor default o valor 0 (zero). Sempre será lido o valor líquido e as despesas do valor original enviado. Mas os descontos, serão recalculados para evitar erro no arredondamento.
Observação: no Protheus o desconto pode ser por item, por cupom, ou ambos. CNPJ Adquirente: esta informação será gravada no RM somente se for enviado na mensagem.
Nome Adquirente: esta informação será gravada no RM somente se for enviado na mensagem.
Item do Cupom Fiscal:
- Preço unitário: O preço unitário enviado pelo Protheus será o preço do produto.
- Natureza da Operação: Obtida a partir da Tributação.
Alíquota: Obtida a partir da Tributação.
CST: Obtida a partir da Tributação.
Lista de Pagamentos:
- Débito/Crédito: fixo crédito (não será trafegado).
Cupom Fiscal - SAT / NFC-e
Serão aplicadas as mesmas regras listadas acima para Cupom Fiscal, porém este tipo de Cupom irá criar um Movimento, ou seja, não será gerado o registro na tabela de Cupom Fiscal.
O tipo de movimento de venda que será utilizado é o definido no cadastro de Ponto de Venda. Neste tipo de movimento na etapa Fis - Escrituração 1/2, deve ser informado o Tipo de Documento:
SAT: Código do Modelo 59 - CUPOM FISCAL ELETRÔNICO – SAT (CF-E-SAT).
NFC-e: Código do Modelo 65 - Nota Fiscal Eletrônica ao Consumidor Final.
Movimento associado ao Cupom Fiscal
O serviço de inclusão de Cupom Fiscal também realiza a inclusão de um movimento e associa este movimento ao Cupom. Sendo assim torna-se necessário informar no cadastro de Ponto de Venda qual será o Tipo de Movimento de Venda que será utilizado. Este tipo de movimento deve possuir as seguintes configurações mínimas:
Etapa | Campo | Valor | Observação |
---|---|---|---|
Mov - Identificação | Código | 2.X.XX | Tipo de movimento utilizado para NFC-e deve começar como 2.2.XX. |
Edita Numeração | Edita ou Mostra | ||
Mov - Datas 1/2 | Edição da Data de Emissão | Edita ou Mostra | |
Mov - Valores Financeiros 1/4 | Desconto | Marcado | |
Tipo de Desconto | Valor | ||
Despesa | Marcado | ||
Tipo de Despesa | Valor | ||
Item - Valores Financeiros 1/2 | Utilizar Desconto | Marcado | |
Nome do Desconto | Desconto | ||
Afeta Desconto do Movimento | Desmarcado | ||
Tipo do Desconto | Valor | ||
Utilizar Despesa | Marcado | ||
Nome da Despesa | Despesa | ||
Tipo de Despesa | Valor | ||
Afeta Despesa do Movimento | Desmarcado | ||
Fin - Condições de Pagamento | Utiliza edição de Meios de Pagamento | Marcado | |
Fis - Dados | Emite Cupom Fiscal | Marcado | Para Cupom Fiscal Tipo SAT este parâmetro deve ficar desmarcado. |
Fis - Escrituração 1/2 | Código Default Tipo Documento Escrituração | Informar Código do Tipo de Documento | Para Cupom Fiscal Tipo SAT o Tipo de Documento informado deve possui Código Modelo do Documento 59 - CUPOM FISCAL ELETRÔNICO – SAT (CF-E-SAT). Para Cupom Fiscal Tipo NFC-e o Tipo de Documento informado deve possui Código Modelo do Documento 65 - Nota Fiscal Eletrônica ao Consumidor Final. |
Fis - NF-e | NFC-e | Informar o Tipo de Envio | Para Cupom Fiscal Tipo NFC-e este campo deve estar selecionado como Integrado por Terceiro. |
Restrições e Ponto de Atenção
- Cadastros necessários
Para integrar o Cupom Fiscal é necessário realizar o cadastro e/ou carga inicial dos seguintes cadastros:Envio de Unidade de Medida;
Envio de Produto / Códigos de Barras;
Envio de Ponto de Venda;
Envio de Vendedor.
- Número do Caixa
Na integração entre Protheus e RM sem mensagem única, é gravado neste campo o mesmo valor informado para o código do Ponto de Venda (F2_PDV). Como o Número do Caixa do Cupom Fiscal no RM é do tipo inteiro e no Protheus este campo é do tipo texto, na integração atual via mensagem única esta informação será desconsiderada. Caso seja necessário realizar/ajustar algum relatório relacionado a esta informação, deve-se considerar do código do Ponto de Venda. - Lista de Taxas
A lista de taxas (ListOfTaxesType) que serão aplicadas na Venda devem ser definidas no Tipo de Movimento uma vez que estas informações são desconsideradas no recebimento da mensagem e os valores de tributação são recalculados no RM. - Aplicação de Desconto/Acréscimo no Movimento
Para que o Desconto e Acréscimo seja corretamente aplicada no Movimento é obrigatório que o tipo de movimento esteja parametrizado como utilizado por "Valor" para estas duas informações, para o Movimento e para os Itens de Movimento. Caso contrário pode haver diferenças no arredondamento e assim gerar erros na inclusão.
- Rateio de Desconto/Acréscimo
O rateio de desconto e acréscimo dos itens é calculado sempre que existir desconto e acréscimo informado por Cupom. Como no Protheus o desconto pode ser por item, por cupom ou ambos, ao receber um Cupom o RM irá recalcular o rateio de desconto dos itens para evitar erro no arredondamento. - Cupom Fiscal - SAT
Esta integração está disponível a partir do release 12.1.14. - Cupom Fiscal - NFC-e
Esta integração está disponível a partir do release 12.1.23.
CUPOM FISCAL ELETRÔNICO – SAT / NFC-e
Fluxo do Processo
Mapeamento de Campos
Mensagem: RetailSales
Deck of Cards | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
(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. |
---|