Contas

Histórico de saldo de uma ou mais contas

Retorna o histórico diário de saldo (account_balance_history) de uma ou mais contas do workspace vinculado à chave de API, filtrado por período. Aceita account_id repetido (account_id=1&account_id=2) ou separado por vírgula (account_id=1,2) para trazer várias contas de uma vez; se omitido, traz todas as contas do workspace. Por padrão retorna uma linha por conta/dia (BalanceHistoryList); com group_by=day, o resultado vem agrupado por data — cada dia traz o último saldo de cada conta pedida, lado a lado, mais total somando os saldos do dia (BalanceHistoryDayList). Contas informadas precisam pertencer a esse workspace.

get/api/v1/accounts/balance-history

Request

Base URL: https://snabber.com.br
URL: https://snabber.com.br/api/v1/accounts/balance-history
Auth: HTTP bearer

Query parameters

workspace_idinteger

Workspace a consultar, entre os autorizados para esta chave (ver GET /api/v1/workspaces). Se omitido, usa o workspace padrão da chave. Um id fora do conjunto autorizado resulta em 400 INVALID_WORKSPACE. Só é possível autorizar (em /integrations) um workspace do qual o dono da chave já é membro — para incluir dados de um workspace de outra pessoa, ela precisa primeiro compartilhar esse workspace com você (convite em /workspaces), não basta saber o id.

account_idstring

Id da conta, ou várias separadas por vírgula (ex: 12,34) ou repetindo o parâmetro (ver /api/v1/accounts). Se omitido, traz todas as contas do workspace.

fromstring date

Data inicial (inclusiva), YYYY-MM-DD

tostring date

Data final (inclusiva), YYYY-MM-DD

group_by'day'

Se "day", agrupa o resultado por data — cada dia traz o saldo de cada conta pedida lado a lado

Response

Histórico de saldo (BalanceHistoryList, ou BalanceHistoryDayList quando group_by=day)

Example response

{
  "data": [
    {
      "currency_code": "BRL"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.