Criar uma Rota de Operação

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

Criar uma Rota de Operação

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"
}

Cabeçalhos

Content-Type

string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id

string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization

string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

organization_id

string<uuid>

obrigatório

O identificador único da Organização associada ao Ledger.

ledger_id

string<uuid>

obrigatório

O identificador único do Ledger associado.

Corpo

application/json

title

string

obrigatório

Texto curto que resume o propósito da operação. Usado como nota de entrada para identificação.

Maximum string length: 50

operationType

enum<string>

obrigatório

O tipo da Rota de Operação. Use bidirectional quando a rota pode operar em ambas as direções.

Opções disponíveis:

source,

destination,

bidirectional

account

object

Define a regra para selecionar a conta que participará da operação (origem ou destino).

Show child attributes

code

string

obsoleto

Uma referência externa usada para identificar a rota de operação. Obsoleto: use códigos de rubrica dentro de accountingEntries em vez disso.

Maximum string length: 100

description

string

Descrição detalhada do propósito e uso da Rota de Operação.

Maximum string length: 250

metadata

object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

Restrições: as chaves devem ter no máximo 100 caracteres; valores de string no máximo 2000 caracteres. Objetos aninhados não são permitidos (os valores devem ser string, número ou booleano), a estrutura não pode exceder uma profundidade máxima de 10, e é permitido um máximo de 100 chaves.

Show child attributes

accountingEntries

object

Lançamentos contábeis agrupados por tipo de ação de transação. Cada ação é mapeada para um par de rubricas de débito e crédito.

Show child attributes

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

string<uuid>

O identificador único da Rota de Operação.

organizationId

string<uuid>

O identificador único da Organização.

ledgerId

string<uuid>

O identificador único do Ledger.

title

string

Texto curto que resume o propósito da operação. Usado como nota de entrada para identificação.

code

string

obsoleto

Uma referência externa usada para identificar a rota de operação. Obsoleto: use códigos de rubrica dentro de accountingEntries em vez disso.

Maximum string length: 100

description

string

Descrição detalhada do propósito e uso da Rota de Operação.

operationType

enum<string>

O tipo da Rota de Operação. Use bidirectional quando a rota pode operar em ambas as direções.

Opções disponíveis:

source,

destination,

bidirectional

accountingEntries

object

Lançamentos contábeis agrupados por tipo de ação de transação. Cada ação é mapeada para um par de rubricas de débito e crédito.

Show child attributes

account

object

Define a regra para selecionar a conta que participará da operação (débito ou crédito).

Show child attributes

createdAt

string<date-time>

Data e hora de criação (UTC).

updatedAt

string<date-time>

Data e hora da última atualização (UTC).

deletedAt

string<date-time> | null

Data e hora da exclusão lógica, se aplicável (UTC).

metadata

object

Show child attributes

Atualizar uma Operação

Listar Rotas de Operação

⌘I