FactuGES_ERP/docs

ERP Docs

Este directorio reúne la documentación técnica, operativa y de apoyo del ERP.

Cómo leer esta documentación

• Empieza por este índice si necesitas orientarte.
• Usa los documentos en subdirectorios temáticos como fuente de verdad operativa.
• Trata los documentos marcados como históricos o legacy como contexto, no como contrato vigente.

Estructura documental

Documentación vigente

Arquitectura y runtime

• Arquitectura general
• Contexto tenant y X-Company-Id
• Tratamiento de errores HTTP en frontend
• API de autenticación de identity
• Relación entre identity y companies
• Estado de migración a identity

Frontend

• Flujo de auth y selección de empresa
• README de apps/web

Customer invoices y proformas

• Índice de customer-invoices
• Contrato de series de proformas
• Contrato de create de proformas
• Configuración fiscal persistida en proformas
• Reports de proformas

Document series

• README de document-series
• Diseño de document-series
• Validación manual de document-series
• Validación manual de concurrencia

Módulos y runtime local

• README de modules/identity
• README de modules/companies
• README de modules/auth
• API pública de selección y alta rápida de clientes

Guías y estándares

• [Guía de diseño de DTOs](./DTOS - GUÍA DE DISEÑO.md)
• [Convención de nombres de schemas DTO](./CONVENCION NOMBRADO DE ESQUEMAS DTO.md)

SQL operativos y runbooks

• SQL de customer-invoices
• Validación de migración a document-series
• Seed local de admin

Material auxiliar

• Base común para prompts backend
• Prompt de auth
• Prompt de customer invoices
• Plantilla auxiliar

Histórico, transicional o de descubrimiento

Estos documentos se conservan por trazabilidad, auditoría o contexto de decisiones. No deben usarse como fuente de verdad del runtime actual sin contrastarlos con la documentación vigente.

• Borrador legacy de API
• [Requisitos generales históricos](./REQUISITOS GENERALES.md)
• [Requisitos históricos del módulo de clientes](./REQUISITOS CLIENTES.md)
• [Notas históricas de facturas de cliente](./FACTURAS DE CLIENTE.md)
• Split histórico Proforma / IssuedInvoice
• Migración desde customer_invoice_series
• InvoiceSeries legacy

Regla práctica de mantenimiento

• Los documentos operativos vigentes deben vivir en subdirectorios temáticos y tener una responsabilidad clara.
• Los documentos raíz en mayúsculas o con naming heredado deben considerarse legacy o auxiliares salvo que este índice los declare explícitamente vigentes.
• Si una regla ya tiene fuente canónica, los demás documentos deben resumirla y enlazarla, no copiarla.