Saltar al contenido principal
PATCH
Actualizar una Transacción Route

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.

transaction_route_id
string<uuid>
requerido

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

Cuerpo

application/json
title
string

Texto breve que resume el propósito de la transacción. Se utiliza como nota de asiento para su identificación.

Maximum string length: 50
description
string

Una descripción para la Ruta de Transacción.

Maximum string length: 250
operationRoutes
string<uuid>[] | null

Una lista de IDs de Rutas de Operación que definen la lógica de origen y destino de la transacción. Importante: Una ruta de transacción debe incluir al menos una ruta de operación con type: "source" y al menos una ruta de operación con type: "destination".

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.

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>

El identificador único de la Organización.

ledgerId
string<uuid>

El identificador único del Ledger.

title
string

Texto breve que resume el propósito de la transacción. Se utiliza como nota de asiento para su identificación.

description
string

Una descripción para la Ruta de Transacción.

operationRoutes
object[]

Lista de objetos que contienen información sobre las Rutas de Operación de la Ruta de Transacción.

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.