01. DADOS GERAIS
| Produto: | TOTVS CRM Automação da Força de Vendas |
|---|---|
| Linha de Produto: | Linha TOTVS CRM SFA |
| Módulo: | Venda |
| Função: | Impostos |
| Ticket: | |
| Requisito/Story/Issue: | DTSFAPD-2267 - Obtendo detalhes do item... STATUS |
02. ESCOPO FUNCIONAL/TÉCNICO
1. Cadastro de dados de acesso do Pentaho Carte
Ao invés de todos os plugins conterem campos para "Dados de acesso ao Pentaho Carte", na tela de Configuração > Integração > Plugins de Integração:
- O sistema deverá disponibilizar botão "Configurações gerais" no roda teto da tela, abrindo nova tela, com os campos:
- O campo senha deverá ser tipado como "password" para não pemitir visualização direta da senha na tela.
- A persistência dos valores da tela de Configurações gerais deverá acontecer na tabela pluginintconfig para esses campos, vinculado à registro da tabela pluginintegracao de código "configgeral"
- Os plugins existentes (ReceitaWS e TOTVS Pagamento instantâneo deverão ter os campos de "Configurações do Pentaho removidos" e precisarão de refatoração para buscar das "Configurações Gerais")
2. Criação de configuração do novo plugin "Simulação de impostos"
- O sistema deverá disponibilizar novo plugin de nome "Simulação de impostos", com descrição "Simule impostos diretamente no pedido de venda para negociações mais precisas com seu cliente."
- O link para o manual do plugin será Manual - Plugin de Integração "Simulação de Impostos"
- Pelo tools, opção 18, o sistema deverá persistir novo registro na tabela pluginintegracao, de código "imposto"
- Ao clicar em configurar, o sistema deverá abrir nova tela, exibindo os campos:
- Campo de label "Modelo de simulação de impostos":
- Opções fixas:
- "Protheus APIs Nativas": valor "protheus"
- "Datasul APIs Nativas": valor "datasul"
- "Genérico": valor "generico"
- Opções fixas:
- Campo de label "URL de conexão": textual obrigatório
- Grupo de elementos de label "Autenticação"
- Campo de label "Usuário": textual obrigatório
- Campo de label "Senha": textual, obrigatório, tipado como "password" para não pemitir visualização direta da senha na tela.
- Campo de label "Timeout ao requisitar impostos (seg)": campo numérico, se não informado, adotar o padrão 30 segundos
- Campo de label "Obrigar simulação de pedidos para:": Checkbox, seleção opcional
- Checkbox de label "Gravar pedido"
- Checkbox de label "Finalizar pedido"
- Campo de label "Modelo de simulação de impostos":
3. Implementação no pedido
- No pedido de venda, caso o plugin de integração de código "imposto" estiver ativo,
- O sistema deverá disponibilizar o botão de "Calcular impostos" Web e ícone no Android.
- Como já acontece com o modelo "PLUGIN_WINTHOR" atualmente, o sistema deve gerenciar a exibição de icone colorido baseado na situação dos impostos:
- Impostos não calculados: cor amarela
- Impostos calculados: cor verde
- Ao alterar dados dos produtos, o ícone deve retornar para o status de "não calculado"
- Ao clicar no botão de "Calcular impostos"
- O sistema deverá disparar uma requisição POST para o endereço a seguir:
- ${"Configurações gerais"."Configurações do Pentaho"."URL"}/kettle/executeJob?rep=COMMON_SERVICES&job=COMMONS_JOB_TAXSIMULATION
- Autenticação básica:
- Usuário: ${"Configurações gerais"."Configurações do Pentaho"."Usuário"}
- Senha: ${"Configurações gerais"."Configurações do Pentaho"."Senha"}
- Body:
{ "idusuario": 1, //pedido.idusuarioprofissional "idparceiro": 1, //pedido.idparceiro "idlocal": 2, //pedido.idlocal "idlocalcobranca": 3, //pedido.idlocalcobranca "idfilialvenda": 3, //pedido.idlocalfilialvenda "idfilialretira": 4, //pedido.idlocalfilialretirada "idfilialfaturamento": 5, //pedido.idlocalfilialfaturamento "idtipopedido": 4, //pedido.idtipopedido "idtipocobranca": 5, //pedido.idtipocobranca "idtabelapreco": 6, //pedido.idtabelapreco "idcondicaopagamento": 5, //pedido.idcondicaopagamento "idsegmento": 8, //pedido.idsegmento "idtipologia": 8, //pedido.idtipologia "idoperacao": 8, //pedido.idoperacao "idmoeda": 8, //pedido.idindexador "idtipoestoque": 8, //pedido.idtipoestoque "valortotalbruto": 8.00, //Campo "Valor total bruto do resumo" "valortotalliquido": 9.00,//Campo "Valor total liquido do resumo" "descontopedido": [ { "codigo": "8", //pedidotipodesconto.idtipodesconto > tipodesconto.codigo "percentual": 9.00, //pedidotipodesconto.percentual "valor": 10.00 //pedidotipodesconto.valor }, { "codigo": "8", //pedidotipodesconto.idtipodesconto > tipodesconto.codigo "percentual": 9.00, //pedidotipodesconto.percentual "valor": 10.00 //pedidotipodesconto.valor } ], "pedidoproduto": [ { "ordem": 1, //pedidoproduto.ordem "idproduto": 8, //pedidoproduto.idproduto "quantidade": 9.00, //pedidoproduto.quantidade "precovenda": 10.00, //pedidoproduto.precovenda PS:Valor unitário "precotabela": 11.00, //pedidoproduto.precotabela PS:Valor unitário "precooriginal": 12.00, //pedidoproduto.precooriginal PS:Valor unitário "percentualdesconto": 13.00, //pedidoproduto.percentualdesconto "valordesconto": 13.00, //pedidoproduto.valordesconto PS:Valor unitário "percentualacrescimo": 13.00, //pedidoproduto.percentualacrescimo "valoracrescimo": 13.00, //pedidoproduto.valoracrescimo PS:Valor unitário "idtipopedido": 13.00, //pedidoproduto.idtipopedido "idtipoestoque": 14, //pedidoproduto.idtipoestoque "idtabelapreco": 15, //pedidoproduto.idtabelapreco }, { "ordem": 1, //pedidoproduto.ordem "idproduto": 8, //pedidoproduto.idproduto "quantidade": 9.00, //pedidoproduto.quantidade "precovenda": 10.00, //pedidoproduto.precovenda PS:Valor unitário "precotabela": 11.00, //pedidoproduto.precotabela PS:Valor unitário "precooriginal": 12.00, //pedidoproduto.precooriginal PS:Valor unitário "percentualdesconto": 13.00, //pedidoproduto.percentualdesconto "valordesconto": 13.00, //pedidoproduto.valordesconto PS:Valor unitário "percentualacrescimo": 13.00, //pedidoproduto.percentualacrescimo "valoracrescimo": 13.00, //pedidoproduto.valoracrescimo PS:Valor unitário "idtipopedido": 13.00, //pedidoproduto.idtipopedido "idtipoestoque": 14, //pedidoproduto.idtipoestoque "idtabelapreco": 15, //pedidoproduto.idtabelapreco } ], "pedidoentrega": [ { "idtipofrete": 4, //pedidoentrega.idtipofrete "idtransportadora": 7,//pedidoentrega.idparceirotransportador "valorfrete": 5.00, //pedidoentrega.valorfrete "valordespesa": 6.00, //pedidoentrega.valordespesa "valorseguro": 7.00 //pedidoentrega.valorseguro }, { "idtipofrete": 4, //pedidoentrega.idtipofrete "idtransportadora": 7,//pedidoentrega.idparceirotransportador "valorfrete": 5.00, //pedidoentrega.valorfrete "valordespesa": 6.00, //pedidoentrega.valordespesa "valorseguro": 7.00 //pedidoentrega.valorseguro } ] }
- O retorno esperado virá com o modelo a seguir:
{ "valortotalcomimpostos": 15.00, "valortotalimpostos": 16.00, "valortotaldespesa": 6.00, //pedidoentrega.valordespesa "valortotalseguro": 7.00, //pedidoentrega.valorseguro "pedidoimposto": [ { "sglimposto": "ICMS", "aliquota": 11.00, "valortotalimposto": 0.5, }, { "sglimposto": "ST", "aliquota": 11.00, "valortotalimposto": 0.5 }, { "sglimposto": "IPI", "aliquota": 11.00, "valortotalimposto": 0.5 } ], "itemimposto": [ { "ordem": 1, //pedidoproduto.ordem "idproduto": 8, //pedidoproduto.idproduto // "valortotalcomimpostos": 12.00, //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade "valortotalfrete": 15.00, //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade "impostos": [ { "sglimposto": "ICMS", "valorbase": 10.00, "aliquota": 11.00, "valortotalimposto": 12.00 //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade }, { "sglimposto": "IPI", "valorbase": 10.00, "aliquota": 11.00, "valortotalimposto": 12.00 //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade }, { "sglimposto": "ST", "valorbase": 10.00, "aliquota": 11.00, "valortotalimposto": 12.00 //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade } ] }, { "ordem": 1, //pedidoproduto.ordem "idproduto": 8, //pedidoproduto.idproduto "valortotalcomimpostos": 12.00, //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade "valortotalfrete": 15.00, //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade "impostos": [ { "sglimposto": "ICMS", "valorbase": 10.00, "aliquota": 11.00, "valortotalimposto": 12.00 //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade }, { "sglimposto": "IPI", "valorbase": 10.00, "aliquota": 11.00, "valortotalimposto": 12.00 //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade }, { "sglimposto": "ST", "valorbase": 10.00, "aliquota": 11.00, "valortotalimposto": 12.00 //NÃO UNITÁRIO, precisa ser múltiplicado pela requisição.quantidade } ] }- Com o retorno acima, o sistema deverá persistir as informações em tela, segundo o seguinte de-para:
Retorno da Simulação Campo do SFA itemimposto.impostos.sglimposto pedidoimposto.idimposto
itemimposto.impostos.valorbase pedidoimposto.valorbasecalculoreducao
itemimposto.impostos.aliquota pedidoimposto.valorbasecalculo itemimposto.impostos.valortotalimposto pedidoimposto.valorimposto
itemimposto.ordem / itemimposto.idproduto pedidoimposto.idpedidoproduto (procurar por pedidoproduto.ordem e pedidoproduto.idproduto respectivamente) itemimposto.ordem / itemimposto.idproduto pedidoproduto.idpedidoproduto (procurar por pedidoproduto.ordem e pedidoproduto.idproduto respectivamente) itemimposto.valortotalfrete pedidoproduto.valorfrete itemimposto.valortotalcomimpostos pedidoproduto.valortotalcomimpostos - A representação dos impostos em tela seguirá o modelo atual, exibindo os valores persistidos na linha do item e nos resumos, agrupando os valores dos itens.
- Autenticação básica:
- ${"Configurações gerais"."Configurações do Pentaho"."URL"}/kettle/executeJob?rep=COMMON_SERVICES&job=COMMONS_JOB_TAXSIMULATION
- O sistema deverá disparar uma requisição POST para o endereço a seguir:
- Como já acontece com o modelo "PLUGIN_WINTHOR" atualmente, o sistema deve gerenciar a exibição de icone colorido baseado na situação dos impostos:
- Ao gravar o pedido,
- Caso a checkbox "Gravar pedido" estiver marcada, o sistema deverá restringir a gravação caso os impostos não estiverem calculados (cor verde), com mensagem: "É obrigatória a simulação de impostos para executar esta ação"
- Ao finalizar o pedido
- Caso a checkbox "Finalizar pedido" estiver marcada, o sistema deverá restringir a finalização caso os impostos não estiverem calculados (cor verde), com mensagem: "É obrigatória a simulação de impostos para executar esta ação"
- Ao abrir pedidos não finalizados,
- O sistema deverá adotar o status dos impostos como "não calculados" (cor amarela)
- O sistema deverá disponibilizar o botão de "Calcular impostos" Web e ícone no Android.
PS: É importante que tanto a requisição, quanto o retorno sejam logadas no console (f12) e log (server.log) da Web/Wildfly, para facilitar triagem de chamados envolvendo simulação de impostos.
4. Modelo de requisição para simulação de impostos Protheus APIs Nativas
O Pentaho Carte, recebendo a requisição da aplicação na rota COMMONS_JOB_TAXSIMULATION, deverá tratar os dados recebidos segundo o modelo da entrada da API de simulação de impostos do Protheus, segundo documentação https://api.totvs.com.br/apidetails/SalesTaxes_v1_000.json
Com o retorno, o serviço de integração deverá ao menos implementar os campos definidos pela tabela de-para do ponto 3.
5. Modelo de requisição para Simulação de impostos Datasul APIs Nativas
O Pentaho Carte, recebendo a requisição da aplicação na rota COMMONS_JOB_TAXSIMULATION, deverá tratar os dados recebidos segundo o modelo da entrada da API de simulação de impostos do Datasul, que segue o mesmo modelo de body da documentação https://api.totvs.com.br/apidetails/SalesTaxes_v1_000.json
A URL da rota é definida pelo padrão; ${base_url}/api/ftp/v2/ItemTaxSimulationPublic
Com o retorno, o serviço de integração deverá ao menos implementar os campos definidos pela tabela de-para do ponto 3.
6. Modelo de requisição para simulação de impostos Genérica
Será implementado um modelo genérico padrão, onde o Pentaho deverá enviar requisição com autenticação básica definida segundo modelo padrão e esperando receber retorno segundo modelo padrão definido pela documentação Manual - Plugin de Integração "Simulação de Impostos".
Caso os sistemas terceiros se adaptem ao modelo padrão definido acima, o requisito de simulação de impostos poderá ser implementados sem necessidade de customização.
Entretanto, caso os sistemas não possam se adaptar para receber e retornar a requisição segundo o definido pela documentação acima, esse modelo de simulação de impostos será configurado na aplicação para que dispare serviço de integração customizado, que respeita apenas o contrato requisição/retorno definido entre aplicação/pentaho.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas