Saltar al contenido principal
GET
Recuperar una Ruta de Operación

Parámetros de ruta

organization_id
string<uuid>
requerido

El identificador único de la Organización asociada al Ledger.

ledger_id
string<uuid>
requerido

El identificador único del Ledger asociado.

operation_route_id
string<uuid>
requerido

El identificador único de la Ruta de Operación que desea recuperar.

Respuesta

Indica que el recurso fue creado exitosamente y la operación se completó como se esperaba.

id
string<uuid>

El identificador único de la Ruta de Operación.

organizationId
string<uuid>

El identificador único de la Organización.

ledgerId
string<uuid>

El identificador único del Ledger.

title
string

Texto breve que resume el propósito de la operación. Se utiliza como nota de asiento para su identificación.

code
string
obsoleto

Una referencia externa utilizada para identificar la ruta de operación. Obsoleto: utilice códigos de rúbrica dentro de accountingEntries en su lugar.

Maximum string length: 100
description
string

Descripción detallada del propósito y uso de la Ruta de Operación.

operationType
enum<string>

El tipo de la Ruta de Operación. Use bidirectional cuando la ruta puede operar en ambas direcciones.

Opciones disponibles:
source,
destination,
bidirectional
accountingEntries
object

Entradas contables agrupadas por tipo de acción de transacción. Cada acción se mapea a un par de rúbricas de débito y crédito.

account
object

Define la regla para seleccionar la cuenta que participará en la operación (débito o crédito).

createdAt
string<date-time>

Fecha y hora de creación (UTC).

updatedAt
string<date-time>

Fecha y hora de la última actualización (UTC).

deletedAt
string<date-time> | null

Fecha y hora de la eliminación lógica, si aplica (UTC).

metadata
object

Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un Centro de Costo, use 'costCenter': 'BR_11101997'.

Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.