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.

Los Tipos de Cuenta en Midaz te permiten clasificar sistemáticamente las cuentas de acuerdo con las necesidades de la estructura financiera de tu organización. Estas clasificaciones definen la naturaleza y el propósito de las cuentas dentro del diseño de tu Ledger, lo que permite un enrutamiento de transacciones adecuado y una validación operativa en diferentes categorías de cuentas. Los Tipos de Cuenta se pueden personalizar a través de la API de Tipos de Cuenta para que coincidan con tus requisitos comerciales y flujos de trabajo financieros específicos, proporcionando la base para el procesamiento de transacciones estructurado mientras se mantiene la integridad de los datos.

​
Habilitación de la validación de Tipo de Cuenta

La validación de Tipo de Cuenta se habilita por Ledger a través de la API de Configuración del Ledger. Para activarla, envía una solicitud PATCH al endpoint de Configuración del Ledger: 
{
  "accounting": {
    "validateAccountType": true
  }
}
Los cambios de configuración surten efecto de inmediato — no es necesario redesplegar. Puedes actualizarlos en cualquier momento a través de la API.

​
Comportamiento del campo type en la API de Cuentas

Al crear una Cuenta, el comportamiento del campo type se adapta en función de la activación de la característica de Validación de Tipo de Cuenta:
  • Validación de Tipo de Cuenta Deshabilitada (Predeterminada): El campo type es opcional y acepta cualquier cadena de formato libre (free-form string).
  • Validación de Tipo de Cuenta Habilitada: El campo type se vuelve obligatorio y debe coincidir con uno de los Tipos de Cuenta registrados previamente a través de la API de Tipos de Cuenta. Si se envía un tipo no válido o no registrado, el sistema devolverá un error de validación.
  Si tu organización está habilitando la característica de Validación de Tipo de Cuenta, recomendamos revisar las cuentas existentes. Es posible que debas recrearlas o asignar retroactivamente el Tipo de Cuenta apropiado para alinearlas con tu estructura contable.
Esta dinámica garantiza que cada cuenta se alinee con las categorías contables formales requeridas por tu negocio, fortaleciendo la gobernanza y los informes financieros.

​
El campo keyValue

El campo keyValue identifica un Tipo de Cuenta y tiene las siguientes restricciones:
  • Inmutable: El keyValue se establece en el momento de la creación y no puede modificarse posteriormente. El endpoint de Actualización de Tipo de Cuenta no acepta este campo.
  • Único por ledger: Cada keyValue debe ser único dentro de un Ledger determinado.
  • Usado para validación de tipo: Cuando validateAccountType está habilitado en la Configuración del Ledger, el campo type de cualquier Cuenta debe coincidir exactamente con uno de los strings keyValue registrados. Las cuentas creadas con un valor type no registrado serán rechazadas.

​
Gestión de Tipos de Cuenta

Puedes gestionar tus Tipos de Cuenta exclusivamente a través de la API.