---
title: "Get EndUser balance"
method: GET
path: "/api/end_users/balance"
tags: ["EndUserCalculations"]
---

# Get EndUser balance

`GET /api/end_users/balance`

Get balance for given EndUser on a daily and account granularity

## Query parameters

- `end_user_id` string, nullable
- `end_user_heron_id` string, nullable
- `to_currency` 'GBP' | 'USD' | 'EUR' | 'CAD' | 'AUD' | 'null', nullable
- `timestamp_min` string, date-time, nullable
- `date_min` string, date, nullable
- `timestamp_max` string, date-time, nullable
- `date_max` string, date, nullable
- `include_forecast` boolean
- `account_ids` string[]

## Response `200`

OK. Empty balances include a warning reason when no balance data is available.

- EndUserBalanceOutputSchema
  - `daily_balances` EndUserDailyBalance[]
    - `accounts` EndUserAccountBalance[]
      - `account_id` string — Account associated with balance
      - `account_info` EndUserAccountInfo
        - `currency` string, nullable — ISO 4217 currency code
        - `heron_id` string — Heron ID of the data source account
        - `institution_name` string — Name of the institution
        - `name` string — Name of the account
        - `number` string — Number of the account
        - `owner_name` string — Name of the account owner
        - `type` string — Type of the account
      - `balance` number — Balance amount
      - `balance_converted` number — Converted balance amount in target currency
      - `currency` string, nullable — ISO 4217 currency code for balance
      - `currency_converted` string, nullable — Conversion currency code. ISO 4217 currency code for balance
      - `display_account_id` string, nullable — Human-readable account label for display: the last four digits of the account number (falling back to the account name). Not unique and not a key; use account_id to join.
      - `is_computed` boolean — Whether the balance has been imputed using forward fill
      - `is_latest` boolean — Whether the date is the latest non-imputed balance for the account
      - `timestamp` string, date-time — Timestamp of the latest transaction
    - `accounts_not_converted` EndUserAccountBalance[]
      - `account_id` string — Account associated with balance
      - `account_info` EndUserAccountInfo
        - `currency` string, nullable — ISO 4217 currency code
        - `heron_id` string — Heron ID of the data source account
        - `institution_name` string — Name of the institution
        - `name` string — Name of the account
        - `number` string — Number of the account
        - `owner_name` string — Name of the account owner
        - `type` string — Type of the account
      - `balance` number — Balance amount
      - `balance_converted` number — Converted balance amount in target currency
      - `currency` string, nullable — ISO 4217 currency code for balance
      - `currency_converted` string, nullable — Conversion currency code. ISO 4217 currency code for balance
      - `display_account_id` string, nullable — Human-readable account label for display: the last four digits of the account number (falling back to the account name). Not unique and not a key; use account_id to join.
      - `is_computed` boolean — Whether the balance has been imputed using forward fill
      - `is_latest` boolean — Whether the date is the latest non-imputed balance for the account
      - `timestamp` string, date-time — Timestamp of the latest transaction
    - `balance` number — Balance amount
    - `currency` string, nullable — ISO 4217 currency code for balance
    - `date` string, date — Date of balance
  - `forecasted` EndUserAccountBalanceForecast[]
    - `account_id` string
    - `balances` EndUserBalanceForecast[]
      - `date` string — Forecast date at specified date granularity
      - `predicted` number — Predicted converted balance
      - `predicted_lower` number — Predict amount lower bound
      - `predicted_upper` number — Predicted amount upper bound
    - `currency` string
  - `summary` EndUserDailyBalance
    - `accounts` EndUserAccountBalance[]
      - `account_id` string — Account associated with balance
      - `account_info` EndUserAccountInfo
        - `currency` string, nullable — ISO 4217 currency code
        - `heron_id` string — Heron ID of the data source account
        - `institution_name` string — Name of the institution
        - `name` string — Name of the account
        - `number` string — Number of the account
        - `owner_name` string — Name of the account owner
        - `type` string — Type of the account
      - `balance` number — Balance amount
      - `balance_converted` number — Converted balance amount in target currency
      - `currency` string, nullable — ISO 4217 currency code for balance
      - `currency_converted` string, nullable — Conversion currency code. ISO 4217 currency code for balance
      - `display_account_id` string, nullable — Human-readable account label for display: the last four digits of the account number (falling back to the account name). Not unique and not a key; use account_id to join.
      - `is_computed` boolean — Whether the balance has been imputed using forward fill
      - `is_latest` boolean — Whether the date is the latest non-imputed balance for the account
      - `timestamp` string, date-time — Timestamp of the latest transaction
    - `accounts_not_converted` EndUserAccountBalance[]
      - `account_id` string — Account associated with balance
      - `account_info` EndUserAccountInfo
        - `currency` string, nullable — ISO 4217 currency code
        - `heron_id` string — Heron ID of the data source account
        - `institution_name` string — Name of the institution
        - `name` string — Name of the account
        - `number` string — Number of the account
        - `owner_name` string — Name of the account owner
        - `type` string — Type of the account
      - `balance` number — Balance amount
      - `balance_converted` number — Converted balance amount in target currency
      - `currency` string, nullable — ISO 4217 currency code for balance
      - `currency_converted` string, nullable — Conversion currency code. ISO 4217 currency code for balance
      - `display_account_id` string, nullable — Human-readable account label for display: the last four digits of the account number (falling back to the account name). Not unique and not a key; use account_id to join.
      - `is_computed` boolean — Whether the balance has been imputed using forward fill
      - `is_latest` boolean — Whether the date is the latest non-imputed balance for the account
      - `timestamp` string, date-time — Timestamp of the latest transaction
    - `balance` number — Balance amount
    - `currency` string, nullable — ISO 4217 currency code for balance
    - `date` string, date — Date of balance
  - `warnings` string[] — Empty-balance reason codes. Populated responses return an empty list.

## Other responses

- `404` — EndUser not found or inaccessible

---

[API](https://skmtc.dev/herondata/apis/heron-data-api.md) · [All operations](https://skmtc.dev/herondata/apis/heron-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/herondata/heron-data-api/revisions/f2e441edece2/schema)