Saltar al contenido principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
operation-routes
/
{operation_route_id}
Obtener una Ruta de Operación
curl --request GET \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}
{
"id": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
"organizationId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
"ledgerId": "01965ed9-7fa4-75b2-8872-fc9e8509ab0a",
"account": {
"ruleType": "alias",
"validIf": [
"@account1"
]
},
"code": "EXT-001",
"description": "Esta ruta de operación gestiona transacciones de cobro por comisiones (cash-in)",
"operationType": "source",
"title": "Cobro por comisión (cash-in)",
"metadata": {
"property1": "string",
"property2": "string"
},
"createdAt": "2021-01-01T00:00:00Z",
"deletedAt": "2021-01-01T00:00:00Z",
"updatedAt": "2021-01-01T00:00:00Z"
}

Headers

Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

Path Parameters

organization_id
string
required

Identificador único de la organización asociada al ledger.

ledger_id
string
required

Identificador único del ledger asociado.

operation_route_id
string
required

Identificador único de la ruta de operación que deseas consultar.

Response

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

id
string<uuid>

Identificador único de la ruta de operación.

organizationId
string<uuid>

Identificador único de la organización.

ledgerId
string<uuid>

Identificador único del ledger.

title
string

Texto corto que resume el propósito de la operación. Se usa como nota de identificación.

code
string

Referencia externa utilizada para identificar la ruta de operación.

Maximum length: 100
description
string

Descripción detallada del propósito y uso de la ruta de operación.

operationType
enum<string>

Tipo de la ruta de operación.

Opciones disponibles:
source,
destination
account
object

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

createdAt
string<date-time>

Marca de tiempo de creación (UTC).

updatedAt
string<date-time>

Marca de tiempo de la última actualización (UTC).

deletedAt
string<date-time> | null

Marca de tiempo de la eliminación lógica, si aplica (UTC).

metadata
object

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 costos, usa 'costCenter': 'BR_11101997'.