Saltar al contenido principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
accounts
/
{account_id}
/
operations
/
{operation_id}
Obtener una Operación
curl --request GET \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations/{operation_id} \
  --header 'Content-Type: <content-type>'
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"accountAlias": "<string>",
"balanceId": "<string>",
"balanceKey": "<string>",
"description": "<string>",
"type": "CREDIT",
"assetCode": "<string>",
"chartOfAccounts": "<string>",
"route": "<string>",
"amount": {
"value": "<string>"
},
"balance": {
"available": "<string>",
"onHold": "<string>"
},
"balanceAfter": {
"available": "<string>",
"onHold": "<string>"
},
"status": {
"code": "<string>",
"description": "<string>"
},
"balanceAffected": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"metadata": {}
}

Headers

Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

Content-Type
string
required

Tipo de medio del recurso. Debe ser application/json.

X-Request-Id
string

Identificador único usado para rastrear cada solicitud.

Path Parameters

organization_id
string
required

Identificador único de la organización asociada al ledger.

ledger_id
string
required

Identificador único del ledger asociado.

account_id
string
required

Identificador único de la cuenta de la que deseas obtener los saldos.

operation_id
string
required

Identificador único de la operación que deseas consultar.

Response

Indica que la solicitud se realizó correctamente y la respuesta contiene los datos esperados.

id
string<uuid>

Identificador único de la operación.

transactionId
string<uuid>

Identificador único de la transacción.

organizationId
string<uuid>

Identificador único de la organización.

ledgerId
string<uuid>

Identificador único del ledger.

accountId
string<uuid>

Identificador único de la cuenta.

accountAlias
string

Alias de la cuenta usado en la operación.

balanceId
string

Identificador único del saldo.

balanceKey
string

Clave única que identifica el saldo.

description
string

Descripción de la transacción.

type
enum<string>

Tipo de la operación.

Opciones disponibles:
CREDIT,
DEBIT,
ON_HOLD,
RELEASE
assetCode
string

Nombre del activo utilizado en la operación.

chartOfAccounts
string

Nombre del plan de cuentas al que pertenece la operación.

route
string

ID único de la ruta de operación para esta pierna de la transacción. Debe coincidir con la configuración de origen y destino para definir cómo se mueve el valor entre las cuentas.

amount
object

Objeto que contiene información sobre el monto utilizado en la operación.

balance
object

Objeto que contiene información sobre el saldo antes de la operación.

balanceAfter
object

Objeto que contiene información sobre el saldo después de la operación.

status
object

Estado de la transacción (pendiente, completada, revertida).

balanceAffected
boolean

Si es verdadero, indica que la operación afectó el saldo de la cuenta.

createdAt
string<date-time>

Marca de tiempo de creación (UTC).

updatedAt
string<date-time>

Marca de tiempo de la última actualización (UTC).

deletedAt
string<date-time> | null

Marca de tiempo de la eliminación lógica, si aplica (UTC).

metadata
object

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 costos, usa 'costCenter': 'BR_11101997'.