docs
This commit is contained in:
151
backend/api/v1/modules/a76/invoices/docs/README.MD
Normal file
151
backend/api/v1/modules/a76/invoices/docs/README.MD
Normal file
@@ -0,0 +1,151 @@
|
||||
# Anexo76 — Documentación del Módulo de Facturas
|
||||
|
||||
> **Sistema:** SCAII · Aduanasoft
|
||||
> **Versión:** 1.0 · Marzo 2026
|
||||
> **Módulos documentados:** `imports/` · `exports/`
|
||||
|
||||
---
|
||||
|
||||
## ¿Qué es este módulo?
|
||||
|
||||
El módulo de facturas gestiona el ciclo completo de las operaciones aduaneras de una empresa maquiladora: la **entrada** de materiales al país (importaciones) y la **salida** (exportaciones). Ambos módulos están conectados a través de un ledger de inventario compartido — las importaciones crean saldos, las exportaciones los consumen.
|
||||
|
||||
---
|
||||
|
||||
## Estructura de la documentación
|
||||
|
||||
```
|
||||
docs/
|
||||
│
|
||||
├── README.md ← estás aquí
|
||||
│
|
||||
├── exports/
|
||||
│ ├── exports_cu_comprensibles.md ← casos de uso
|
||||
│ └── exports_cu_diagramas.md ← diagramas de flujo Mermaid
|
||||
│
|
||||
└── imports/
|
||||
├── imports_cu_comprensibles.md ← casos de uso
|
||||
└── imports_cu_diagramas.md ← diagramas de flujo Mermaid
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Módulo de Exportaciones
|
||||
|
||||
Gestiona la salida de materiales del país. Cada tipo de factura representa un escenario aduanero diferente.
|
||||
|
||||
### Casos de uso
|
||||
|
||||
| ID | Caso de uso | Descripción breve | Diagrama |
|
||||
|----|-------------|-------------------|:--------:|
|
||||
| [CU-EXP-001](./exports/exports_cu_comprensibles.md#cu-exp-001--procesar-una-factura-nodes) | Procesar NODES | Exportación sin descarga de inventario | [→](./exports/exports_cu_diagramas.md#cu-exp-001--procesar-nodes) |
|
||||
| [CU-EXP-002](./exports/exports_cu_comprensibles.md#cu-exp-002--procesar-una-factura-donac) | Procesar DONAC | Donación al extranjero con descarga directa | [→](./exports/exports_cu_diagramas.md#cu-exp-002--procesar-con-descarga-de-inventario-donac) |
|
||||
| [CU-EXP-003](./exports/exports_cu_comprensibles.md#cu-exp-003--procesar-una-factura-afijo) | Procesar AFIJO | Exportación con descarga e IMD opcional | [→](./exports/exports_cu_diagramas.md#cu-exp-003--procesar-afijo-con-cambio-de-régimen) |
|
||||
| [CU-EXP-004](./exports/exports_cu_comprensibles.md#cu-exp-004--procesar-una-factura-scrap) | Procesar SCRAP | Exportación de desperdicio con descarga | [→](./exports/exports_cu_diagramas.md#cu-exp-004--procesar-scrap) |
|
||||
| [CU-EXP-005](./exports/exports_cu_comprensibles.md#cu-exp-005--procesar-una-factura-reexp) | Procesar REEXP | Reexportación desde importaciones definitivas | [→](./exports/exports_cu_diagramas.md#cu-exp-005--procesar-reexp) |
|
||||
| [CU-EXP-006](./exports/exports_cu_comprensibles.md#cu-exp-006--procesar-una-factura-vemex) | Procesar VEMEX | Venta al extranjero desde régimen especial | [→](./exports/exports_cu_diagramas.md#cu-exp-006--procesar-vemex) |
|
||||
| [CU-EXP-007](./exports/exports_cu_comprensibles.md#cu-exp-007--revertir-una-factura-nodes) | Revertir NODES | Deshacer sin efectos en inventario | [→](./exports/exports_cu_diagramas.md#cu-exp-007--revertir-nodes) |
|
||||
| [CU-EXP-008](./exports/exports_cu_comprensibles.md#cu-exp-008--revertir-una-factura-con-descarga-afijo-donac-scrap-reexp-vemex) | Revertir con descarga | Devolver saldos y cancelar registros del ledger | [→](./exports/exports_cu_diagramas.md#cu-exp-008--revertir-con-descarga-afijo-donac-scrap-reexp-vemex) |
|
||||
| [CU-EXP-009](./exports/exports_cu_comprensibles.md#cu-exp-009--reversión-bloqueada-por-exportaciones-activas) | Reversión bloqueada por exportación | Bloqueo cuando otra exportación usa los saldos | [→](./exports/exports_cu_diagramas.md#cu-exp-009--reversión-bloqueada-por-exportaciones-activas) |
|
||||
| [CU-EXP-010](./exports/exports_cu_comprensibles.md#cu-exp-010--reversión-bloqueada-por-importación-definitiva-existente) | Reversión bloqueada por IMD | Bloqueo cuando existe una IMD generada | [→](./exports/exports_cu_diagramas.md#cu-exp-010--reversión-bloqueada-por-importación-definitiva-existente) |
|
||||
|
||||
### Resumen rápido por tipo
|
||||
|
||||
| Tipo | Descarga inventario | Genera IMD | Requiere procedencia |
|
||||
|------|:-------------------:|:----------:|:--------------------:|
|
||||
| NODES | No | No | — |
|
||||
| DONAC | Sí | No | — |
|
||||
| AFIJO | Sí | Solo con cambio de régimen | TEM (si CR) |
|
||||
| SCRAP | Sí | Solo con cambio de régimen | TEM (si CR) |
|
||||
| REEXP | Sí | No | DEF obligatoria |
|
||||
| VEMEX | Sí | No | DEF obligatoria |
|
||||
|
||||
---
|
||||
|
||||
## Módulo de Importaciones
|
||||
|
||||
Gestiona la entrada de materiales al país. Las importaciones temporales (TEM) son la base del inventario que las exportaciones consumen.
|
||||
|
||||
### Casos de uso
|
||||
|
||||
| ID | Caso de uso | Descripción breve | Diagrama |
|
||||
|----|-------------|-------------------|:--------:|
|
||||
| [CU-IMP-001](./imports/imports_cu_comprensibles.md#cu-imp-001--procesar-una-factura-tem-importación-temporal) | Procesar TEM | Entrada temporal, genera saldos de inventario | [→](./imports/imports_cu_diagramas.md#cu-imp-001--procesar-tem-importación-temporal) |
|
||||
| [CU-IMP-002](./imports/imports_cu_comprensibles.md#cu-imp-002--procesar-una-factura-def-importación-definitiva) | Procesar DEF | Entrada definitiva con IVA, sin saldos | [→](./imports/imports_cu_diagramas.md#cu-imp-002--procesar-def-importación-definitiva) |
|
||||
| [CU-IMP-003](./imports/imports_cu_comprensibles.md#cu-imp-003--procesar-una-factura-mex-compra-mexicana) | Procesar MEX | Compra nacional con IVA, sin saldos | [→](./imports/imports_cu_diagramas.md#cu-imp-003--procesar-mex-compra-mexicana) |
|
||||
| [CU-IMP-004](./imports/imports_cu_comprensibles.md#cu-imp-004--procesar-una-factura-tem-con-regla-octava-prosec) | Procesar TEM + PROSEC | TEM con permisos de Regla Octava | [→](./imports/imports_cu_diagramas.md#cu-imp-004--procesar-tem-con-regla-octava-prosec) |
|
||||
| [CU-IMP-005](./imports/imports_cu_comprensibles.md#cu-imp-005--revertir-una-factura-tem) | Revertir TEM | Anular saldos, restaurar cupos PROSEC | [→](./imports/imports_cu_diagramas.md#cu-imp-005--revertir-tem) |
|
||||
| [CU-IMP-006](./imports/imports_cu_comprensibles.md#cu-imp-006--revertir-una-factura-def-o-mex) | Revertir DEF o MEX | Deshacer sin efectos en inventario | [→](./imports/imports_cu_diagramas.md#cu-imp-006--revertir-def-o-mex) |
|
||||
| [CU-IMP-007](./imports/imports_cu_comprensibles.md#cu-imp-007--reversión-bloqueada-por-exportaciones-activas) | Reversión bloqueada | Bloqueo cuando exportaciones usan los saldos | [→](./imports/imports_cu_diagramas.md#cu-imp-007--reversión-bloqueada-por-exportaciones-activas) |
|
||||
|
||||
### Resumen rápido por tipo
|
||||
|
||||
| Tipo | Genera saldo inventario | Calcula IVA | Regla Octava |
|
||||
|------|:-----------------------:|:-----------:|:------------:|
|
||||
| TEM | Sí | No | Opcional |
|
||||
| DEF | No | Sí | No |
|
||||
| MEX | No | Sí | No |
|
||||
|
||||
---
|
||||
|
||||
## Cómo se conectan importaciones y exportaciones
|
||||
|
||||
```
|
||||
Importación TEM procesada
|
||||
│
|
||||
│ crea movimientos ENTRADA en el ledger
|
||||
│ (un registro por partida principal)
|
||||
▼
|
||||
Ledger de inventario (a24.balance_movement)
|
||||
│
|
||||
│ las exportaciones consultan saldos disponibles
|
||||
│ usando criterio PEPS — más antiguo primero
|
||||
▼
|
||||
Exportación procesa (DONAC, AFIJO, SCRAP, REEXP, VEMEX)
|
||||
│
|
||||
│ inserta movimientos CONSUMO
|
||||
│ reduce el saldo disponible
|
||||
▼
|
||||
Si se revierte la exportación → inserta RETORNO
|
||||
Si se revierte la importación → inserta ANULACIÓN DE ENTRADA
|
||||
El ledger nunca se borra — solo se agregan registros
|
||||
```
|
||||
|
||||
**Regla de orden para reversiones:**
|
||||
Siempre deben revertirse primero las exportaciones y luego la importación. El sistema lo garantiza mediante bloqueos automáticos.
|
||||
|
||||
---
|
||||
|
||||
## Estados de una factura
|
||||
|
||||
```
|
||||
PENDIENTE ──[Procesar]──▶ PROCESADA ──[Revertir]──▶ REVERTIDA
|
||||
│
|
||||
│ si hay bloqueos activos
|
||||
▼
|
||||
BLOQUEADA (no es un estado real,
|
||||
el sistema rechaza la operación
|
||||
con un mensaje de error)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Glosario
|
||||
|
||||
| Término | Significado |
|
||||
|---------|-------------|
|
||||
| **TEM** | Importación Temporal — material que entra para ser procesado y reexportado |
|
||||
| **DEF** | Importación Definitiva — material que entra pagando impuestos completos |
|
||||
| **MEX** | Compra a proveedor mexicano |
|
||||
| **IMD** | Importación Definitiva generada automáticamente por un cambio de régimen |
|
||||
| **NODES** | Exportación sin descarga de saldos (No Descarga) |
|
||||
| **AFIJO** | Exportación de material transformado, con descarga de TEM |
|
||||
| **DONAC** | Donación al extranjero con descarga de inventario |
|
||||
| **SCRAP** | Exportación de desperdicio o chatarra |
|
||||
| **REEXP** | Reexportación de material importado definitivamente |
|
||||
| **VEMEX** | Venta al extranjero desde régimen especial (IMMEX / zona franca) |
|
||||
| **PEPS** | Primero en Entrar, Primero en Salir — criterio de consumo de inventario |
|
||||
| **PROSEC** | Programa de Promoción Sectorial — beneficio arancelario para maquiladoras |
|
||||
| **Regla Octava** | Mecanismo de la Ley Aduanera que permite importar con arancel preferencial bajo un permiso PROSEC |
|
||||
| **Ledger a24** | Registro histórico de todos los movimientos de inventario — solo escritura, nunca se borra |
|
||||
| **Cambio de régimen** | Conversión de material temporal a definitivo, requiere generación de IMD |
|
||||
Reference in New Issue
Block a user