Consultar histórico de saldos por conta

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

import requests

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

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/{account_id}/balances/history', 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/{account_id}/balances/history",
  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/{account_id}/balances/history"

	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/{account_id}/balances/history")
  .asString();

require 'uri'
require 'net/http'

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

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

[
  {
    "id": "019c96a0-0c0d-7915-84b9-e497bfee9916",
    "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
    "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
    "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081",
    "alias": "@conta_corrente",
    "key": "default",
    "assetCode": "BRL",
    "available": "150000",
    "onHold": "25000",
    "version": 42,
    "accountType": "deposit",
    "direction": "credit",
    "overdraftUsed": "0",
    "settings": null,
    "position": {
      "available": "150000",
      "onHold": "25000",
      "overdraftLimitAvailable": "0"
    },
    "createdAt": "2025-06-01T10:00:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  },
  {
    "id": "019c96a0-1234-5678-9abc-def012345678",
    "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
    "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
    "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081",
    "alias": "@conta_corrente",
    "key": "asset-freeze",
    "assetCode": "USD",
    "available": "50000",
    "onHold": "0",
    "version": 12,
    "accountType": "deposit",
    "direction": "credit",
    "overdraftUsed": "0",
    "settings": null,
    "position": {
      "available": "50000",
      "onHold": "0",
      "overdraftLimitAvailable": "0"
    },
    "createdAt": "2025-08-10T14:00:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
]

GET

organizations

{organization_id}

ledgers

{ledger_id}

accounts

{account_id}

balances

history

Consultar histórico de saldos por conta

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

import requests

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

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/{account_id}/balances/history', 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/{account_id}/balances/history",
  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/{account_id}/balances/history"

	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/{account_id}/balances/history")
  .asString();

require 'uri'
require 'net/http'

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

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

[
  {
    "id": "019c96a0-0c0d-7915-84b9-e497bfee9916",
    "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
    "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
    "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081",
    "alias": "@conta_corrente",
    "key": "default",
    "assetCode": "BRL",
    "available": "150000",
    "onHold": "25000",
    "version": 42,
    "accountType": "deposit",
    "direction": "credit",
    "overdraftUsed": "0",
    "settings": null,
    "position": {
      "available": "150000",
      "onHold": "25000",
      "overdraftLimitAvailable": "0"
    },
    "createdAt": "2025-06-01T10:00:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  },
  {
    "id": "019c96a0-1234-5678-9abc-def012345678",
    "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769",
    "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a",
    "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081",
    "alias": "@conta_corrente",
    "key": "asset-freeze",
    "assetCode": "USD",
    "available": "50000",
    "onHold": "0",
    "version": 12,
    "accountType": "deposit",
    "direction": "credit",
    "overdraftUsed": "0",
    "settings": null,
    "position": {
      "available": "50000",
      "onHold": "0",
      "overdraftLimitAvailable": "0"
    },
    "createdAt": "2025-08-10T14:00:00Z",
    "updatedAt": "2026-01-15T10:30:00Z"
  }
]

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.

account_id

string<uuid>

obrigatório

O identificador único da conta.

Parâmetros de consulta

date

string

obrigatório

A data e hora para consultar o estado do saldo. Formato: yyyy-mm-dd hh:mm:ss (ex.: 2026-01-15 10:30:00).

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém todos os estados de saldo no momento especificado.

string<uuid>

O identificador único do Saldo.

organizationId

string<uuid>

O identificador único da Organização.

ledgerId

string<uuid>

O identificador único do Ledger.

accountId

string<uuid>

O identificador único da Conta.

alias

string

O alias da conta (ex., @conta_corrente).

key

string

A chave única do saldo no contexto da conta (ex., default, asset-freeze).

assetCode

string

O código do ativo (ex., BRL, USD).

available

string

O saldo disponível no momento consultado. Representado como uma string decimal com precisão arbitrária (ex., "1500.75").

onHold

string

O saldo retido (reservado) no momento consultado. Representado como uma string decimal com precisão arbitrária (ex., "1500.75").

version

integer

A versão do saldo no momento consultado.

accountType

string

O tipo da conta (ex., deposit, creditCard).

direction

enum<string>

A direção contábil do saldo no momento consultado.

Opções disponíveis:

credit,

debit

overdraftUsed

string

O valor de overdraft consumido no momento consultado, como string decimal. Sempre não negativo.

settings

object

Snapshot da configuração por saldo no momento consultado. null para saldos legados sem configurações personalizadas.

Show child attributes

position

object

read-only

Visão computada do estado do saldo no momento consultado. Sempre presente; nunca persistida. Espelha o formato da posição do saldo ao vivo, então respostas históricas carregam a mesma estrutura de wire das leituras ao vivo.

Show child attributes

createdAt

string<date-time>

Timestamp de criação do saldo (UTC).

updatedAt

string<date-time>

Timestamp da última atualização no momento consultado (UTC).

Consultar histórico de saldo

Criar uma Transação usando JSON

⌘I