Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
balances
Listar Saldos
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/balances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>'
{
  "items": [
    {
      "id": "string",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "alias": "string",
      "key": "string",
      "assetCode": "string",
      "available": "1000.00",
      "onHold": "50.00",
      "version": 0,
      "accountType": "string",
      "allowSending": true,
      "allowReceiving": true,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "deletedAt": null
    }
  ],
  "next_cursor": "string",
  "limit": "10"
}

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string

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

Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser 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
obrigatório

O número máximo de itens a incluir na resposta.

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
enum<enum>

A ordem utilizada para classificar os resultados.

Opções disponíveis:
asc,
desc
cursor
string

A posição no conjunto de dados onde a próxima página de resultados deve começar.

Resposta

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

items
object[]
next_cursor
string

A posição no conjunto de dados da próxima página de resultados.

limit
integer

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