Especificación Técnica: mae_metas_promotores¶
Esquema: fuerza_ventas
Base de Datos: crm
Tabla Legacy Origen: i176t_meta_promotor
Propósito: Objetivos mensuales o periódicos de ventas, cobertura de clientes compradores, visitas efectivas y recaudación asignados a los promotores comerciales.
1. Justificación y Mejoras de Arquitectura¶
- Estructura Periódica de Metas Comerciales: Modela los KPIs y cuotas mensuales por promotor para evaluación de desempeño y liquidación de comisiones.
- Aislamiento Multi-Tenant (RLS): Integra
empresa_id BIGINT NOT NULLcon políticas RLS obligatorias. - Integridad Referencial Compuesta: Clave única compuesta
(empresa_id, id), constraint de unicidad temporal por promotor(empresa_id, promotor_id, anio, mes)y FK compuesta haciafuerza_ventas.mae_promotores. - Trazabilidad y Auditoría: Auditoría integral (
created_at,updated_at,deleted_at,created_by,updated_by) con auditoría integral.
2. Definiciones de Implementación¶
Table fuerza_ventas.mae_metas_promotores {
id uuid [pk, default: `gen_random_uuid()`, note: 'Identificador único UUID']
empresa_id bigint [not null, note: 'Identificador BIGINT de la empresa en core.identidad (RLS)']
promotor_id uuid [not null, note: 'Promotor comercial asignado']
anio int [not null, note: 'Año de la meta (p. ej. 2026)']
mes int [not null, note: 'Mes de la meta (1-12)']
meta_monto_ventas numeric(12,2) [not null, default: `0.00`, note: 'Meta financiera de facturación']
meta_cobertura_clientes int [not null, default: `0`, note: 'Meta de cantidad de clientes compradores únicos']
meta_visitas_efectivas int [not null, default: `0`, note: 'Meta de visitas efectivas con transacción']
meta_monto_cobranza numeric(12,2) [not null, default: `0.00`, note: 'Meta de recuperación y cobro de cartera']
// Auditoría General
is_activo boolean [not null, default: `true`, note: 'Estado lógico del registro']
created_at timestamptz [not null, default: `now()`, note: 'Fecha de creación']
updated_at timestamptz [not null, default: `now()`, note: 'Fecha de última actualización']
deleted_at timestamptz [note: 'Fecha de eliminación lógica']
created_by uuid [note: 'Usuario creador']
updated_by uuid [note: 'Usuario modificador']
Indexes {
(empresa_id, id) [unique, name: 'uq_mae_metas_promotores_empresa_id']
(empresa_id, promotor_id, anio, mes) [unique, name: 'uq_mae_metas_promotores_periodo']
(empresa_id, is_activo) [name: 'ix_mae_metas_promotores_empresa_activo']
(empresa_id, anio, mes) [name: 'ix_mae_metas_promotores_empresa_periodo']
(empresa_id, promotor_id) [name: 'ix_mae_metas_promotores_empresa_promotor']
}
}
Ref: fuerza_ventas.mae_metas_promotores.(empresa_id, promotor_id) > fuerza_ventas.mae_promotores.(empresa_id, id) [delete: cascade]
CREATE TABLE IF NOT EXISTS fuerza_ventas.mae_metas_promotores (
id UUID NOT NULL DEFAULT gen_random_uuid(),
empresa_id BIGINT NOT NULL,
promotor_id UUID NOT NULL,
anio INT NOT NULL,
mes INT NOT NULL,
meta_monto_ventas NUMERIC(12,2) NOT NULL DEFAULT 0.00,
meta_cobertura_clientes INT NOT NULL DEFAULT 0,
meta_visitas_efectivas INT NOT NULL DEFAULT 0,
meta_monto_cobranza NUMERIC(12,2) NOT NULL DEFAULT 0.00,
-- Auditoría General
is_activo BOOLEAN NOT NULL DEFAULT true,
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
deleted_at TIMESTAMPTZ,
created_by UUID,
updated_by UUID,
CONSTRAINT pk_mae_metas_promotores
PRIMARY KEY (id),
CONSTRAINT uq_mae_metas_promotores_empresa_id
UNIQUE (empresa_id, id),
CONSTRAINT uq_mae_metas_promotores_periodo
UNIQUE (empresa_id, promotor_id, anio, mes),
CONSTRAINT ck_mae_metas_promotores_mes
CHECK (mes BETWEEN 1 AND 12),
CONSTRAINT fk_mae_metas_promotores_promotor
FOREIGN KEY (empresa_id, promotor_id)
REFERENCES fuerza_ventas.mae_promotores (empresa_id, id)
ON DELETE CASCADE
);
CREATE INDEX IF NOT EXISTS ix_mae_metas_promotores_empresa_activo
ON fuerza_ventas.mae_metas_promotores (empresa_id, is_activo);
CREATE INDEX IF NOT EXISTS ix_mae_metas_promotores_empresa_periodo
ON fuerza_ventas.mae_metas_promotores (empresa_id, anio, mes);
CREATE INDEX IF NOT EXISTS ix_mae_metas_promotores_empresa_promotor
ON fuerza_ventas.mae_metas_promotores (empresa_id, promotor_id);
COMMENT ON TABLE fuerza_ventas.mae_metas_promotores IS
'Metas y Cuotas Comerciales de Promotores: Objetivos periódicos de ventas, cobertura, visitas y cobranza asignados a promotores.';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.id IS
'Identificador único UUID';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.empresa_id IS
'Identificador UUID de la empresa en core.identidad (RLS)';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.promotor_id IS
'Promotor comercial asignado';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.anio IS
'Año de la meta (p. ej. 2026)';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.mes IS
'Mes de la meta (1-12)';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.meta_monto_ventas IS
'Meta financiera de facturación';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.meta_cobertura_clientes IS
'Meta de cantidad de clientes compradores únicos';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.meta_visitas_efectivas IS
'Meta de visitas efectivas con transacción';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.meta_monto_cobranza IS
'Meta de recuperación y cobro de cartera';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.is_activo IS
'Estado lógico del registro';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.created_at IS
'Fecha de creación';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.updated_at IS
'Fecha de última actualización';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.deleted_at IS
'Fecha de eliminación lógica';
COMMENT ON COLUMN fuerza_ventas.mae_metas_promotores.created_by IS
'Usuario creador';
COMMENT ON COLUMN fuerza_ventas.mae_promotores.updated_by IS
'Usuario modificador';
ALTER TABLE fuerza_ventas.mae_metas_promotores
ENABLE ROW LEVEL SECURITY;
CREATE POLICY rls_mae_metas_promotores_empresa
ON fuerza_ventas.mae_metas_promotores
FOR ALL
USING (
empresa_id = current_setting(
'app.current_empresa_id',
true
)::BIGINT
)
WITH CHECK (
empresa_id = current_setting(
'app.current_empresa_id',
true
)::BIGINT
);
import uuid
from datetime import datetime
from decimal import Decimal
from sqlalchemy import (
BigInteger,
Boolean,
CheckConstraint,
ForeignKeyConstraint,
Index,
Integer,
Numeric,
UniqueConstraint,
text,
)
from sqlalchemy.dialects.postgresql import TIMESTAMPTZ, UUID
from sqlalchemy.orm import Mapped, mapped_column
from app.db.base import Base
class MaeMetasPromotores(Base):
"""
Metas y Cuotas Comerciales de Promotores.
Objetivos mensuales o periódicos de ventas, cobertura de clientes y
recaudación asignados a los promotores.
Legacy:
i176t_meta_promotor
"""
__tablename__ = "mae_metas_promotores"
__table_args__ = (
UniqueConstraint(
"empresa_id",
"id",
name="uq_mae_metas_promotores_empresa_id",
),
UniqueConstraint(
"empresa_id",
"promotor_id",
"anio",
"mes",
name="uq_mae_metas_promotores_periodo",
),
CheckConstraint(
"mes BETWEEN 1 AND 12",
name="ck_mae_metas_promotores_mes",
),
ForeignKeyConstraint(
["empresa_id", "promotor_id"],
["fuerza_ventas.mae_promotores.empresa_id", "fuerza_ventas.mae_promotores.id"],
ondelete="CASCADE",
name="fk_mae_metas_promotores_promotor",
),
Index(
"ix_mae_metas_promotores_empresa_activo",
"empresa_id",
"is_activo",
),
Index(
"ix_mae_metas_promotores_empresa_periodo",
"empresa_id",
"anio",
"mes",
),
Index(
"ix_mae_metas_promotores_empresa_promotor",
"empresa_id",
"promotor_id",
),
{
"schema": "fuerza_ventas",
"comment": "Metas y Cuotas Comerciales de Promotores",
},
)
id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
primary_key=True,
server_default=text("gen_random_uuid()"),
comment="Identificador único UUID",
)
empresa_id: Mapped[int] = mapped_column(
BigInteger,
nullable=False,
comment="Identificador UUID de la empresa en core.identidad (RLS)",
)
promotor_id: Mapped[uuid.UUID] = mapped_column(
UUID(as_uuid=True),
nullable=False,
comment="Promotor comercial asignado",
)
anio: Mapped[int] = mapped_column(
Integer,
nullable=False,
comment="Año de la meta (p. ej. 2026)",
)
mes: Mapped[int] = mapped_column(
Integer,
nullable=False,
comment="Mes de la meta (1-12)",
)
meta_monto_ventas: Mapped[Decimal] = mapped_column(
Numeric(12, 2),
nullable=False,
server_default=text("0.00"),
comment="Meta financiera de facturación",
)
meta_cobertura_clientes: Mapped[int] = mapped_column(
Integer,
nullable=False,
server_default=text("0"),
comment="Meta de cantidad de clientes compradores únicos",
)
meta_visitas_efectivas: Mapped[int] = mapped_column(
Integer,
nullable=False,
server_default=text("0"),
comment="Meta de visitas efectivas con transacción",
)
meta_monto_cobranza: Mapped[Decimal] = mapped_column(
Numeric(12, 2),
nullable=False,
server_default=text("0.00"),
comment="Meta de recuperación y cobro de cartera",
)
is_activo: Mapped[bool] = mapped_column(
Boolean,
nullable=False,
server_default=text("true"),
comment="Estado lógico del registro",
)
created_at: Mapped[datetime] = mapped_column(
TIMESTAMPTZ,
nullable=False,
server_default=text("now()"),
comment="Fecha de creación",
)
updated_at: Mapped[datetime] = mapped_column(
TIMESTAMPTZ,
nullable=False,
server_default=text("now()"),
comment="Fecha de última actualización",
)
deleted_at: Mapped[Optional[datetime]] = mapped_column(
TIMESTAMPTZ,
nullable=True,
comment="Fecha de eliminación lógica",
)
created_by: Mapped[Optional[uuid.UUID]] = mapped_column(
UUID(as_uuid=True),
nullable=True,
comment="Usuario creador",
)
updated_by: Mapped[Optional[uuid.UUID]] = mapped_column(
UUID(as_uuid=True),
nullable=True,
comment="Usuario modificador",
)
"""create mae_metas_promotores
Revision ID: mae_0008
Revises: mae_0007
Create Date: 2026-09-09
"""
from typing import Sequence, Union
from alembic import op
import sqlalchemy as sa
from sqlalchemy.dialects import postgresql
# revision identifiers, used by Alembic.
revision: str = "mae_0008"
down_revision: Union[str, Sequence[str], None] = "mae_0007"
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None
def upgrade() -> None:
op.create_table(
"mae_metas_promotores",
sa.Column(
"id",
postgresql.UUID(as_uuid=True),
nullable=False,
server_default=sa.text("gen_random_uuid()"),
comment="Identificador único UUID",
),
sa.Column(
"empresa_id",
sa.BigInteger(),
nullable=False,
comment="Identificador UUID de la empresa en core.identidad (RLS)",
),
sa.Column(
"promotor_id",
postgresql.UUID(as_uuid=True),
nullable=False,
comment="Promotor comercial asignado",
),
sa.Column(
"anio",
sa.Integer(),
nullable=False,
comment="Año de la meta (p. ej. 2026)",
),
sa.Column(
"mes",
sa.Integer(),
nullable=False,
comment="Mes de la meta (1-12)",
),
sa.Column(
"meta_monto_ventas",
sa.Numeric(precision=12, scale=2),
nullable=False,
server_default=sa.text("0.00"),
comment="Meta financiera de facturación",
),
sa.Column(
"meta_cobertura_clientes",
sa.Integer(),
nullable=False,
server_default=sa.text("0"),
comment="Meta de cantidad de clientes compradores únicos",
),
sa.Column(
"meta_visitas_efectivas",
sa.Integer(),
nullable=False,
server_default=sa.text("0"),
comment="Meta de visitas efectivas con transacción",
),
sa.Column(
"meta_monto_cobranza",
sa.Numeric(precision=12, scale=2),
nullable=False,
server_default=sa.text("0.00"),
comment="Meta de recuperación y cobro de cartera",
),
# Auditoría General
sa.Column(
"is_activo",
sa.Boolean(),
nullable=False,
server_default=sa.text("true"),
comment="Estado lógico del registro",
),
sa.Column(
"created_at",
sa.TIMESTAMP(timezone=True),
nullable=False,
server_default=sa.text("now()"),
comment="Fecha de creación",
),
sa.Column(
"updated_at",
sa.TIMESTAMP(timezone=True),
nullable=False,
server_default=sa.text("now()"),
comment="Fecha de última actualización",
),
sa.Column(
"deleted_at",
sa.TIMESTAMP(timezone=True),
nullable=True,
comment="Fecha de eliminación lógica",
),
sa.Column(
"created_by",
postgresql.UUID(as_uuid=True),
nullable=True,
comment="Usuario creador",
),
sa.Column(
"updated_by",
postgresql.UUID(as_uuid=True),
nullable=True,
comment="Usuario modificador",
),
sa.PrimaryKeyConstraint(
"id",
name="pk_mae_metas_promotores",
),
sa.UniqueConstraint(
"empresa_id",
"id",
name="uq_mae_metas_promotores_empresa_id",
),
sa.UniqueConstraint(
"empresa_id",
"promotor_id",
"anio",
"mes",
name="uq_mae_metas_promotores_periodo",
),
sa.CheckConstraint(
"mes BETWEEN 1 AND 12",
name="ck_mae_metas_promotores_mes",
),
sa.ForeignKeyConstraint(
["empresa_id", "promotor_id"],
["fuerza_ventas.mae_promotores.empresa_id", "fuerza_ventas.mae_promotores.id"],
ondelete="CASCADE",
name="fk_mae_metas_promotores_promotor",
),
comment="Metas y Cuotas Comerciales de Promotores",
schema="fuerza_ventas",
)
op.create_index(
"ix_mae_metas_promotores_empresa_activo",
"mae_metas_promotores",
["empresa_id", "is_activo"],
unique=False,
schema="fuerza_ventas",
)
op.create_index(
"ix_mae_metas_promotores_empresa_periodo",
"mae_metas_promotores",
["empresa_id", "anio", "mes"],
unique=False,
schema="fuerza_ventas",
)
op.create_index(
"ix_mae_metas_promotores_empresa_promotor",
"mae_metas_promotores",
["empresa_id", "promotor_id"],
unique=False,
schema="fuerza_ventas",
)
op.execute(
"""
ALTER TABLE fuerza_ventas.mae_metas_promotores
ENABLE ROW LEVEL SECURITY;
"""
)
op.execute(
"""
CREATE POLICY rls_mae_metas_promotores_empresa
ON fuerza_ventas.mae_metas_promotores
FOR ALL
USING (
empresa_id = current_setting(
'app.current_empresa_id',
true
)::BIGINT
)
WITH CHECK (
empresa_id = current_setting(
'app.current_empresa_id',
true
)::BIGINT
);
"""
)
def downgrade() -> None:
op.execute(
"""
DROP POLICY IF EXISTS rls_mae_metas_promotores_empresa
ON fuerza_ventas.mae_metas_promotores;
"""
)
op.execute(
"""
ALTER TABLE fuerza_ventas.mae_metas_promotores
DISABLE ROW LEVEL SECURITY;
"""
)
op.drop_index(
"ix_mae_metas_promotores_empresa_promotor",
table_name="mae_metas_promotores",
schema="fuerza_ventas",
)
op.drop_index(
"ix_mae_metas_promotores_empresa_periodo",
table_name="mae_metas_promotores",
schema="fuerza_ventas",
)
op.drop_index(
"ix_mae_metas_promotores_empresa_activo",
table_name="mae_metas_promotores",
schema="fuerza_ventas",
)
op.drop_table(
"mae_metas_promotores",
schema="fuerza_ventas",
)