Pular para o conteúdo principal
GET
Listar Operações por Conta

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

limit
integer
padrão:10

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

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

O tipo de operação.

Opções disponíveis:
CREDIT,
DEBIT,
ON_HOLD,
RELEASE,
OVERDRAFT,
BLOCK,
UNBLOCK
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.