sfp_api_laravel_ginastica_cerebro/docs/calculo-royalties.md

Calculo de Royalties

O Calculo é baseado em 3 faixas de tempo de contrato (Mês sequencial desde a abertura) e 3 Componentes de cobrança.

Royalties

• Meses 1 a 3: Isento
• Meses 4 a 12: Maior entre % do TBR Fixo do ano (Atribuido em Configurações do TBR) ou 8% to total do faturamento da unidade.
• Meses 13 a 60: Maior entre % fixa da tbr anual ou 8% de faturamento total da unidade

FNM

• Meses 1 a 3: Isento
• Meses 4 a 12: Maior entre: Porcentagem Fixa do TBR Anual ou 2% do faturamento total da unidade
• Meses 13 a 60: Maior entre: Porcentagem Fixa do TBR Anual ou 2% do faturamento total da unidade

Taxa de Manutenção:

• Meses 1 a 60: 30% do Fixo da TBR

Devemos guardar no banco de dados qual o criterio que foi aplicado tbr_fixo (tbr_fixed) ou porcentual_faturamento (revenue_percentage)

Classificação de Habitantes

Define categorias de porte da região (Pequeno, Médio, Grande Porte) que determinam qual faixa de royalties se aplica ao franqueado.

--

Tabela de Auditoria

Devemos ter uma tabela. Todos os valores intermediários devem ser gravados para garantir auditoria completa de qualquer cálculo.

Campos esperados:

• Referencia de unidade (unidade_id)
• Valor do Faturamento Bruto do Mês em questão da unidade
• Referencia do mês de contrato da unidade. Ex: Mes 15 em sequencia, deve ser guardado como 15.
• Valor da TBR no momento do calculo
• Referencia a faixa FNM utilizada
• Valor Percentual da faixa de FNM Aplicada (Snapshot)
• Valor calculado pela faixa de FNM (% da TBR)
• Referencia para a Faixa da Manutenção utilizada
• Percentual da Faixa de Manutenção (Snapshot)
• Valor calculado pela faixa de manutenção (% da TBR)
• Referencia para a faixa de Royalties da unidade
• Percentual da faixa de royalties (Snapshot)
• Valor calculado de royalties pela faixa (% da TBR)
• Percentual efetivo do FNM cobrado na cobrança final
• Valor efetivo do FNM cobrado
• Percentual efetivo do royalties cobrado na cobrança final
• Valor efetivo dos royalties cobrado
• Percentual efetivo da manutenção cobrado na cobrança final
• Valor efetivo da manutenção cobrado
• Subtotal calculado pelas faixas (antes da comparação com % de faturamento)
• Subtotal após aplicar a regra "maior valor" (Faixa vs % Faturamento)
• Valor total final a cobrar da unidade
• Usuário que executou ou confirmou o calculo (Nullable, pode ser automático)
• Referencia ao criterio aplicado
• Booleano se conta a receber foi gerada
• Booleana se conta a pagar para unidae foi gerado
• timestamps

---

Também devemos ter tabela de contas a receber

• Uma tabela de contas a receber da unidade
• Outra tabela de contas a receber da franqueadora
• Uma tabela de contas a pagar da unidade também

Todas essas tabelas devem ter status de aguardando pagamento, pago, identificador se já foi gerado e etc

Na tab de financeiro, em UnitActionPage, a gente pode definir se FNM e Royalties serão cobrados ou não. Se tiver desativado, não cobraremos para a unidade em questão esses valores.