Actualizar una Operación Route

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "PIX Internal Account Credit",
  "code": "PIX-CREDIT",
  "description": "PIX Internal Account Credit",
  "account": {
    "ruleType": "account_type",
    "validIf": [
      "deposit"
    ],
    "metadata": {
      "customField1": "updatedValue",
      "customField2": 456,
      "newField": "newValue"
    }
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}"

payload = {
    "title": "PIX Internal Account Credit",
    "code": "PIX-CREDIT",
    "description": "PIX Internal Account Credit",
    "account": {
        "ruleType": "account_type",
        "validIf": ["deposit"],
        "metadata": {
            "customField1": "updatedValue",
            "customField2": 456,
            "newField": "newValue"
        }
    }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'PIX Internal Account Credit',
    code: 'PIX-CREDIT',
    description: 'PIX Internal Account Credit',
    account: {
      ruleType: 'account_type',
      validIf: ['deposit'],
      metadata: {customField1: 'updatedValue', customField2: 456, newField: 'newValue'}
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'PIX Internal Account Credit',
    'code' => 'PIX-CREDIT',
    'description' => 'PIX Internal Account Credit',
    'account' => [
        'ruleType' => 'account_type',
        'validIf' => [
                'deposit'
        ],
        'metadata' => [
                'customField1' => 'updatedValue',
                'customField2' => 456,
                'newField' => 'newValue'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}"

	payload := strings.NewReader("{\n  \"title\": \"PIX Internal Account Credit\",\n  \"code\": \"PIX-CREDIT\",\n  \"description\": \"PIX Internal Account Credit\",\n  \"account\": {\n    \"ruleType\": \"account_type\",\n    \"validIf\": [\n      \"deposit\"\n    ],\n    \"metadata\": {\n      \"customField1\": \"updatedValue\",\n      \"customField2\": 456,\n      \"newField\": \"newValue\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"PIX Internal Account Credit\",\n  \"code\": \"PIX-CREDIT\",\n  \"description\": \"PIX Internal Account Credit\",\n  \"account\": {\n    \"ruleType\": \"account_type\",\n    \"validIf\": [\n      \"deposit\"\n    ],\n    \"metadata\": {\n      \"customField1\": \"updatedValue\",\n      \"customField2\": 456,\n      \"newField\": \"newValue\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"PIX Internal Account Credit\",\n  \"code\": \"PIX-CREDIT\",\n  \"description\": \"PIX Internal Account Credit\",\n  \"account\": {\n    \"ruleType\": \"account_type\",\n    \"validIf\": [\n      \"deposit\"\n    ],\n    \"metadata\": {\n      \"customField1\": \"updatedValue\",\n      \"customField2\": 456,\n      \"newField\": \"newValue\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "account": {
    "ruleType": "account_type",
    "validIf": [
      "deposit"
    ]
  },
  "code": "PIX-CREDIT",
  "description": "PIX Internal Account Credit",
  "operationType": "destination",
  "title": "PIX Internal Account Credit",
  "metadata": {
    "customField1": "updatedValue",
    "customField2": 456
  },
  "createdAt": "2026-02-25T21:06:38.348683Z",
  "deletedAt": null,
  "updatedAt": "2026-02-25T21:06:38.348683Z"
}

PATCH

organizations

{organization_id}

ledgers

{ledger_id}

operation-routes

{operation_route_id}

Actualizar una Operación Route

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "PIX Internal Account Credit",
  "code": "PIX-CREDIT",
  "description": "PIX Internal Account Credit",
  "account": {
    "ruleType": "account_type",
    "validIf": [
      "deposit"
    ],
    "metadata": {
      "customField1": "updatedValue",
      "customField2": 456,
      "newField": "newValue"
    }
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}"

payload = {
    "title": "PIX Internal Account Credit",
    "code": "PIX-CREDIT",
    "description": "PIX Internal Account Credit",
    "account": {
        "ruleType": "account_type",
        "validIf": ["deposit"],
        "metadata": {
            "customField1": "updatedValue",
            "customField2": 456,
            "newField": "newValue"
        }
    }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'PIX Internal Account Credit',
    code: 'PIX-CREDIT',
    description: 'PIX Internal Account Credit',
    account: {
      ruleType: 'account_type',
      validIf: ['deposit'],
      metadata: {customField1: 'updatedValue', customField2: 456, newField: 'newValue'}
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'PIX Internal Account Credit',
    'code' => 'PIX-CREDIT',
    'description' => 'PIX Internal Account Credit',
    'account' => [
        'ruleType' => 'account_type',
        'validIf' => [
                'deposit'
        ],
        'metadata' => [
                'customField1' => 'updatedValue',
                'customField2' => 456,
                'newField' => 'newValue'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}"

	payload := strings.NewReader("{\n  \"title\": \"PIX Internal Account Credit\",\n  \"code\": \"PIX-CREDIT\",\n  \"description\": \"PIX Internal Account Credit\",\n  \"account\": {\n    \"ruleType\": \"account_type\",\n    \"validIf\": [\n      \"deposit\"\n    ],\n    \"metadata\": {\n      \"customField1\": \"updatedValue\",\n      \"customField2\": 456,\n      \"newField\": \"newValue\"\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"PIX Internal Account Credit\",\n  \"code\": \"PIX-CREDIT\",\n  \"description\": \"PIX Internal Account Credit\",\n  \"account\": {\n    \"ruleType\": \"account_type\",\n    \"validIf\": [\n      \"deposit\"\n    ],\n    \"metadata\": {\n      \"customField1\": \"updatedValue\",\n      \"customField2\": 456,\n      \"newField\": \"newValue\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"PIX Internal Account Credit\",\n  \"code\": \"PIX-CREDIT\",\n  \"description\": \"PIX Internal Account Credit\",\n  \"account\": {\n    \"ruleType\": \"account_type\",\n    \"validIf\": [\n      \"deposit\"\n    ],\n    \"metadata\": {\n      \"customField1\": \"updatedValue\",\n      \"customField2\": 456,\n      \"newField\": \"newValue\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "account": {
    "ruleType": "account_type",
    "validIf": [
      "deposit"
    ]
  },
  "code": "PIX-CREDIT",
  "description": "PIX Internal Account Credit",
  "operationType": "destination",
  "title": "PIX Internal Account Credit",
  "metadata": {
    "customField1": "updatedValue",
    "customField2": 456
  },
  "createdAt": "2026-02-25T21:06:38.348683Z",
  "deletedAt": null,
  "updatedAt": "2026-02-25T21:06:38.348683Z"
}

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.

Cuerpo

application/json

title

string

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

Maximum string length: 50

description

string

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

Maximum string length: 250

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

account

object

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

Show child attributes

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.

Show child attributes

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.

Show child attributes

Respuesta

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

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.

Show child attributes

account

object

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

Show child attributes

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

Show child attributes

Recuperar una Ruta de Operación

Eliminar una Ruta de Operación

⌘I

Primeros pasos

API de Organizaciones

API de Ledgers

API de Activos

API de Tipos de Cuenta

API de Cuentas

API de Portafolios

API de Segmentos

API de Saldos

API de Transacciones

API de Operaciones

API de Rutas de Operación

API de Rutas de Transacción

API de Índices de Metadatos

API de Titulares

API de Instrumentos

API de Paquetes de Facturación

API de Paquetes

API de Cálculo de Facturación

API de Estimación

API de Cifrado

API de Protección

API de Tasas de Activos

Manejo de errores

Fees Engine

Actualizar una Operación Route

Parámetros de ruta

Cuerpo

Respuesta