Listar Contas

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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": {
        "code": "<string>",
        "description": "<string>"
      },
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "limit": 123
}

GET

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

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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": {
        "code": "<string>",
        "description": "<string>"
      },
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": 123,
  "limit": 123
}

Cabeçalhos

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.

Authorization

string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

organization_id

string<uuid>

obrigatório

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

ledger_id

string<uuid>

obrigatório

O identificador único do Ledger associado.

Parâmetros de consulta

limit

integer

padrão:10

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

Intervalo obrigatório: 1 <= x <= 100

start_date

string

O início do período que você deseja consultar. start_date e end_date são tudo-ou-nada: fornecer apenas um retorna 400. Se ambos forem omitidos, é usada uma janela padrão do último 1 mês.

end_date

string

O fim do período que você deseja consultar. start_date e end_date são tudo-ou-nada: fornecer apenas um retorna 400. Se ambos forem omitidos, é usada uma janela padrão do último 1 mês.

sort_order

enum<string>

padrão:asc

A ordem utilizada para classificar os resultados.

Opções disponíveis:

asc,

desc

page

integer

padrão:1

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

Intervalo obrigatório: x >= 1

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 pelo code do seu status. Os valores aceitos são ACTIVE, INACTIVE ou BLOCKED (em maiúsculas, correspondência exata).

Opções disponíveis:

ACTIVE,

INACTIVE,

BLOCKED

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[]

Show child attributes

page

integer

O número de páginas retornadas.

limit

integer

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

Criar uma Conta

Consultar uma Conta

⌘I