Modelo Técnico: Client
Ubicación SSoT:
com.neosystima.app.modules.main.data.model.Client
Campo API: address
String?
1. Definición de Negocio
| Atributo | Detalle |
|---|---|
| Etiqueta | Dirección |
| Descripción | Domicilio físico o fiscal del establecimiento. |
| Dominio | Direcciones |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: TextoRegla UI: Texto estándar o integración con Google Places. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Giro Comercial |
| Descripción | Rubro del negocio (Restaurante, Bar, Fast Food, etc). |
| Dominio | Catálogo Rubros |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: EstándarRegla UI: Selector de rubros. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Tipo de Cliente |
| Descripción | Categoría comercial (B2B, B2C, Franquicia, Propio). |
| Dominio | Catálogo Cliente |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: EstándarRegla UI: Selector de tipos de cliente. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Persona de Contacto |
| Descripción | Nombre de la persona responsable comercial o técnica del lado del cliente. |
| Dominio | Libre |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: TextoRegla UI: Texto estándar. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | MEDIUM |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Suscripción Actual |
| Descripción | Puntero directo al registro de la suscripción que se encuentra activa y rige los cobros actuales. |
| Dominio | Tabla Subscription |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🔴 | Formato: ID ForáneoRegla UI: Deshabilitado o como link a detalle. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Host de Base de Datos |
| Descripción | Dirección IP o DNS del servidor MySQL que aloja el esquema del cliente. |
| Dominio | Infraestructura de Red |
| Público | 🔴 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🔴 | Formato: IPv4 / DNSRegla UI: Campo bloqueado, asignado automáticamente por el orquestador de tenants. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | HIGH |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Nombre de la Base de Datos |
| Descripción | Nombre lógico de la base de datos exclusiva para este cliente. |
| Dominio | Nomenclatura interna BD |
| Público | 🔴 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🔴 | Formato: Alfanumérico (Snake Case)Regla UI: Oculto. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | HIGH |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Contraseña de Base de Datos |
| Descripción | Contraseña cifrada de la conexión al motor de base de datos del cliente. |
| Dominio | Credenciales |
| Público | 🔴 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🔴 | Formato: Hash/CifradoRegla UI: Completamente oculto de todas las interfaces. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | HIGH |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Puerto de Base de Datos |
| Descripción | Puerto de conexión al servidor de base de datos del tenant. |
| Dominio | Puertos TCP |
| Público | 🔴 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🔴 | Formato: EnteroRegla UI: Oculto. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | HIGH |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Usuario de Base de Datos |
| Descripción | Credencial de usuario (Rol de MySQL) para conectarse al esquema del tenant. |
| Dominio | Roles MySQL |
| Público | 🔴 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🔴 | Formato: AlfanuméricoRegla UI: Oculto. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | HIGH |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Fecha de Entrega |
| Descripción | Fecha prometida o real de entrega del sistema configurado al cliente. |
| Dominio | Fechas |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: ISO 8601Regla UI: Selector de Fecha. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Número de Documento |
| Descripción | Identificación fiscal o legal del propietario/empresa responsable del tenant. |
| Dominio | Fiscal |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: AlfanuméricoRegla UI: Input de texto con máscara según el tipo de documento seleccionado. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | MEDIUM |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Tipo de Documento |
| Descripción | Clasificación fiscal del documento del cliente (ej: DNI, CUIT, RUT). |
| Dominio | Tabla DocumentType |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: ID ForáneoRegla UI: Selector filtrado por los tipos de documento activos. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Carpeta de Drive |
| Descripción | Enlace a la carpeta en la nube donde se guarda la documentación técnica o legal del cliente. |
| Dominio | Enlaces Web |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: URLRegla UI: Input tipo URL con validación web. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Fecha de Baja |
| Descripción | Fecha en que el cliente cesó sus operaciones con el sistema. |
| Dominio | Fechas |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: ISO 8601Regla UI: Selector de Fecha. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Cobro Activo |
| Descripción | Indica si el cliente está en flujo de facturación y cobranza periódica. |
| Dominio | {true, false} |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: BooleanoRegla UI: Interruptor (Switch). |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Certificación de Cuenta |
| Descripción | Marca 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)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: BooleanoRegla UI: Checkbox bloqueado, lo cambia el sistema tras validación. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Último Pago |
| Descripción | Fecha de acreditación del último pago recibido por parte del cliente. |
| Dominio | Fechas |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🔴 | Formato: ISO 8601Regla UI: Solo lectura. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Ubicación en Maps |
| Descripción | Enlace a la ubicación del cliente en Google Maps. |
| Dominio | Enlaces Web |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: URLRegla UI: Input tipo URL. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Nombre del Cliente / Comercial |
| Descripción | Nombre de fantasía o comercial del restaurante o establecimiento. |
| Dominio | Libre |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: AlfanuméricoRegla UI: Texto estándar de una línea. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Email Institucional Asignado |
| Descripción | Cuenta 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)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: Email corporativoRegla UI: Validación de correo electrónico. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Notas Administrativas |
| Descripción | Observaciones internas sobre la cuenta o negociaciones. |
| Dominio | Texto libre |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: TextoRegla UI: Área de texto (Textarea). |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Email Personal/Propietario |
| Descripción | Correo del dueño para envío de facturación y comunicaciones urgentes. |
| Dominio | Emails |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: EmailRegla UI: Validación de correo electrónico. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | MEDIUM |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Teléfono |
| Descripción | Número telefónico principal de contacto. |
| Dominio | Números telefónicos |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: Teléfono (E.164 sugerido)Regla UI: Input con máscara telefónica. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | MEDIUM |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Plan Contratado |
| Descripción | Modelo de suscripción comercial base (Ej: Starter, Pro, Premium). Define límites funcionales. |
| Dominio | Tabla Plan |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: ID ForáneoRegla UI: Selector de planes vigentes. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Ejecutivo de Cuentas |
| Descripción | Nombre del vendedor o representante de Neosystima que cerró la cuenta. |
| Dominio | Empleados Plataforma |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: TextoRegla UI: Selector de empleados internos. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Fecha de Inicio Operativo |
| Descripción | Fecha en que el cliente comenzó a operar activamente con el sistema. |
| Dominio | Fechas |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: ISO 8601Regla UI: Selector de Fecha. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Estado de Cuenta |
| Descripción | Controla si el cliente está Activo, Suspendido (falta de pago) o de Baja. Afecta el acceso al tenant completo. |
| Dominio | Tabla Status |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: ID ForáneoRegla UI: Selector de estados del sistema. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Fin de Suscripción |
| Descripción | Fecha en la que finaliza el ciclo facturado de la suscripción actual. |
| Dominio | Fechas |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🔴 | Formato: ISO 8601Regla UI: Solo lectura. Actualizado por el motor de pagos. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Historial de Suscripciones |
| Descripción | Registro de todas las suscripciones, renovaciones y cambios de plan a lo largo de la vida del cliente. |
| Dominio | Tabla Subscription |
| Público | 🔴 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🔴 | Formato: ListaRegla UI: Grilla anidada. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Password Crudo Temporal |
| Descripción | Variable en memoria usada exclusivamente durante el aprovisionamiento para crear la BD física antes de desecharse. |
| Dominio | Memoria RAM |
| Público | 🔴 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🔴 | Formato: StringRegla UI: No renderizar. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | HIGH |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Zona Horaria |
| Descripción | Huso horario local del establecimiento para la sincronización de comandas y reportes. |
| Dominio | IANA Time Zones |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: TZ Database NameRegla UI: Selector de zonas horarias estándar (Autocomplete). |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Fin de Período de Prueba |
| Descripción | Fecha límite si el cliente se encuentra cursando un Trial (Prueba gratuita). |
| Dominio | Fechas |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: ISO 8601Regla UI: Selector de Fecha. |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Código de Referencia |
| Descripción | Identificador ú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. |
| Dominio | Secuencia controlada o formato prefijado |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🟢 Forms: 🟢 | Formato: AlfanuméricoRegla 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ámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Fecha de Creación |
| Descripción | Fecha y hora exacta en la que se insertó el registro por primera vez. |
| Dominio | Fechas válidas pasadas o presentes |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas 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ámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Creado Por |
| Descripción | Identificador principal del usuario que creó originalmente el registro. |
| Dominio | Usuarios válidos en el contexto de seguridad |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: AlfanuméricoRegla 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ámetro | Valor |
|---|---|
| Sensibilidad | MEDIUM |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Identificador del Sistema |
| Descripción | Identificador numérico interno y clave primaria (Primary Key) del registro en la base de datos. |
| Dominio | Números enteros positivos mayores a 0 |
| Público | 🔴 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas 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ámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Registro de Sistema |
| Descripción | Marca 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)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: BooleanoRegla UI: Casilla de verificación (Checkbox) o Interruptor (Toggle). En formularios se muestra deshabilitado (solo lectura). |
3. Seguridad y Auditoría
| Parámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Modificado Por |
| Descripción | Identificador principal del usuario que realizó la última modificación al registro. |
| Dominio | Usuarios válidos en el contexto de seguridad |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas Visuales |
|---|---|
| Grilla: 🔴 Forms: 🟢 | Formato: AlfanuméricoRegla 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ámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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
| Atributo | Detalle |
|---|---|
| Etiqueta | Última Actualización |
| Descripción | Fecha y hora de la última modificación del registro. |
| Dominio | Fechas válidas pasadas o presentes |
| Público | 🟢 |
2. Capa de Interfaz (Frontend)
| Requerimiento | Reglas 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ámetro | Valor |
|---|---|
| Sensibilidad | LOW |
| 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"
}