Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Las Rutas Contables responden a tres preguntas operativas:
  • ¿Qué tipo de transacción se está configurando?
  • ¿Qué Cuentas pueden participar?
  • ¿Qué asientos contables deben registrarse cuando se ejecuta la transacción?
Crea rutas solo después de tener claras las Cuentas principales y los Tipos de Cuenta. Las rutas son más fáciles de modelar cuando ya sabes qué Cuentas representan a los clientes, treasury, fees, settlement, revenues y expenses.

​
Cómo encajan las piezas

PiezaQué controlaEjemplo
Accounting RouteLa route a nivel de transacción que agrupa las operation rules.Pix transfer route
Operation RouteEl lado de la Cuenta y la regla de validación.Source debe ser customer, Destination debe ser merchant
Validation ruleCómo Midaz decide si una Cuenta puede usarse.Tipo de Cuenta customer o alias @treasury_main
Accounting scenarioQué entradas de débito y crédito se registran durante el ciclo de vida de la transacción.Direct, Two-Step, Reversal

​
Elegir el tipo de operación

Usa Source para Cuentas donde se origina el valor.Ejemplo: una Cuenta de cliente puede enviar fondos en un flujo de pago.
Usa Destination para Cuentas donde llega el valor.Ejemplo: una Cuenta de merchant puede recibir fondos en un flujo de pago.
Usa Bidirectional cuando la misma clase de Cuenta puede enviar y recibir.Ejemplo: las Cuentas checking pueden transferir valor a otras Cuentas checking.
Una route debe tener al menos una operation route Source y una Destination, o una operation route Bidirectional.

​
Elegir la regla de validación

Tipo de validaciónCuándo usarlaEjemplo
Account TypeCualquier Cuenta de una clase debe ser válida.Cualquier Cuenta customer puede enviar.
AliasSolo una Cuenta exacta debe ser válida.Solo @treasury_main puede enviar.
Sin validaciónNo quieres validación de Cuenta en este nivel de route a propósito.Poco común; úsalo con cuidado.
Usa validación por Tipo de Cuenta para flujos escalables. Usa validación por alias para Cuentas operativas fijas, como treasury, fee, settlement o suspense.

​
Patrones comunes de route

​
Customer to merchant

Usa routes Source y Destination separadas cuando cada lado tiene un rol distinto.
Operation routeValidación
SourceTipo de Cuenta customer
DestinationTipo de Cuenta merchant

​
Peer-to-peer transfer

Usa una route Bidirectional cuando el mismo Tipo de Cuenta puede ser tanto origen como destino.
Operation routeValidación
BidirectionalTipo de Cuenta customer

​
Fee collection

Usa una route Destination con validación por alias cuando las fees deban llegar siempre a una misma Cuenta operativa.
Operation routeValidación
SourceTipo de Cuenta customer
DestinationAlias @fee_revenue

​
Accounting scenarios

ScenarioCuándo usarloQué configura el usuario
Direct TransactionEl movimiento se ejecuta en un solo paso.Entradas de débito y crédito para asiento inmediato.
Two-Step TransactionEl movimiento tiene fases de hold, commit y cancel.Entradas para reserva, confirmación y cancelación.
ReversalUna transacción completada puede necesitar ser revertida.Entradas de débito y crédito para el evento de reversa.
No habilites la validación de routes en la configuración del Ledger hasta que existan las routes necesarias. Si la validación de routes está habilitada sin routes coincidentes, las transacciones fallarán la validación.

​
Qué hacer después

Una vez claro el modelo de la route, créala en Crear una Ruta Contable.

Create Transaction Route

Crea la route a nivel de transacción vía API.

Create Operation Route

Crea reglas de routing a nivel de operation vía API.