Actualización de documentación #3 — Fin del ciclo de release

28 de julio de 2025 Actualizado Cerramos el último ciclo de release con una gran ronda de actualizaciones en toda la documentación de Lerian. Desde reglas de enrutamiento flexibles hasta workflows de plugins más inteligentes y una estructura de sitio más intuitiva, esta versión facilita construir, probar y crecer con confianza.

​

Nueva estructura, navegación más clara

---

Reestructuramos tanto las Guías como la Referencia de API para hacer la navegación más rápida e intuitiva. El nuevo diseño separa conceptos principales, plugins y SDKs, y te ayuda a enfocarte en lo que más importa, ya sea que estés empezando o en plena implementación.

​

Partner’s Hub

---

También lanzamos el Partners Hub: un espacio centralizado para nuestros socios de desarrollo. Incluye estándares técnicos, reglas de documentación y mejores prácticas para que tus plugins se integren sin fricción con el ecosistema Midaz.

​

Mejoras generales

---

​

Midaz Core

• Los campos amount y scale se reemplazaron por un campo value unificado de tipo string (que debe contener un valor numérico).
• Los campos chartOfAccountsGroup y chartOfAccounts quedaron obsoletos.
• El campo type en la Accounts API ahora es condicional:
• Cuando la función Account Types está deshabilitada, type es opcional y acepta cualquier cadena de texto libre.
• Cuando está habilitada, type pasa a ser obligatorio y debe coincidir con uno de los valores registrados en la Account Types API.

​

Limpieza de headers de solicitud

El header X-Lerian-Id se eliminó de los endpoints de plugins para simplificar la integración.

​

Nuevo flag pending

Ahora puedes definir el flag pending en el payload de Create Transaction Using JSON, que admite flujos en dos fases con los endpoints commit/cancel.

​

Sandbox ya está disponible

Todas las APIs de Midaz y de los plugins ahora admiten Try It en la documentación.

• También publicamos una guía de Sandbox para ayudarte a probar de forma segura y rápida.

​

Guías nuevas y actualizadas

---

​

Conceptos principales

Agregamos nuevas guías conceptuales y de implementación para acompañar el lanzamiento de dos nuevas funciones principales:

• Account Types – Define y gestiona categorías de cuentas personalizadas (por ejemplo, activo, pasivo, ingreso) que se usan en toda tu organización. Ahora se referencian al crear cuentas.
• Transaction Routing – Enruta transacciones y operaciones automáticamente según el tipo y los metadatos—sin necesidad de fijar en el código alias o IDs de cuentas.

Estas actualizaciones ayudan a los equipos a construir una lógica financiera más limpia y escalable en todos los ledgers.

​

Página nueva

• Transaction Routing Entities – Página nueva sobre cómo usar Transaction Routes y Operation Routes.

​

Páginas actualizadas

• Acerca de Midaz
• Modelo de datos
• Entidades principales
• Cuentas
• Transacciones
• Operaciones

​

Guías de UI de plugins

Agregamos orientación práctica para usar plugins directamente desde Midaz Console:

• Uso de Access Manager con Midaz Console – Gestiona usuarios y aplicaciones con un modelo RBAC centralizado.
• Uso de CRM con Midaz Console – Crea y actualiza Holders y Account Aliases desde la UI.
• Uso de Fee Engine con Midaz Console – Interfaz visual para crear paquetes y reglas.
• Uso de Reporter con Midaz Console – Sube archivos .tpl, filtra datos y genera informes.

​

Actualizaciones de la Referencia

• Reintentos e idempotencia – Ampliada con ejemplos y estrategias.
• FAQ – Ahora cubre preguntas comunes sobre idempotencia y reintentos ante errores.
• Observabilidad en Midaz – Actualizada con el nuevo stack de telemetría y el flujo basado en OpenTelemetry.

​

Licencia de Lerian

• Página de licencia de Lerian – Ya está disponible en la Referencia una página nueva que detalla los términos de licencia de Lerian.

​

Midaz Console

• Nuevas etiquetas de botones – Actualizamos la terminología de la Console para editar Organizaciones, Ledgers, Activos, Segmentos, Portafolios y Cuentas.

​

APIs nuevas y actualizadas

---

Las nuevas APIs y los endpoints ampliados facilitan automatizar la lógica contable, controlar el flujo de transacciones y generar informes dinámicos.

​

Puertos de red predeterminados

---

Agregamos una página nueva con los puertos predeterminados que usan Midaz y sus plugins: Puertos de red predeterminados. Si haces el despliegue en un entorno self-hosted, esta guía ayuda a confirmar que tu infraestructura está configurada correctamente.

​

Dominio Transaction

– Transaction RoutingIntrodujimos una nueva función potente: Transaction Routing. Estas APIs permiten incorporar la lógica contable directamente en tus flujos financieros y automatizan cómo se clasifican y registran las operaciones.

• Transaction Routes API – Define cómo se deben enrutar las transacciones completas según el tipo. Esto habilita el mapeo dinámico de los flujos de transacción a tu plan de cuentas.
• Operation Routes API – Establece reglas sobre cómo se enrutan las operaciones individuales de débito y crédito hacia tipos de cuenta específicos, y reduce la necesidad de fijar cuentas en el código de las transacciones.

Estas herramientas ayudan a lograr mayor automatización, auditabilidad y alineación con la estructura contable de tu organización.

​

Dominio Onboarding – Account Types

• Account Types API – Define y gestiona categorías de cuentas personalizadas. Una vez habilitados, estos tipos pasan a ser obligatorios en el proceso de creación de cuentas, lo que asegura consistencia en todo tu ledger.

​

Saldos en tiempo real

La sección Balances ahora incluye endpoints para monitorear posiciones en tiempo real—crítico para casos de uso de tesorería, cumplimiento y conciliación:

• Retrieve Balance by Account Alias – Obtén el saldo de cualquier cuenta usando su alias legible por humanos.
• Retrieve Balance of an External Account – Obtén los saldos actuales de cuentas externas como @external/BRL, que suelen usarse para rastrear entradas y salidas fuera de tu ledger interno.

​

Transacciones en dos fases

También introdujimos las Transacciones en dos fases, que te dan un control más estricto sobre la finalización de transacciones:

• Commit a Pending Transaction – Finaliza una transacción que antes se marcó como pendiente.
• Cancel a Pending Transaction – Cancela una transacción pendiente antes de que se confirme en el ledger.

Esto habilita workflows avanzados como la prevalidación de transacciones, la ejecución diferida o las aprobaciones condicionales.

​

Mejoras en los plugins

---

​

Fee Engine

Fee Engine se actualizó para acompañar las mejoras hechas en Midaz Core y dar más control sobre cómo se calculan y registran las comisiones. Novedades:

• Campos como transactionRoute, routeFrom y routeTo ahora permiten un enrutamiento más granular por ítem de comisión.
• El flag isDeductibleFrom ayuda a definir si una comisión se debe deducir proporcionalmente del total de la transacción.
• Los débitos y créditos de comisiones ahora se separan por cuenta, lo que mejora la claridad.
• Se eliminaron los campos antiguos chartOfAccounts.
• Los montos ahora usan un campo value unificado de tipo string.

Estos cambios ayudan a aplicar comisiones con precisión, en múltiples rutas contables, y a asegurar el cumplimiento de la lógica interna de enrutamiento.

​

Smart Templates

El plugin Smart Templates ahora incluye nuevas APIs que permiten generar filtros dinámicos según la estructura de tu fuente de datos.

• List Data Sources – Devuelve todas las fuentes disponibles conectadas al plugin.
• Retrieve a Data Source by id – Devuelve tablas y campos de una fuente específica.

Estos endpoints ayudan a construir informes más flexibles, sin necesidad de conocer el esquema completo de antemano. Todos los endpoints existentes también se actualizaron para alinearse con las mejoras de Midaz Core.