[Billing] Integrar processo de abertura do workflow do billing com o workflow do Fluig
Description
01 - STAKEHOLDER (quem valida e esclarece):
Robson Poffo
Ponto técnico Swagger Fluig: italo.rrsilva@totvs.com.br e Isa.
02 - PROBLEMA (cenário e/ou dor):
A geração de workflows de transferências de valores do billing é manual, com alto risco de esquecimento, erro de digitação e falha humana.
04 - QUEM PODE USAR (perfis de usuários): Usuários com a role “Billing Admin”
05 - ASSETS (links e arquivos relevantes):
Assets do Fluig:
Billing Admin
Swagger Fluig
Fluig API
Detalhes endpoint para a abertura de workflow:
Tokens para desenvolvimento: https://minhasenha.cloudtotvs.com.br/restore/QvRQVNZpH4
-
Endpoint:
[DOMINIO]/process-management/api/v2/processes/TransfCC/start -
Método:
POST -
Autenticação: OAuth 1.0
-
Body:
{"targetState": 0,"comment": "string","formFields": {"additionalProp1": "string","additionalProp2": "string","additionalProp3": "string"}} -
Campos:
-
targetState: Atividade de destino do processo. -
comment: Comentário opcional. -
formFields: Objeto chave-valor contendo os campos específicos do formulário (cada chave corresponde ao atributo name do campo no Fluig).
-
Todos os campos dentro de
formFieldsdevem ser preenchidos conforme o contexto do processo.
Os dados de aprovadores podem variar conforme a configuração do workflow no Fluig.
Campos abaixo são obrigatórios no payload
informações transferencia
"valor":
"tipoTransf": "4",
"codTipoTransf": "4",
"descTipoTransf": "COMPRA OU VENDA DE RECURSOS INTERNOS",
"motivo":
informações quem paga (clientes)
"ccorigem":
"itemo":
"classeorigem":
"contacontabilo":
informações quem recebe (time ideia)
"ccdestino":
"itemd": "0005",
"classedestino": "C0100 ",
"contacontabild": "901300300",
"empresacc": "SA",
"codEmpresa": "SA",
Exemplo de payload:
{"targetState": 28,"comment": "string","formFields": {"valor": "R$ 8.589,05","tipoTransf": "4","codTipoTransf": "4","descTipoTransf": "COMPRA OU VENDA DE RECURSOS INTERNOS","motivo": "teste","ccorigem": "8H0E00102","itemo": "0005","classeorigem": "T0160 ","contacontabilo": "410301010124","ccdestino": "190134011","itemd": "0005","classedestino": "G0106 ","contacontabild": "410201010124","empresacc": "SA","codEmpresa": "SA","aprovadoratual": "13065838","emailaprovador___1": "jeferson.martins@totvs.com.br","nomeaprovador___1": "Jeferson Alfredo Moreira Martins","tipoAprovador___1": "Responsável pelo Centro de Custo"}}
06 - CRITÉRIO:
-
Navegação
-
Homepage agora possui TABs para permitir visualizar os dashboards e as accounts (que terá o fluxo de transferência).
-
Dashboard: mesmo fluxo atual, sem alterações.
-
Accounts:
-
Possui um botão “Sync Workflows Status” para sincronizar o status dos workflows com a base do billing (obter o status atualizado e gravar no billing). Esse fluxo será executado apenas para as workflows do batchID selecionado (que já deverá estar consolidado).
-
Linha contendo dados gerais do billing:
-
Total Billing: valor total do billing
-
Approved Amount: total já aprovado
-
Unapproved amount: total não aprovado
-
Total workflows: número total de workflows abertos.
-
Total not transferred: valor total não submitted ao workflow do billing.
-
-
Transfer cost: lista de accounts que tínhamos antes na primeira tela do billing admin.
-
Permitir ajuste de valores (desconto ou acréscimo). Já é possível atualmente.
-
Campo para informar justificativa do desconto ou acréscimo aplicado.
-
-
-
-
-
Regras de Exibição e Transferência do Billing:
-
Apenas batchID com o tipo “consolidated” podem ser enviados.
-
Deve haver possibilidade de seleção de uma ou mais contas de billing para envio do workflow.
-
Billings já enviados devem ser indicados na tela, exibindo o código do workflow gerado no envio do workflow.
-
Ação primária da tela do billing admin será
-
“Consolidate”: se o billing está published.
-
“Publish”: se o billing não estiver published.
-
O objetivo agora é permitir marcar um billing published como consolidated, permitindo assim iniciar a transferência dos valores.
-
-
-
Ações adicionais vinculadas à transferência do billing
-
Ao selecionar uma ou mais billing account, o usuário poderá iniciar “Create transfer workflow”.
-
Texto padrão para ser enviado no workflow:
-
Billing de <mês/ano> para a o período de <data inicio> até <data fim> está disponível em <link para o billing usando a URL: https://totvs.carol.ai/carol-billing/ >
-
-
O usuário confirma, é iniciado a criação dos workflows, e para cada workflow é atualizado informações internas:
-
Código do workflow
-
Data/hora envio workflow
-
valor enviado workflow
-
cost center, item, class enviado para o workflow (caso seja alterado no futuro na billing account)
-
status do workflow: deve ser recebido na abertura e atualizado nas sincronizações.
-
-
Cancelamento de workflow:
-
Deve existir a possibilidade de cancelar um billing enviado, utilizando o endpoint:
POST /resource_WorkflowRest_cancelInstancehttps://totvscorporativo200367.fluig.cloudtotvs.com.br/api/resource_WorkflowRest.html#resource_WorkflowRest_cancelInstance_POST
Passa apenas o "processInstanceId" (numero da solicitação) -
Ao cancelar deve ser adicionado o motivo do cancelamento.
-
-
-
Filtros e Usabilidade
-
Incluir filtros para pesquisa e seleção de billings.
-
Cost Center Code, Eligible, Not submitted, status, total value higher than, workflow code.
-
-
Exibir claramente o status de cada billing (pendente, enviado, cancelado, etc.).
-