Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
accounts
/
{account_id}
/
operations
Listar Operações por Conta
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountAlias": "<string>",
      "balanceId": "<string>",
      "balanceKey": "<string>",
      "description": "<string>",
      "assetCode": "<string>",
      "chartOfAccounts": "<string>",
      "route": "<string>",
      "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "routeCode": "<string>",
      "routeDescription": "<string>",
      "amount": {
        "value": "<string>"
      },
      "balance": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123,
        "overdraftUsed": "<string>"
      },
      "balanceAfter": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123,
        "overdraftUsed": "<string>"
      },
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "balanceAffected": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "next_cursor": "<string>",
  "prev_cursor": "<string>",
  "limit": 123
}

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

​
account_id
string
obrigatório

O identificador único da conta da qual você deseja consultar os saldos.

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

Um token de cursor codificado de uma resposta anterior (next_cursor ou prev_cursor) para navegar para frente ou para trás nos resultados.

​
type
enum<enum>

O tipo de operação.

Opções disponíveis:
CREDIT,
DEBIT,
ON_HOLD,
RELEASE,
OVERDRAFT
​
direction
enum<string>

Filtra operações por direção na contabilidade de partida dobrada.

Opções disponíveis:
debit,
credit
​
route_id
string<uuid>

Filtra operações pelo ID da rota de operação.

​
route_code
string

Filtra operações pelo código da rota de operação.

Resposta

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

​
items
object[]
​
next_cursor
string

Cursor codificado apontando para a próxima página de resultados.

​
prev_cursor
string

Cursor codificado apontando para a página anterior de resultados.

​
limit
integer

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