Saltar al contenido principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
accounts
Listar Cuentas
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assetCode": "<string>",
      "name": "<string>",
      "alias": "<string>",
      "type": "<string>",
      "blocked": false,
      "parentAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entityId": "<string>",
      "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<unknown>",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "limit": 123
}

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.

Parámetros de consulta

​
limit
string

El número máximo de elementos a incluir en la respuesta. Máx: 100

​
start_date
string

El inicio del período que desea recuperar. También debe incluir el end_date.

​
end_date
string

El fin del período que desea recuperar. También debe incluir el start_date.

​
sort_order
string

El orden utilizado para ordenar los resultados.

​
page
string

El número de página que desea recuperar.

​
portfolio_id
string<uuid>

Filtrar cuentas por portafolio. Devuelve solo las cuentas asignadas a este portafolio.

​
segment_id
string<uuid>

Filtrar cuentas por segmento. Devuelve solo las cuentas asignadas a este segmento.

​
status
enum<string>

Filtrar cuentas por estado. Los valores aceptados son active, blocked o inactive.

Opciones disponibles:
active,
blocked,
inactive
​
type
string

Filtrar cuentas por tipo (coincidencia exacta, sin distinción de mayúsculas). Los valores comunes incluyen deposit, savings, loans, marketplace, creditCard y external.

​
asset_code
string

Filtrar cuentas por código de activo (p. ej. BRL, USD).

​
entity_id
string

Filtrar cuentas por identificador de entidad.

​
blocked
boolean

Filtrar cuentas por estado de bloqueo. Use true para listar solo cuentas bloqueadas, false para las desbloqueadas.

​
parent_account_id
string<uuid>

Filtrar cuentas por cuenta padre. Devuelve solo las subcuentas de la cuenta padre especificada.

​
name
string

Filtrar cuentas por nombre. Búsqueda por prefijo (sin distinción de mayúsculas).

​
alias
string

Filtrar cuentas por alias. Búsqueda por prefijo (sin distinción de mayúsculas).

​
metadata.key
string

Filtrar por metadatos usando notación de puntos. Reemplaza key con el nombre de tu campo de metadatos (p. ej. metadata.costCenter=BR_11101997).

Respuesta

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

​
items
object[]
​
page
integer

El número de páginas devueltas.

​
limit
integer

El número máximo de elementos incluidos en la respuesta.