Especificación Técnica: `cat_estados_visita`¶

Esquema: clientes
Base de Datos: crm
Tabla Legacy Origen: c063t_agenda_actividades (co_estatus)
Propósito: Máquina de estados de la gestión de visitas en campo (PROGRAMADA, EN_RUTA, INICIADA_CHECKIN, COMPLETADA_CHECKOUT, CANCELADA_NO_CONTACTO, REPROGRAMADA).

1. Justificación y Mejoras de Arquitectura¶

Estandariza catálogos tipados con UUID, multitenancy RLS por empresa y claves únicas de código de negocio, eliminando cadenas sueltas y tablas desnormalizadas.
Multi-tenancy RLS y Auditoría Estándar: Cada tabla incluye empresa_id BIGINT NOT NULL, utilizado para el aislamiento multiempresa mediante políticas RLS y como identificador de la empresa en core.identidad. Además, incorpora trazabilidad mediante created_at, updated_at, deleted_at, created_by, updated_by y version.
Integridad referencial con transaccionales: Incluye constraint única compuesta (empresa_id, id) para permitir la FK compuesta desde trx_visitas garantizando coherencia de tenant.

2. Definiciones de Implementación¶

DBMLSQLSQLAlchemyAlembic

Table clientes.cat_estados_visita {
    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)']
    codigo              varchar(30)   [not null, note: 'Código único del estado de visita']
    nombre              varchar(100)  [not null, note: 'Nombre del estado']
    is_estado_final     boolean       [not null, default: `false`, note: 'Indica si concluye el ciclo de la visita']
    is_visita_efectiva  boolean       [not null, default: `false`, note: 'Indica si suma como visita efectiva para KPIs comerciales']

    // 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_cat_estados_visita_empresa_id']
        (empresa_id, codigo) [unique, name: 'uq_cat_estados_visita_empresa_codigo']
        (empresa_id, is_activo) [name: 'ix_cat_estados_visita_empresa_activo']
        (empresa_id, is_estado_final) [name: 'ix_cat_estados_visita_empresa_final']
    }
}

CREATE TABLE IF NOT EXISTS clientes.cat_estados_visita (
    id UUID NOT NULL DEFAULT gen_random_uuid(),
    empresa_id BIGINT NOT NULL,
    codigo VARCHAR(30) NOT NULL,
    nombre VARCHAR(100) NOT NULL,
    is_estado_final BOOLEAN NOT NULL DEFAULT false,
    is_visita_efectiva BOOLEAN NOT NULL DEFAULT false,

    -- 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_cat_estados_visita
        PRIMARY KEY (id),

    CONSTRAINT uq_cat_estados_visita_empresa_id
        UNIQUE (empresa_id, id),

    CONSTRAINT uq_cat_estados_visita_empresa_codigo
        UNIQUE (empresa_id, codigo)
);

CREATE INDEX IF NOT EXISTS ix_cat_estados_visita_empresa_activo
    ON clientes.cat_estados_visita (empresa_id, is_activo);

CREATE INDEX IF NOT EXISTS ix_cat_estados_visita_empresa_final
    ON clientes.cat_estados_visita (empresa_id, is_estado_final);

COMMENT ON TABLE clientes.cat_estados_visita IS
    'Estados de Visita en Ruta: Máquina de estados de la gestión de visitas en campo (PROGRAMADA, EN_RUTA, INICIADA_CHECKIN, COMPLETADA_CHECKOUT, CANCELADA_NO_CONTACTO, REPROGRAMADA).';

COMMENT ON COLUMN clientes.cat_estados_visita.id IS
    'Identificador único UUID';

COMMENT ON COLUMN clientes.cat_estados_visita.empresa_id IS
    'Identificador UUID de la empresa en core.identidad (RLS)';

COMMENT ON COLUMN clientes.cat_estados_visita.codigo IS
    'Código único del estado de visita';

COMMENT ON COLUMN clientes.cat_estados_visita.nombre IS
    'Nombre del estado';

COMMENT ON COLUMN clientes.cat_estados_visita.is_estado_final IS
    'Indica si concluye el ciclo de la visita';

COMMENT ON COLUMN clientes.cat_estados_visita.is_visita_efectiva IS
    'Indica si suma como visita efectiva para KPIs comerciales';

COMMENT ON COLUMN clientes.cat_estados_visita.is_activo IS
    'Estado lógico del registro';

COMMENT ON COLUMN clientes.cat_estados_visita.created_at IS
    'Fecha de creación';

COMMENT ON COLUMN clientes.cat_estados_visita.updated_at IS
    'Fecha de última actualización';

COMMENT ON COLUMN clientes.cat_estados_visita.deleted_at IS
    'Fecha de eliminación lógica';

COMMENT ON COLUMN clientes.cat_estados_visita.created_by IS
    'Usuario creador';

COMMENT ON COLUMN clientes.cat_estados_visita.updated_by IS
    'Usuario modificador';

ALTER TABLE clientes.cat_estados_visita
    ENABLE ROW LEVEL SECURITY;

CREATE POLICY rls_cat_estados_visita_empresa
    ON clientes.cat_estados_visita
    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 typing import Optional

from sqlalchemy import (
    BigInteger,
    Boolean,
    Index,
    String,
    UniqueConstraint,
    text,
)
from sqlalchemy.dialects.postgresql import TIMESTAMPTZ, UUID
from sqlalchemy.orm import Mapped, mapped_column

from app.db.base import Base


class CatEstadosVisita(Base):
    """
    Estados de Visita en Ruta.

    Máquina de estados de la gestión de visitas en campo
    (PROGRAMADA, EN_RUTA, INICIADA_CHECKIN, COMPLETADA_CHECKOUT,
    CANCELADA_NO_CONTACTO, REPROGRAMADA).

    Legacy:
        c063t_agenda_actividades (co_estatus)
    """

    __tablename__ = "cat_estados_visita"

    __table_args__ = (
        UniqueConstraint(
            "empresa_id",
            "id",
            name="uq_cat_estados_visita_empresa_id",
        ),
        UniqueConstraint(
            "empresa_id",
            "codigo",
            name="uq_cat_estados_visita_empresa_codigo",
        ),
        Index(
            "ix_cat_estados_visita_empresa_activo",
            "empresa_id",
            "is_activo",
        ),
        Index(
            "ix_cat_estados_visita_empresa_final",
            "empresa_id",
            "is_estado_final",
        ),
        {
            "schema": "clientes",
            "comment": "Estados de Visita en Ruta",
        },
    )

    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)",
    )

    codigo: Mapped[str] = mapped_column(
        String(30),
        nullable=False,
        comment="Código único del estado de visita",
    )

    nombre: Mapped[str] = mapped_column(
        String(100),
        nullable=False,
        comment="Nombre del estado",
    )

    is_estado_final: Mapped[bool] = mapped_column(
        Boolean,
        nullable=False,
        server_default=text("false"),
        comment="Indica si concluye el ciclo de la visita",
    )

    is_visita_efectiva: Mapped[bool] = mapped_column(
        Boolean,
        nullable=False,
        server_default=text("false"),
        comment="Indica si suma como visita efectiva para KPIs comerciales",
    )

    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 cat_estados_visita

Revision ID: 0018
Revises: 0017
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 = "0018"
down_revision: Union[str, Sequence[str], None] = "0017"
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None


def upgrade() -> None:

    op.create_table(
        "cat_estados_visita",

        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(
            "codigo",
            sa.String(length=30),
            nullable=False,
            comment="Código único del estado de visita",
        ),

        sa.Column(
            "nombre",
            sa.String(length=100),
            nullable=False,
            comment="Nombre del estado",
        ),

        sa.Column(
            "is_estado_final",
            sa.Boolean(),
            nullable=False,
            server_default=sa.text("false"),
            comment="Indica si concluye el ciclo de la visita",
        ),

        sa.Column(
            "is_visita_efectiva",
            sa.Boolean(),
            nullable=False,
            server_default=sa.text("false"),
            comment="Indica si suma como visita efectiva para KPIs comerciales",
        ),

        # 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_cat_estados_visita",
        ),

        sa.UniqueConstraint(
            "empresa_id",
            "id",
            name="uq_cat_estados_visita_empresa_id",
        ),

        sa.UniqueConstraint(
            "empresa_id",
            "codigo",
            name="uq_cat_estados_visita_empresa_codigo",
        ),

        comment="Estados de Visita en Ruta",
        schema="clientes",
    )

    op.create_index(
        "ix_cat_estados_visita_empresa_activo",
        "cat_estados_visita",
        ["empresa_id", "is_activo"],
        unique=False,
        schema="clientes",
    )

    op.create_index(
        "ix_cat_estados_visita_empresa_final",
        "cat_estados_visita",
        ["empresa_id", "is_estado_final"],
        unique=False,
        schema="clientes",
    )

    op.execute(
        """
        ALTER TABLE clientes.cat_estados_visita
        ENABLE ROW LEVEL SECURITY;
        """
    )

    op.execute(
        """
        CREATE POLICY rls_cat_estados_visita_empresa
        ON clientes.cat_estados_visita
        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_cat_estados_visita_empresa
        ON clientes.cat_estados_visita;
        """
    )

    op.execute(
        """
        ALTER TABLE clientes.cat_estados_visita
        DISABLE ROW LEVEL SECURITY;
        """
    )

    op.drop_index(
        "ix_cat_estados_visita_empresa_final",
        table_name="cat_estados_visita",
        schema="clientes",
    )

    op.drop_index(
        "ix_cat_estados_visita_empresa_activo",
        table_name="cat_estados_visita",
        schema="clientes",
    )

    op.drop_table(
        "cat_estados_visita",
        schema="clientes",
    )

Especificación Técnica: cat_estados_visita¶

1. Justificación y Mejoras de Arquitectura¶

2. Definiciones de Implementación¶

Especificación Técnica: `cat_estados_visita`¶