Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
accounts
Listar Contas
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.

Cabeçalhos

Authorization
string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver Access Manager habilitado.

Content-Type
string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Parâmetros de caminho

organization_id
string
obrigatório

O identificador único da Organização associada ao Ledger.

ledger_id
string
obrigatório

O identificador único do Ledger associado.

Parâmetros de consulta

limit
string

O número máximo de itens a incluir na resposta. Máx: 100

start_date
string

O início do período que você deseja consultar. Você também deve incluir o end_date.

end_date
string

O fim do período que você deseja consultar. Você também deve incluir o start_date.

sort_order
string

A ordem utilizada para classificar os resultados.

page
string

O número da página que você deseja consultar.

portfolio_id
string<uuid>

Filtra contas por portfólio. Retorna apenas contas atribuídas a este portfólio.

segment_id
string<uuid>

Filtra contas por segmento. Retorna apenas contas atribuídas a este segmento.

status
enum<string>

Filtra contas por status. Os valores aceitos são active, blocked ou inactive.

Opções disponíveis:
active,
blocked,
inactive
type
string

Filtra contas por tipo (correspondência exata, sem distinção de maiúsculas). Valores comuns incluem deposit, savings, loans, marketplace, creditCard e external.

asset_code
string

Filtra contas por código do ativo (ex.: BRL, USD).

entity_id
string

Filtra contas pelo identificador da entidade.

blocked
boolean

Filtra contas pelo estado de bloqueio. Use true para listar apenas contas bloqueadas, false para desbloqueadas.

parent_account_id
string<uuid>

Filtra contas pela conta-pai. Retorna apenas as subcontas da conta-pai especificada.

name
string

Filtra contas por nome. Busca por prefixo (case-insensitive).

alias
string

Filtra contas por alias. Busca por prefixo (case-insensitive).

metadata.key
string

Filtra por metadata usando notação de ponto. Substitua key pelo nome do seu campo de metadata (ex.: metadata.costCenter=BR_11101997).

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

items
object[]
page
integer

O número de páginas retornadas.

limit
integer

O número máximo de itens incluídos na resposta.