Listar Rutas de Operación

curl --request GET \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes

{
  "items": [
    {
      "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",
      "limit": 0,
      "next_cursor": "string",
      "page": {},
      "prev_cursor": "string"
    }
  ]
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

operation-routes

Listar Rutas de Operación

curl --request GET \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes

{
  "items": [
    {
      "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",
      "limit": 0,
      "next_cursor": "string",
      "page": {},
      "prev_cursor": "string"
    }
  ]
}

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.

Query Parameters

limit

string

Número máximo de elementos que se incluirán en la respuesta.

start_date

string

Inicio del período que deseas recuperar. Debes incluir también el parámetro end_date.

end_date

string

Fin del período que deseas recuperar. Debes incluir también el parámetro start_date.

sort_order

enum<enum>

Orden utilizado para clasificar los resultados.

Opciones disponibles:

asc,

desc

cursor

string

Posición dentro del conjunto de datos donde debe comenzar la siguiente página de resultados.

metadata.newField

string

Campo nuevo que se incluirá en la consulta como metadato.

Response

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

items

object[]

Mostrar atributos secundarios

items.id

string<uuid>

Identificador único de la ruta de operación.

items.organizationId

string<uuid>

Identificador único de la organización.

items.ledgerId

string<uuid>

Identificador único del ledger.

items.title

string

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

items.code

string

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

Maximum string length: 100

items.description

string

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

items.operationType

enum<string>

Tipo de la ruta de operación.

Opciones disponibles:

source,

destination

items.account

object

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

Mostrar atributos secundarios

items.account.ruleType

enum<string>

Especifica el tipo de regla para validar la cuenta en la operación.

alias: Espera un alias de cuenta específico. El campo validIf debe contener la cadena del alias exacto (por ejemplo, "validIf": "@john_doe").
account_type: Espera que la cuenta tenga uno de los tipos de cuenta especificados. El campo validIf debe contener un arreglo de keyValues de tipos de cuenta (por ejemplo, "validIf": ["current_asset", "payment_account"]).

Opciones disponibles:

alias,

account_type

items.account.validIf

Criterios de validación según el ruleType. Cuando ruleType es alias: una cadena con el alias de cuenta específico (por ejemplo, "@john_doe"). Cuando ruleType es account_type: un arreglo de cadenas con los keyValues de tipos de cuenta (por ejemplo, ["current_asset", "payment_account"]).

items.createdAt

string<date-time>

Marca de tiempo de creación (UTC).

items.updatedAt

string<date-time>

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

items.deletedAt

string<date-time> | null

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

items.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'.

Mostrar atributos secundarios

items.metadata.{key}

string

Crear una Ruta de Operación

Obtener una Ruta de Operación

⌘I

Organizations API

Ledgers API

Assets API

Account Types API

Accounts API

Portfolios API

Segments API

Balances API

Transactions API

Operations API

Operation Routes API

Transaction Routes API

Manejo de errores

Listar Rutas de Operación

Headers

Path Parameters

Query Parameters

Response