Crear una Ruta de Operación

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "ruleType": "alias",
    "validIf": "@external/BRL"
  },
  "code": "PIX-DEBIT",
  "title": "PIX External Account Debit",
  "description": "PIX External Account Debit",
  "metadata": {
    "customField1": "value1",
    "customField2": 123
  },
  "operationType": "source",
  "accountingEntries": {
    "direct": {
      "debit": {
        "code": "1.1.001",
        "description": "Cash - Available funds"
      },
      "credit": {
        "code": "3.1.001",
        "description": "Service Revenue"
      }
    }
  }
}
'

import requests

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

payload = {
    "account": {
        "ruleType": "alias",
        "validIf": "@external/BRL"
    },
    "code": "PIX-DEBIT",
    "title": "PIX External Account Debit",
    "description": "PIX External Account Debit",
    "metadata": {
        "customField1": "value1",
        "customField2": 123
    },
    "operationType": "source",
    "accountingEntries": { "direct": {
            "debit": {
                "code": "1.1.001",
                "description": "Cash - Available funds"
            },
            "credit": {
                "code": "3.1.001",
                "description": "Service Revenue"
            }
        } }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    account: {ruleType: 'alias', validIf: '@external/BRL'},
    code: 'PIX-DEBIT',
    title: 'PIX External Account Debit',
    description: 'PIX External Account Debit',
    metadata: {customField1: 'value1', customField2: 123},
    operationType: 'source',
    accountingEntries: {
      direct: {
        debit: {code: '1.1.001', description: 'Cash - Available funds'},
        credit: {code: '3.1.001', description: 'Service Revenue'}
      }
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account' => [
        'ruleType' => 'alias',
        'validIf' => '@external/BRL'
    ],
    'code' => 'PIX-DEBIT',
    'title' => 'PIX External Account Debit',
    'description' => 'PIX External Account Debit',
    'metadata' => [
        'customField1' => 'value1',
        'customField2' => 123
    ],
    'operationType' => 'source',
    'accountingEntries' => [
        'direct' => [
                'debit' => [
                                'code' => '1.1.001',
                                'description' => 'Cash - Available funds'
                ],
                'credit' => [
                                'code' => '3.1.001',
                                'description' => 'Service Revenue'
                ]
        ]
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"PIX External Account Debit\",\n  \"description\": \"PIX External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"PIX External Account Debit\",\n  \"description\": \"PIX External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\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")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"PIX External Account Debit\",\n  \"description\": \"PIX External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}"

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

{
  "id": "019c96a0-1071-7a0d-9916-a831221de252",
  "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "account": {
    "ruleType": "alias",
    "validIf": [
      "@external/BRL"
    ]
  },
  "code": "PIX-DEBIT",
  "description": "PIX External Account Debit",
  "operationType": "source",
  "action": "direct",
  "title": "PIX External Account Debit",
  "metadata": {
    "customField1": "value1",
    "customField2": 123
  },
  "accountingEntries": {
    "direct": {
      "debit": {
        "code": "1.1.001",
        "description": "Cash - Available funds"
      },
      "credit": {
        "code": "3.1.001",
        "description": "Service Revenue"
      }
    }
  },
  "createdAt": "2026-02-25T21:06:38.321656Z",
  "deletedAt": null,
  "updatedAt": "2026-02-25T21:06:38.321656Z"
}

POST

organizations

{organization_id}

ledgers

{ledger_id}

operation-routes

Crear una Ruta de Operación

curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "ruleType": "alias",
    "validIf": "@external/BRL"
  },
  "code": "PIX-DEBIT",
  "title": "PIX External Account Debit",
  "description": "PIX External Account Debit",
  "metadata": {
    "customField1": "value1",
    "customField2": 123
  },
  "operationType": "source",
  "accountingEntries": {
    "direct": {
      "debit": {
        "code": "1.1.001",
        "description": "Cash - Available funds"
      },
      "credit": {
        "code": "3.1.001",
        "description": "Service Revenue"
      }
    }
  }
}
'

import requests

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

payload = {
    "account": {
        "ruleType": "alias",
        "validIf": "@external/BRL"
    },
    "code": "PIX-DEBIT",
    "title": "PIX External Account Debit",
    "description": "PIX External Account Debit",
    "metadata": {
        "customField1": "value1",
        "customField2": 123
    },
    "operationType": "source",
    "accountingEntries": { "direct": {
            "debit": {
                "code": "1.1.001",
                "description": "Cash - Available funds"
            },
            "credit": {
                "code": "3.1.001",
                "description": "Service Revenue"
            }
        } }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    account: {ruleType: 'alias', validIf: '@external/BRL'},
    code: 'PIX-DEBIT',
    title: 'PIX External Account Debit',
    description: 'PIX External Account Debit',
    metadata: {customField1: 'value1', customField2: 123},
    operationType: 'source',
    accountingEntries: {
      direct: {
        debit: {code: '1.1.001', description: 'Cash - Available funds'},
        credit: {code: '3.1.001', description: 'Service Revenue'}
      }
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account' => [
        'ruleType' => 'alias',
        'validIf' => '@external/BRL'
    ],
    'code' => 'PIX-DEBIT',
    'title' => 'PIX External Account Debit',
    'description' => 'PIX External Account Debit',
    'metadata' => [
        'customField1' => 'value1',
        'customField2' => 123
    ],
    'operationType' => 'source',
    'accountingEntries' => [
        'direct' => [
                'debit' => [
                                'code' => '1.1.001',
                                'description' => 'Cash - Available funds'
                ],
                'credit' => [
                                'code' => '3.1.001',
                                'description' => 'Service Revenue'
                ]
        ]
    ]
  ]),
  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"

	payload := strings.NewReader("{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"PIX External Account Debit\",\n  \"description\": \"PIX External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", 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.post("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes")
  .header("Content-Type", "application/json")
  .body("{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"PIX External Account Debit\",\n  \"description\": \"PIX External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\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")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account\": {\n    \"ruleType\": \"alias\",\n    \"validIf\": \"@external/BRL\"\n  },\n  \"code\": \"PIX-DEBIT\",\n  \"title\": \"PIX External Account Debit\",\n  \"description\": \"PIX External Account Debit\",\n  \"metadata\": {\n    \"customField1\": \"value1\",\n    \"customField2\": 123\n  },\n  \"operationType\": \"source\",\n  \"accountingEntries\": {\n    \"direct\": {\n      \"debit\": {\n        \"code\": \"1.1.001\",\n        \"description\": \"Cash - Available funds\"\n      },\n      \"credit\": {\n        \"code\": \"3.1.001\",\n        \"description\": \"Service Revenue\"\n      }\n    }\n  }\n}"

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

{
  "id": "019c96a0-1071-7a0d-9916-a831221de252",
  "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
  "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
  "account": {
    "ruleType": "alias",
    "validIf": [
      "@external/BRL"
    ]
  },
  "code": "PIX-DEBIT",
  "description": "PIX External Account Debit",
  "operationType": "source",
  "action": "direct",
  "title": "PIX External Account Debit",
  "metadata": {
    "customField1": "value1",
    "customField2": 123
  },
  "accountingEntries": {
    "direct": {
      "debit": {
        "code": "1.1.001",
        "description": "Cash - Available funds"
      },
      "credit": {
        "code": "3.1.001",
        "description": "Service Revenue"
      }
    }
  },
  "createdAt": "2026-02-25T21:06:38.321656Z",
  "deletedAt": null,
  "updatedAt": "2026-02-25T21:06:38.321656Z"
}

Encabezados

Content-Type

string

El tipo de medio del recurso. El valor recomendado es application/json.

X-Request-Id

string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization

string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

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.

Cuerpo

application/json

title

string

requerido

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

operationType

enum<string>

requerido

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

Opciones disponibles:

source,

destination,

bidirectional

account

object

Define la regla para seleccionar la cuenta que participará en la operación (origen o destino).

Show child attributes

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.

Maximum string length: 250

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

Actualizar una Operación

Listar Rutas de Operación

⌘I