Saltar al contenido principal

Modelo Técnico: Client

Ubicación SSoT: com.neosystima.app.modules.main.data.model.Client

Campo API: address

String?

1. Definición de Negocio

AtributoDetalle
EtiquetaDirección
DescripciónDomicilio físico o fiscal del establecimiento.
DominioDirecciones
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Texto
Regla UI: Texto estándar o integración con Google Places.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Comercial / Plataforma
  • Validaciones Raw: Opcional.
  • Longitud Max: 100

Ejemplo de Integración:

{
"address": "Av. Siempre Viva 742, Córdoba"
}

Campo API: businessType

String REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaGiro Comercial
DescripciónRubro del negocio (Restaurante, Bar, Fast Food, etc).
DominioCatálogo Rubros
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: Estándar
Regla UI: Selector de rubros.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: RESTO
  • Fuente / Dueño: Comercial / Plataforma
  • Validaciones Raw: Obligatorio.
  • Longitud Max: 20

Ejemplo de Integración:

{
"businessType": "RESTO, CAFE"
}

Campo API: clientType

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaTipo de Cliente
DescripciónCategoría comercial (B2B, B2C, Franquicia, Propio).
DominioCatálogo Cliente
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: Estándar
Regla UI: Selector de tipos de cliente.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Comercial / Plataforma
  • Validaciones Raw: Obligatorio.
  • Longitud Max: 10

Ejemplo de Integración:

{
"clientType": "B2B, DEMO"
}

Campo API: contact

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaPersona de Contacto
DescripciónNombre de la persona responsable comercial o técnica del lado del cliente.
DominioLibre
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: Texto
Regla UI: Texto estándar.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadMEDIUM
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Comercial / Plataforma
  • Validaciones Raw: Obligatorio.
  • Longitud Max: 30

Ejemplo de Integración:

{
"contact": "Carlos Gómez"
}

Campo API: currentSubscription

Subscription?

1. Definición de Negocio

AtributoDetalle
EtiquetaSuscripción Actual
DescripciónPuntero directo al registro de la suscripción que se encuentra activa y rige los cobros actuales.
DominioTabla Subscription
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: ID Foráneo
Regla UI: Deshabilitado o como link a detalle.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Sistema de Facturación / Plataforma
  • Validaciones Raw: Calculado automáticamente.
  • Longitud Max: 255

Ejemplo de Integración:

{
"currentSubscription": "901"
}

Campo API: dbHost

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaHost de Base de Datos
DescripciónDirección IP o DNS del servidor MySQL que aloja el esquema del cliente.
DominioInfraestructura de Red
Público🔴

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: IPv4 / DNS
Regla UI: Campo bloqueado, asignado automáticamente por el orquestador de tenants.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadHIGH
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Orquestador de Infraestructura / Sistemas (DevOps)
  • Validaciones Raw: Único en combinación con puerto y nombre de BD.
  • Longitud Max: 16

Ejemplo de Integración:

{
"dbHost": "192.168.1.50, db01.neo"
}

Campo API: dbName

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaNombre de la Base de Datos
DescripciónNombre lógico de la base de datos exclusiva para este cliente.
DominioNomenclatura interna BD
Público🔴

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: Alfanumérico (Snake Case)
Regla UI: Oculto.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadHIGH
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Orquestador de Infraestructura / Sistemas (DevOps)
  • Validaciones Raw: Único junto con Host y Puerto.
  • Longitud Max: 20

Ejemplo de Integración:

{
"dbName": "tenant_001_db"
}

Campo API: dbPassword

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaContraseña de Base de Datos
DescripciónContraseña cifrada de la conexión al motor de base de datos del cliente.
DominioCredenciales
Público🔴

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: Hash/Cifrado
Regla UI: Completamente oculto de todas las interfaces.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadHIGH
Encriptado🟢
Indexado🔴
Auditado🔴

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Generador de Seguridad / Sistemas (DevOps)
  • Validaciones Raw: Generada automáticamente con alta entropía.
  • Longitud Max: 255

Ejemplo de Integración:

{
"dbPassword": "********"
}

Campo API: dbPort

Int? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaPuerto de Base de Datos
DescripciónPuerto de conexión al servidor de base de datos del tenant.
DominioPuertos TCP
Público🔴

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: Entero
Regla UI: Oculto.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadHIGH
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: 5432
  • Fuente / Dueño: Orquestador de Infraestructura / Sistemas (DevOps)
  • Validaciones Raw: Puerto válido en rango de infraestructura.
  • Longitud Max: 255

Ejemplo de Integración:

{
"dbPort": "5432, 5433"
}

Campo API: dbUser

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaUsuario de Base de Datos
DescripciónCredencial de usuario (Rol de MySQL) para conectarse al esquema del tenant.
DominioRoles MySQL
Público🔴

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: Alfanumérico
Regla UI: Oculto.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadHIGH
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Orquestador de Infraestructura / Sistemas (DevOps)
  • Validaciones Raw: Único junto con Host y Puerto.
  • Longitud Max: 20

Ejemplo de Integración:

{
"dbUser": "usr_tenant_001"
}

Campo API: delivery

LocalDateTime?

1. Definición de Negocio

AtributoDetalle
EtiquetaFecha de Entrega
DescripciónFecha prometida o real de entrega del sistema configurado al cliente.
DominioFechas
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: ISO 8601
Regla UI: Selector de Fecha.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Implementación / Plataforma
  • Validaciones Raw: Opcional.
  • Longitud Max: 255

Ejemplo de Integración:

{
"delivery": "2024-03-05T10:00:00"
}

Campo API: documentNumber

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaNúmero de Documento
DescripciónIdentificación fiscal o legal del propietario/empresa responsable del tenant.
DominioFiscal
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: Alfanumérico
Regla UI: Input de texto con máscara según el tipo de documento seleccionado.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadMEDIUM
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Comercial / Plataforma
  • Validaciones Raw: Único junto con el Tipo de Documento.
  • Longitud Max: 20

Ejemplo de Integración:

{
"documentNumber": "30-12345678-9"
}

Campo API: documentType

DocumentType?

1. Definición de Negocio

AtributoDetalle
EtiquetaTipo de Documento
DescripciónClasificación fiscal del documento del cliente (ej: DNI, CUIT, RUT).
DominioTabla DocumentType
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: ID Foráneo
Regla UI: Selector filtrado por los tipos de documento activos.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Comercial / Plataforma
  • Validaciones Raw: Debe ser un tipo válido y activo.
  • Longitud Max: 255

Ejemplo de Integración:

{
"documentType": "1 (CUIT), 2 (DNI)"
}

Campo API: drive

String?

1. Definición de Negocio

AtributoDetalle
EtiquetaCarpeta de Drive
DescripciónEnlace a la carpeta en la nube donde se guarda la documentación técnica o legal del cliente.
DominioEnlaces Web
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: URL
Regla UI: Input tipo URL con validación web.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Administración / Plataforma
  • Validaciones Raw: Debe ser una URL válida.
  • Longitud Max: 300

Ejemplo de Integración:

{
"drive": "https://drive.google.com/..."
}

Campo API: end

LocalDateTime?

1. Definición de Negocio

AtributoDetalle
EtiquetaFecha de Baja
DescripciónFecha en que el cliente cesó sus operaciones con el sistema.
DominioFechas
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: ISO 8601
Regla UI: Selector de Fecha.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Administración / Plataforma
  • Validaciones Raw: Debe ser posterior a Inicio Operativo.
  • Longitud Max: 255

Ejemplo de Integración:

{
"end": "2026-12-31T23:59:59"
}

Campo API: isCollect

Boolean REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaCobro Activo
DescripciónIndica si el cliente está en flujo de facturación y cobranza periódica.
Dominio{true, false}
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: Booleano
Regla UI: Interruptor (Switch).

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: false
  • Fuente / Dueño: Administración / Plataforma
  • Validaciones Raw: Solo admite true/false.
  • Longitud Max: 255

Ejemplo de Integración:

{
"isCollect": "true / false"
}

Campo API: isOk

Boolean

1. Definición de Negocio

AtributoDetalle
EtiquetaCertificación de Cuenta
DescripciónMarca técnica (OK) que indica que todos los datos y la base de datos del cliente están aprovisionados y verificados.
Dominio{true, false}
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: Booleano
Regla UI: Checkbox bloqueado, lo cambia el sistema tras validación.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: false
  • Fuente / Dueño: Sistema (Healthcheck) / Plataforma
  • Validaciones Raw: N/A
  • Longitud Max: 255

Ejemplo de Integración:

{
"isOk": "true / false"
}

Campo API: lastPaymentDate

LocalDateTime?

1. Definición de Negocio

AtributoDetalle
EtiquetaÚltimo Pago
DescripciónFecha de acreditación del último pago recibido por parte del cliente.
DominioFechas
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: ISO 8601
Regla UI: Solo lectura.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Pasarela de Pagos / Plataforma
  • Validaciones Raw: Actualizado vía Webhooks (ej: Stripe/MercadoPago).
  • Longitud Max: 255

Ejemplo de Integración:

{
"lastPaymentDate": "2024-10-01T15:20:00"
}

Campo API: maps

String?

1. Definición de Negocio

AtributoDetalle
EtiquetaUbicación en Maps
DescripciónEnlace a la ubicación del cliente en Google Maps.
DominioEnlaces Web
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: URL
Regla UI: Input tipo URL.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Comercial / Plataforma
  • Validaciones Raw: Debe ser una URL válida.
  • Longitud Max: 300

Ejemplo de Integración:

{
"maps": "https://maps.app.goo.gl/..."
}

Campo API: name

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaNombre del Cliente / Comercial
DescripciónNombre de fantasía o comercial del restaurante o establecimiento.
DominioLibre
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: Alfanumérico
Regla UI: Texto estándar de una línea.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Ventas / Comercial / Plataforma
  • Validaciones Raw: Único en la base de datos principal.
  • Longitud Max: 50

Ejemplo de Integración:

{
"name": "La Trattoria, Bistró 425"
}

Campo API: neosystimaEmail

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaEmail Institucional Asignado
DescripciónCuenta de correo interno de Neosystima aprovisionada para este cliente (ej: para soporte o notificaciones automáticas).
Dominio@neosystima.com
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Email corporativo
Regla UI: Validación de correo electrónico.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Sistemas / Plataforma
  • Validaciones Raw: Único y obligatorio.
  • Longitud Max: 50

Ejemplo de Integración:

{
"neosystimaEmail": "bistro425@neosystima.com"
}

Campo API: notes

String?

1. Definición de Negocio

AtributoDetalle
EtiquetaNotas Administrativas
DescripciónObservaciones internas sobre la cuenta o negociaciones.
DominioTexto libre
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Texto
Regla UI: Área de texto (Textarea).

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Administración / Plataforma
  • Validaciones Raw: Máximo 350 caracteres.
  • Longitud Max: 350

Ejemplo de Integración:

{
"notes": "Cliente VIP, solicita facturación el día 5."
}

Campo API: personalEmail

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaEmail Personal/Propietario
DescripciónCorreo del dueño para envío de facturación y comunicaciones urgentes.
DominioEmails
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Email
Regla UI: Validación de correo electrónico.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadMEDIUM
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Comercial / Plataforma
  • Validaciones Raw: Único y obligatorio.
  • Longitud Max: 50

Ejemplo de Integración:

{
"personalEmail": "dueno@resto.com"
}

Campo API: phone

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaTeléfono
DescripciónNúmero telefónico principal de contacto.
DominioNúmeros telefónicos
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Teléfono (E.164 sugerido)
Regla UI: Input con máscara telefónica.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadMEDIUM
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Comercial / Plataforma
  • Validaciones Raw: Obligatorio.
  • Longitud Max: 30

Ejemplo de Integración:

{
"phone": "+5491123456789"
}

Campo API: plan

Plan?

1. Definición de Negocio

AtributoDetalle
EtiquetaPlan Contratado
DescripciónModelo de suscripción comercial base (Ej: Starter, Pro, Premium). Define límites funcionales.
DominioTabla Plan
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: ID Foráneo
Regla UI: Selector de planes vigentes.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Ventas / Plataforma
  • Validaciones Raw: Obligatorio.
  • Longitud Max: 255

Ejemplo de Integración:

{
"plan": "2 (Plan Pro)"
}

Campo API: seller

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaEjecutivo de Cuentas
DescripciónNombre del vendedor o representante de Neosystima que cerró la cuenta.
DominioEmpleados Plataforma
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: Texto
Regla UI: Selector de empleados internos.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Ventas / Plataforma
  • Validaciones Raw: Obligatorio.
  • Longitud Max: 30

Ejemplo de Integración:

{
"seller": "Vendedor_01"
}

Campo API: start

LocalDateTime?

1. Definición de Negocio

AtributoDetalle
EtiquetaFecha de Inicio Operativo
DescripciónFecha en que el cliente comenzó a operar activamente con el sistema.
DominioFechas
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: ISO 8601
Regla UI: Selector de Fecha.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Implementación / Plataforma
  • Validaciones Raw: Opcional.
  • Longitud Max: 255

Ejemplo de Integración:

{
"start": "2024-03-01T10:00:00"
}

Campo API: status

Status?

1. Definición de Negocio

AtributoDetalle
EtiquetaEstado de Cuenta
DescripciónControla si el cliente está Activo, Suspendido (falta de pago) o de Baja. Afecta el acceso al tenant completo.
DominioTabla Status
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: ID Foráneo
Regla UI: Selector de estados del sistema.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Sistema / Administración / Plataforma
  • Validaciones Raw: Obligatorio.
  • Longitud Max: 255

Ejemplo de Integración:

{
"status": "1 (Activo), 4 (Suspendido)"
}

Campo API: subscriptionEndDate

LocalDateTime?

1. Definición de Negocio

AtributoDetalle
EtiquetaFin de Suscripción
DescripciónFecha en la que finaliza el ciclo facturado de la suscripción actual.
DominioFechas
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🔴
Formato: ISO 8601
Regla UI: Solo lectura. Actualizado por el motor de pagos.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Sistema / Plataforma
  • Validaciones Raw: Calculado desde Suscripción Actual.
  • Longitud Max: 255

Ejemplo de Integración:

{
"subscriptionEndDate": "2024-11-01T00:00:00"
}

Campo API: subscriptions

Subscription>

1. Definición de Negocio

AtributoDetalle
EtiquetaHistorial de Suscripciones
DescripciónRegistro de todas las suscripciones, renovaciones y cambios de plan a lo largo de la vida del cliente.
DominioTabla Subscription
Público🔴

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: Lista
Regla UI: Grilla anidada.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🔴

4. Especificaciones Técnicas

  • Valor Default: Lista Vacía
  • Fuente / Dueño: Sistema / Plataforma
  • Validaciones Raw: N/A
  • Longitud Max: 255

Ejemplo de Integración:

{
"subscriptions": "[]"
}

Campo API: tempRawPassword

String?

1. Definición de Negocio

AtributoDetalle
EtiquetaPassword Crudo Temporal
DescripciónVariable en memoria usada exclusivamente durante el aprovisionamiento para crear la BD física antes de desecharse.
DominioMemoria RAM
Público🔴

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: String
Regla UI: No renderizar.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadHIGH
Encriptado🔴
Indexado🔴
Auditado🔴

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Motor de Aprovisionamiento / Sistema
  • Validaciones Raw: N/A
  • Longitud Max: 255

Ejemplo de Integración:

{
"tempRawPassword": "T3mpP@ssw0rd!"
}

Campo API: timezone

String REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaZona Horaria
DescripciónHuso horario local del establecimiento para la sincronización de comandas y reportes.
DominioIANA Time Zones
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: TZ Database Name
Regla UI: Selector de zonas horarias estándar (Autocomplete).

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: UTC
  • Fuente / Dueño: Implementación / Plataforma
  • Validaciones Raw: Debe ser un ID válido de la base de datos IANA.
  • Longitud Max: 50

Ejemplo de Integración:

{
"timezone": "America/Argentina/Cordoba"
}

Campo API: trialEndDate

LocalDateTime?

1. Definición de Negocio

AtributoDetalle
EtiquetaFin de Período de Prueba
DescripciónFecha límite si el cliente se encuentra cursando un Trial (Prueba gratuita).
DominioFechas
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: ISO 8601
Regla UI: Selector de Fecha.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Ventas / Automático / Plataforma
  • Validaciones Raw: Opcional.
  • Longitud Max: 255

Ejemplo de Integración:

{
"trialEndDate": "2024-03-15T23:59:59"
}

Campo API: code

String? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaCódigo de Referencia
DescripciónIdentificador único de negocio para el registro.A diferencia del ID numérico interno, este código está pensado para ser expuesto y facilitar búsquedas o referencias.
DominioSecuencia controlada o formato prefijado
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🟢
Forms: 🟢
Formato: Alfanumérico
Regla UI: Se muestra como referencia (usualmente entre paréntesis) junto al título del formulario. No es un campo editable en el flujo estándar.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🟢
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: Generado por secuencia
  • Fuente / Dueño: Generado automáticamente por el motor de secuencias del sistema / Sistema
  • Validaciones Raw: Debe ser estrictamente único en toda la tabla.
  • Longitud Max: 20

Ejemplo de Integración:

{
"code": "000001, CLI-005, STY-20"
}

Campo API: createdAt

Instant? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaFecha de Creación
DescripciónFecha y hora exacta en la que se insertó el registro por primera vez.
DominioFechas válidas pasadas o presentes
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Timestamp (ISO 8601)
Regla UI: Selector de fecha/hora. En creación está oculto, en edición se muestra como solo lectura.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🔴

4. Especificaciones Técnicas

  • Valor Default: CURRENT_TIMESTAMP
  • Fuente / Dueño: Generado automáticamente por el framework de auditoría / Sistema
  • Validaciones Raw: No modificable tras su creación (updatable = false).
  • Longitud Max: 255

Ejemplo de Integración:

{
"createdAt": "2025-10-15T14:30:00Z"
}

Campo API: createdBy

String?

1. Definición de Negocio

AtributoDetalle
EtiquetaCreado Por
DescripciónIdentificador principal del usuario que creó originalmente el registro.
DominioUsuarios válidos en el contexto de seguridad
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Alfanumérico
Regla UI: Campo de texto estándar. En creación está oculto, en edición se muestra como solo lectura.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadMEDIUM
Encriptado🔴
Indexado🔴
Auditado🔴

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Extraído del contexto de seguridad (SecurityContext) / Sistema
  • Validaciones Raw: No modificable tras la creación.
  • Longitud Max: 50

Ejemplo de Integración:

{
"createdBy": "admin, guest, USR-001"
}

Campo API: id

Long? REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaIdentificador del Sistema
DescripciónIdentificador numérico interno y clave primaria (Primary Key) del registro en la base de datos.
DominioNúmeros enteros positivos mayores a 0
Público🔴

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🔴
Formato: Numérico (BigInt)
Regla UI: Campo oculto o deshabilitado. No se expone directamente al usuario final para edición.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🟢
Auditado🔴

4. Especificaciones Técnicas

  • Valor Default: Asignación automática
  • Fuente / Dueño: Autoincrementable y asignado por el motor de BD al insertar (INSERT). / Sistema
  • Validaciones Raw: Único e irrepetible. De solo lectura tras su creación.
  • Longitud Max: 255

Ejemplo de Integración:

{
"id": "1, 2, 1054"
}

Campo API: isSystem

Boolean REQUIRED

1. Definición de Negocio

AtributoDetalle
EtiquetaRegistro de Sistema
DescripciónMarca técnica que indica si el registro fue creado por el sistema y posee restricciones (ej: no se puede borrar o editar su código).
Dominio{true, false}
Público🔴

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Booleano
Regla UI: Casilla de verificación (Checkbox) o Interruptor (Toggle). En formularios se muestra deshabilitado (solo lectura).

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🟢

4. Especificaciones Técnicas

  • Valor Default: false
  • Fuente / Dueño: Generado por el sistema / Sistema
  • Validaciones Raw: No modificable por el usuario final (bloqueado a nivel de servicio).
  • Longitud Max: 255

Ejemplo de Integración:

{
"isSystem": "true, false"
}

Campo API: lastModifiedBy

String?

1. Definición de Negocio

AtributoDetalle
EtiquetaModificado Por
DescripciónIdentificador principal del usuario que realizó la última modificación al registro.
DominioUsuarios válidos en el contexto de seguridad
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Alfanumérico
Regla UI: Campo de texto estándar. En creación está oculto, en edición se muestra como solo lectura.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🔴

4. Especificaciones Técnicas

  • Valor Default: N/A
  • Fuente / Dueño: Extraído del contexto de seguridad (SecurityContext) / Sistema
  • Validaciones Raw: Ninguna adicional.
  • Longitud Max: 50

Ejemplo de Integración:

{
"lastModifiedBy": "admin, manager"
}

Campo API: updatedAt

Instant?

1. Definición de Negocio

AtributoDetalle
EtiquetaÚltima Actualización
DescripciónFecha y hora de la última modificación del registro.
DominioFechas válidas pasadas o presentes
Público🟢

2. Capa de Interfaz (Frontend)

RequerimientoReglas Visuales
Grilla: 🔴
Forms: 🟢
Formato: Timestamp (ISO 8601)
Regla UI: Selector de fecha/hora. En creación está oculto, en edición se muestra como solo lectura.

3. Seguridad y Auditoría

ParámetroValor
SensibilidadLOW
Encriptado🔴
Indexado🔴
Auditado🔴

4. Especificaciones Técnicas

  • Valor Default: CURRENT_TIMESTAMP
  • Fuente / Dueño: Generado automáticamente por el framework de auditoría / Sistema
  • Validaciones Raw: Se actualiza automáticamente en cada operación de modificación (UPDATE).
  • Longitud Max: 255

Ejemplo de Integración:

{
"updatedAt": "2025-10-16T09:15:00Z"
}