Saltar al contenido principal
GET
Recuperar una Operación

Encabezados

Content-Type
string

El tipo de medio del recurso. El valor recomendado es application/json.

X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization
string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de ruta

organization_id
string<uuid>
requerido

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

ledger_id
string<uuid>
requerido

El identificador único del Ledger asociado.

account_id
string<uuid>
requerido

El identificador único de la cuenta.

operation_id
string<uuid>
requerido

El identificador único de la operación que desea recuperar.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

id
string<uuid>

El identificador único de la Operación.

transactionId
string<uuid>

El identificador único de la Transacción.

organizationId
string<uuid>

El identificador único de la Organización.

ledgerId
string<uuid>

El identificador único del Ledger.

accountId
string<uuid>

El identificador único de la Cuenta.

accountAlias
string

El alias de la cuenta utilizada en la operación.

balanceId
string

El identificador único del Saldo.

balanceKey
string

La clave única que identifica el Saldo.

description
string

Descripción de la transacción.

type
enum<string>

El tipo de la operación. OVERDRAFT identifica operaciones companion generadas por el sistema en el saldo interno "overdraft"direction lleva entonces la semántica del ciclo de vida (debit para un draw, credit para un reembolso). BLOCK y UNBLOCK identifican operaciones producidas por los endpoints de transacción de bloqueo/desbloqueo; direction sigue llevando la semántica de débito/crédito.

Opciones disponibles:
CREDIT,
DEBIT,
ON_HOLD,
RELEASE,
OVERDRAFT,
BLOCK,
UNBLOCK
assetCode
string

El nombre del activo utilizado en la operación.

chartOfAccounts
string

El nombre del Plan de Cuentas al que pertenece la operación.

route
string
obsoleto

Obsoleto. Use routeId en su lugar. Se eliminará en la próxima versión mayor.

routeId
string<uuid>

El identificador único de la ruta de operación asociada a esta operación. Las operaciones companion de overdraft heredan este valor de la operación primaria que las generó.

routeCode
string

Un código legible de la ruta de operación, útil para auditoría y rastreabilidad.

Maximum string length: 100
routeDescription
string

La descripción de la ruta de operación asociada a esta operación.

direction
enum<string>

La dirección de la operación en la contabilidad de partida doble.

Opciones disponibles:
debit,
credit
amount
object

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

balance
object

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

balanceAfter
object

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

status
object

El 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>

Fecha y hora de creación (UTC).

updatedAt
string<date-time>

Fecha y hora de la última actualización (UTC).

deletedAt
string<date-time> | null

Fecha y hora de la eliminación lógica, si aplica (UTC).

metadata
object

Un 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 Costo, use 'costCenter': 'BR_11101997'.

Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.