Saltar al contenido principal
PATCH
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
Actualizar un Ledger
curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Primary Ledger - Updated",
  "status": {
    "code": "BLOCKED",
    "description": "Ledger access temporarily suspended pending review."
  },
  "metadata": {
    "environment": "production",
    "region": "us-east-1",
    "businessDomain": "retail_banking",
    "supportedInstruments": [
      "deposit_accounts",
      "pix_transfers",
      "internal_transfers"
    ],
    "multiCurrency": false,
    "updatedBy": "system_admin",
    "notes": "Ledger temporarily blocked due to compliance review"
  }
}
'
{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "status": "<unknown>", "metadata": {}, "settings": { "accounting": { "validateAccountType": true, "validateRoutes": true } }, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "deletedAt": "2023-11-07T05:31:56Z" }

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Encabezados

​
Authorization
string

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

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

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
​
name
string

The name of the Ledger.

Maximum string length: 256
​
status
object

An object containing information about the status. Important: If not provided, the default status will be 'ACTIVE'.

​
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 la solicitud fue exitosa y la respuesta contiene los datos esperados.

​
id
string<uuid>

El identificador único del Ledger.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
name
string

The name of the Ledger.

Maximum string length: 256
​
status
any
​
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'.

​
settings
object

Las configuraciones actuales de un Ledger.

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