Pular para o conteúdo principal
POST
/
v1
/
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 'Authorization: Bearer <token>' \
  --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"
      }
    }
  }
}
'
{ "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" }

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

​
Authorization
string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver Access Manager habilitado.

​
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.

Parâmetros de caminho

​
organization_id
string
obrigatório

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

​
ledger_id
string
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).

​
code
string

Uma referência externa usada para identificar a rota de operação.

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

​
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.

Resposta

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

​
id
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

Uma referência externa usada para identificar a rota de operação.

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
​
action
enum<string>

A ação da rota no contexto do ciclo de vida da transação.

Opções disponíveis:
direct,
hold,
commit,
cancel,
revert
​
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.

​
account
object

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

​
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

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