Update an Operation Route

Use this endpoint to update the details of an Operation Route.

PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id}

Update an Operation Route

cURL

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/operation-routes/{operation_route_id} \
  --header 'Authorization: Bearer <token>' \
  --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"
    }
  }
}
'

200

Example

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

Authorizations

Authorization · string · header · required

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

Headers

Authorization · string

The authorization token. This header is required if your environment has Access Manager enabled.

Path Parameters

organization_id · string · required

The unique identifier of the Organization associated with the Ledger.

ledger_id · string · required

The unique identifier of the associated Ledger.

operation_route_id · string · required

The unique identifier of the Operation Route that you want to retrieve.

Body

application/json

title · string

Short text summarizing the purpose of the operation. Used as an entry note for identification.

Maximum string length: 255

description · string

Detailed description of the Operation Route purpose and usage.

Maximum string length: 250

code · string · deprecated

An external reference used to identify the operation route. Deprecated: use rubric codes inside accountingEntries instead.

Maximum string length: 100

account · object

Defines the rule for selecting the account that will participate in the operation (debit or credit).

Show child attributes

metadata · object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Show child attributes

accountingEntries · object

Accounting entries grouped by transaction action type. Each action maps to a pair of debit and credit rubrics.

Show child attributes

Response

200

application/json

Indicates that the resource was successfully created and the operation was completed as expected.

id · string<uuid>

The unique identifier of the Operation Route.

organizationId · string<uuid>

The unique identifier of the Organization.

ledgerId · string<uuid>

The unique identifier of the Ledger.

title · string

Short text summarizing the purpose of the operation. Used as an entry note for identification.

code · string · deprecated

An external reference used to identify the operation route. Deprecated: use rubric codes inside accountingEntries instead.

Maximum string length: 100

description · string

Detailed description of the Operation Route purpose and usage.

operationType · enum<string>

The type of the Operation Route. Use bidirectional when the route can operate in both directions.

Available options: source, destination, bidirectional

accountingEntries · object

Accounting entries grouped by transaction action type. Each action maps to a pair of debit and credit rubrics.

Show child attributes

account · object

Defines the rule for selecting the account that will participate in the operation (debit or credit).

Show child attributes

createdAt · string<date-time>

Timestamp of creation (UTC).

updatedAt · string<date-time>

Timestamp of last update (UTC).

deletedAt · string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

metadata · object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Show child attributes