Saltar al contenido principal
POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
transaction-routes
Crear una Ruta de Transacción
curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transaction-routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "PIX",
  "description": "Pix from external bank account",
  "operationRoutes": [
    {
      "operationRouteId": "019c96a0-1071-7a0d-9916-a831221de252"
    },
    {
      "operationRouteId": "019c96a0-2222-3333-4444-555566667777"
    }
  ],
  "metadata": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "description": "<string>",
  "operationRoutes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "code": "<string>",
      "description": "<string>",
      "operationType": "source",
      "accountingEntries": {
        "direct": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "hold": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "commit": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "cancel": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        },
        "revert": {
          "debit": {
            "code": "<string>",
            "description": "<string>"
          },
          "credit": {
            "code": "<string>",
            "description": "<string>"
          }
        }
      },
      "account": {
        "ruleType": "alias",
        "validIf": [
          [
            "current_asset",
            "payment_account"
          ]
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Autorizaciones

​
Authorization
string
header
requerido

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

Encabezados

​
Authorization
string

El token de autorización. Este encabezado es requerido si su entorno tiene Access Manager habilitado.

Parámetros de ruta

​
organization_id
string
requerido

El identificador único de la Organización asociada al Ledger.

​
ledger_id
string
requerido

El identificador único del Ledger asociado.

Cuerpo

application/json
​
title
string
requerido

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

Maximum string length: 50
​
operationRoutes
object[]
requerido

Una lista de referencias a rutas de operación que definen la lógica de origen y destino para la transacción. Importante: Una ruta de transacción debe incluir al menos una ruta de operación con tipo 'source' y al menos una con tipo 'destination'.

​
description
string

A description for the Transaction Route.

Maximum string length: 250
​
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'.

Respuesta

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

​
id
string<uuid>

El identificador único de la Ruta de Transacción.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

El identificador único del Ledger.

​
title
string

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

​
description
string

A description for the Transaction Route.

​
operationRoutes
object[]

List of objects containing information about the Operation Routes from the Transaction Route.

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