99 lines
5.1 KiB
Markdown
99 lines
5.1 KiB
Markdown
# 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.
|
|
- Si hay duda sobre qué documento manda, consulta la [auditoría SSOT](./documentation-ssot-audit.md).
|
|
|
|
## Estructura documental
|
|
|
|
### Documentación vigente
|
|
|
|
#### Arquitectura y runtime
|
|
|
|
- [Arquitectura general](./architecture/README.md)
|
|
- [Requisitos de `companies`](./companies/company-requirements.md)
|
|
- [Contexto tenant y `X-Company-Id`](./architecture/tenant-context.md)
|
|
- [Tratamiento de errores HTTP en frontend](./architecture/http-error-handling-frontend.md)
|
|
- [API de autenticación de `identity`](./architecture/identity-auth-api.md)
|
|
- [Relación entre `identity` y `companies`](./architecture/identity-and-companies.md)
|
|
- [Estado de migración a `identity`](./architecture/identity-migration-status.md)
|
|
|
|
#### Frontend
|
|
|
|
- [Flujo de auth y selección de empresa](./frontend/auth-and-company-selection.md)
|
|
- [Diseño de pantallas de listado](./frontend/diseno-pantallas-listado.md)
|
|
- [Sistema modular de Settings](./settings/frontend-erp-settings-system-design.md)
|
|
- [Integración de módulos con Settings](./settings/frontend-erp-settings-module-integration-design.md)
|
|
- [README de `apps/web`](../apps/web/README.md)
|
|
|
|
#### Customer invoices y proformas
|
|
|
|
- [Índice de `customer-invoices`](./customer-invoices/README.md)
|
|
- [Auditoría SSOT documental](./documentation-ssot-audit.md)
|
|
- [Plazos de pago](./catalogs/payment-terms.md)
|
|
- [Diseño backend del perfil VeriFactu empresarial](./customer-invoices/settings/verifactu-company-profile-backend-design.md)
|
|
Documento parcialmente superado: sigue siendo canónico para `CompanyVerifactuProfile`, pero no para reintroducir `IssuedInvoice.verifactuPolicy`.
|
|
- [Diseño frontend de Settings para VeriFactu](./customer-invoices/settings/frontend-erp-settings-verifactu-design.md)
|
|
- [Contrato de series de proformas](./customer-invoices/proforma-series-contract.md)
|
|
- [Contrato de create de proformas](./customer-invoices/proforma-create-contract.md)
|
|
- [Configuración fiscal persistida en proformas](./customer-invoices/proforma-tax-config.md)
|
|
- [Reports de proformas](./customer-invoices/proformas-reports.md)
|
|
|
|
#### Document series
|
|
|
|
- [README de `document-series`](./document-series/README.md)
|
|
- [Diseño de `document-series`](./document-series/document-series-design.md)
|
|
- [Validación manual de `document-series`](./document-series/manual-validation.md)
|
|
- [Validación manual de concurrencia](./document-series/manual-concurrency-validation.md)
|
|
|
|
#### Módulos y runtime local
|
|
|
|
- [README de `modules/identity`](../modules/identity/README.md)
|
|
- [README de `modules/companies`](../modules/companies/README.md)
|
|
- [README de `modules/auth`](../modules/auth/README.md)
|
|
- [API pública de selección y alta rápida de clientes](./customers/customer-selection-and-quick-create.md)
|
|
- [Tests HTTP backend](./testing/backend-http-integration.md)
|
|
- [Harness frontend con `node:test`](./testing/frontend-node-test.md)
|
|
|
|
#### 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`](./customer-invoices/sql/README.md)
|
|
- [Validación de migración a `document-series`](./document-series/sql/validate-document-series-migration.sql)
|
|
- [Seed local de admin](./dev/seed-local-admin.sql)
|
|
|
|
### Material auxiliar
|
|
|
|
- [Base común para prompts backend](./backend-prompt-base.md)
|
|
- [Prompt de auth](./prompt-auth.md)
|
|
- [Prompt de customer invoices](./prompt-customer-invoices.md)
|
|
- [Plantilla auxiliar](./TEMPLATE.md)
|
|
|
|
### 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](./API.md)
|
|
- [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](./customer-invoices/split-proformas-issued-invoices-migration.md)
|
|
- [Migración desde `customer_invoice_series`](./document-series/migration-from-customer-invoice-series.md)
|
|
- [InvoiceSeries legacy](./customer-invoices/invoice-series.md)
|
|
|
|
## 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.
|
|
- Para VeriFactu e `IssuedInvoice`, el estado vigente es: sin `verifactuPolicy`, cardinalidad actual `1 -> 0..1`, objetivo futuro `1 -> 0..N`.
|