Get EndUser balance

curl --request GET \
  --url https://app.herondata.io/api/end_users/balance \
  --header 'x-api-key: <api-key>'

{
  "daily_balances": [
    {
      "accounts": [
        {
          "account_id": "<string>",
          "account_info": {
            "currency": "USD",
            "institution_name": "Chase",
            "name": "Checking Account",
            "number": "123456789",
            "owner_name": "John Doe",
            "type": "Checking"
          },
          "balance": 123,
          "balance_converted": 123,
          "currency": "USD",
          "currency_converted": "USD",
          "is_computed": true,
          "is_latest": true,
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "accounts_not_converted": [
        {
          "account_id": "<string>",
          "account_info": {
            "currency": "USD",
            "institution_name": "Chase",
            "name": "Checking Account",
            "number": "123456789",
            "owner_name": "John Doe",
            "type": "Checking"
          },
          "balance": 123,
          "balance_converted": 123,
          "currency": "USD",
          "currency_converted": "USD",
          "is_computed": true,
          "is_latest": true,
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "balance": 123,
      "currency": "USD",
      "date": "2023-12-25"
    }
  ],
  "forecasted": [
    {
      "account_id": "<string>",
      "balances": [
        {
          "date": "2025-11-26",
          "predicted": 42.42,
          "predicted_lower": 4.24,
          "predicted_upper": 420.42
        }
      ],
      "currency": "<string>"
    }
  ],
  "summary": {
    "accounts": [
      {
        "account_id": "<string>",
        "account_info": {
          "currency": "USD",
          "institution_name": "Chase",
          "name": "Checking Account",
          "number": "123456789",
          "owner_name": "John Doe",
          "type": "Checking"
        },
        "balance": 123,
        "balance_converted": 123,
        "currency": "USD",
        "currency_converted": "USD",
        "is_computed": true,
        "is_latest": true,
        "timestamp": "2023-11-07T05:31:56Z"
      }
    ],
    "accounts_not_converted": [
      {
        "account_id": "<string>",
        "account_info": {
          "currency": "USD",
          "institution_name": "Chase",
          "name": "Checking Account",
          "number": "123456789",
          "owner_name": "John Doe",
          "type": "Checking"
        },
        "balance": 123,
        "balance_converted": 123,
        "currency": "USD",
        "currency_converted": "USD",
        "is_computed": true,
        "is_latest": true,
        "timestamp": "2023-11-07T05:31:56Z"
      }
    ],
    "balance": 123,
    "currency": "USD",
    "date": "2023-12-25"
  }
}

GET

api

end_users

balance

Get EndUser balance

curl --request GET \
  --url https://app.herondata.io/api/end_users/balance \
  --header 'x-api-key: <api-key>'

{
  "daily_balances": [
    {
      "accounts": [
        {
          "account_id": "<string>",
          "account_info": {
            "currency": "USD",
            "institution_name": "Chase",
            "name": "Checking Account",
            "number": "123456789",
            "owner_name": "John Doe",
            "type": "Checking"
          },
          "balance": 123,
          "balance_converted": 123,
          "currency": "USD",
          "currency_converted": "USD",
          "is_computed": true,
          "is_latest": true,
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "accounts_not_converted": [
        {
          "account_id": "<string>",
          "account_info": {
            "currency": "USD",
            "institution_name": "Chase",
            "name": "Checking Account",
            "number": "123456789",
            "owner_name": "John Doe",
            "type": "Checking"
          },
          "balance": 123,
          "balance_converted": 123,
          "currency": "USD",
          "currency_converted": "USD",
          "is_computed": true,
          "is_latest": true,
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "balance": 123,
      "currency": "USD",
      "date": "2023-12-25"
    }
  ],
  "forecasted": [
    {
      "account_id": "<string>",
      "balances": [
        {
          "date": "2025-11-26",
          "predicted": 42.42,
          "predicted_lower": 4.24,
          "predicted_upper": 420.42
        }
      ],
      "currency": "<string>"
    }
  ],
  "summary": {
    "accounts": [
      {
        "account_id": "<string>",
        "account_info": {
          "currency": "USD",
          "institution_name": "Chase",
          "name": "Checking Account",
          "number": "123456789",
          "owner_name": "John Doe",
          "type": "Checking"
        },
        "balance": 123,
        "balance_converted": 123,
        "currency": "USD",
        "currency_converted": "USD",
        "is_computed": true,
        "is_latest": true,
        "timestamp": "2023-11-07T05:31:56Z"
      }
    ],
    "accounts_not_converted": [
      {
        "account_id": "<string>",
        "account_info": {
          "currency": "USD",
          "institution_name": "Chase",
          "name": "Checking Account",
          "number": "123456789",
          "owner_name": "John Doe",
          "type": "Checking"
        },
        "balance": 123,
        "balance_converted": 123,
        "currency": "USD",
        "currency_converted": "USD",
        "is_computed": true,
        "is_latest": true,
        "timestamp": "2023-11-07T05:31:56Z"
      }
    ],
    "balance": 123,
    "currency": "USD",
    "date": "2023-12-25"
  }
}

Authorizations

x-api-key

string

header

required

Query Parameters

date_min

string<date> | null

Filter for transactions with timestamp after the input value (inclusive). It has precedence over timestamp_min

Example:

"2025-11-26"

include_forecast

boolean

default:false

If true, forecasts the balances of each account

end_user_heron_id

string | null

Heron-generated id for end user; either end_user_id or end_user_heron_id is required

Example:

"eus_5BqfbZ7TNguJhmFTiDopqU"

account_ids

string[]

Filter by specific account reference IDs

Example:

["1234", "5678"]

to_currency

enum<string> | null

ISO 4217 currency code to convert to

Available options:

GBP,

USD,

EUR,

Example:

"USD"

end_user_id

string | null

end_user_id for statistics; either end_user_id or end_user_heron_id is required

Example:

"your_end_user_id"

timestamp_max

string<date-time> | null

Deprecated (use date_max instead). Filter for transactions with timestamp earlier than the input value

Example:

"2025-11-25T20:46:06.372857"

date_max

string<date> | null

Filter for transactions with date earlier than the input value (inclusive). It has precedence over timestamp_max

Example:

"2025-11-25"

timestamp_min

string<date-time> | null

Deprecated (use date_min instead). Filter for transactions with timestamp after the input value

Example:

"2025-11-26T20:46:06.372807"

Response

200 - application/json

daily_balances

object[]

Show child attributes

daily_balances.accounts

object[]

Show child attributes

daily_balances.accounts.account_id

string

Account associated with balance

daily_balances.accounts.account_info

object

Show child attributes

daily_balances.accounts.account_info.currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

daily_balances.accounts.account_info.institution_name

string

Name of the institution

Example:

"Chase"

daily_balances.accounts.account_info.name

string

Name of the account

Example:

"Checking Account"

daily_balances.accounts.account_info.number

string

Number of the account

Example:

"123456789"

daily_balances.accounts.account_info.owner_name

string

Name of the account owner

Example:

"John Doe"

daily_balances.accounts.account_info.type

string

Type of the account

Example:

"Checking"

daily_balances.accounts.balance

number

Balance amount

daily_balances.accounts.balance_converted

number

Converted balance amount in target currency

daily_balances.accounts.currency

string | null

ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

daily_balances.accounts.currency_converted

string | null

Conversion currency code. ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

daily_balances.accounts.is_computed

boolean

Whether the balance has been imputed using forward fill

daily_balances.accounts.is_latest

boolean

Whether the date is the latest non-imputed balance for the account

daily_balances.accounts.timestamp

string<date-time>

Timestamp of the latest transaction

daily_balances.accounts_not_converted

object[]

Show child attributes

daily_balances.accounts_not_converted.account_id

string

Account associated with balance

daily_balances.accounts_not_converted.account_info

object

Show child attributes

daily_balances.accounts_not_converted.account_info.currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

daily_balances.accounts_not_converted.account_info.institution_name

string

Name of the institution

Example:

"Chase"

daily_balances.accounts_not_converted.account_info.name

string

Name of the account

Example:

"Checking Account"

daily_balances.accounts_not_converted.account_info.number

string

Number of the account

Example:

"123456789"

daily_balances.accounts_not_converted.account_info.owner_name

string

Name of the account owner

Example:

"John Doe"

daily_balances.accounts_not_converted.account_info.type

string

Type of the account

Example:

"Checking"

daily_balances.accounts_not_converted.balance

number

Balance amount

daily_balances.accounts_not_converted.balance_converted

number

Converted balance amount in target currency

daily_balances.accounts_not_converted.currency

string | null

ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

daily_balances.accounts_not_converted.currency_converted

string | null

Conversion currency code. ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

daily_balances.accounts_not_converted.is_computed

boolean

Whether the balance has been imputed using forward fill

daily_balances.accounts_not_converted.is_latest

boolean

Whether the date is the latest non-imputed balance for the account

daily_balances.accounts_not_converted.timestamp

string<date-time>

Timestamp of the latest transaction

daily_balances.balance

number

Balance amount

daily_balances.currency

string | null

ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

daily_balances.date

string<date>

Date of balance

forecasted

object[]

Show child attributes

forecasted.account_id

string

forecasted.balances

object[]

Show child attributes

forecasted.balances.date

string

Forecast date at specified date granularity

Example:

"2025-11-26"

forecasted.balances.predicted

number

Predicted converted balance

Example:

42.42

forecasted.balances.predicted_lower

number

Predict amount lower bound

Example:

4.24

forecasted.balances.predicted_upper

number

Predicted amount upper bound

Example:

420.42

forecasted.currency

string

summary

object

Show child attributes

summary.accounts

object[]

Show child attributes

summary.accounts.account_id

string

Account associated with balance

summary.accounts.account_info

object

Show child attributes

summary.accounts.account_info.currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

summary.accounts.account_info.institution_name

string

Name of the institution

Example:

"Chase"

summary.accounts.account_info.name

string

Name of the account

Example:

"Checking Account"

summary.accounts.account_info.number

string

Number of the account

Example:

"123456789"

summary.accounts.account_info.owner_name

string

Name of the account owner

Example:

"John Doe"

summary.accounts.account_info.type

string

Type of the account

Example:

"Checking"

summary.accounts.balance

number

Balance amount

summary.accounts.balance_converted

number

Converted balance amount in target currency

summary.accounts.currency

string | null

ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

summary.accounts.currency_converted

string | null

Conversion currency code. ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

summary.accounts.is_computed

boolean

Whether the balance has been imputed using forward fill

summary.accounts.is_latest

boolean

Whether the date is the latest non-imputed balance for the account

summary.accounts.timestamp

string<date-time>

Timestamp of the latest transaction

summary.accounts_not_converted

object[]

Show child attributes

summary.accounts_not_converted.account_id

string

Account associated with balance

summary.accounts_not_converted.account_info

object

Show child attributes

summary.accounts_not_converted.account_info.currency

string | null

ISO 4217 currency code

Required string length: 3

Example:

"USD"

summary.accounts_not_converted.account_info.institution_name

string

Name of the institution

Example:

"Chase"

summary.accounts_not_converted.account_info.name

string

Name of the account

Example:

"Checking Account"

summary.accounts_not_converted.account_info.number

string

Number of the account

Example:

"123456789"

summary.accounts_not_converted.account_info.owner_name

string

Name of the account owner

Example:

"John Doe"

summary.accounts_not_converted.account_info.type

string

Type of the account

Example:

"Checking"

summary.accounts_not_converted.balance

number

Balance amount

summary.accounts_not_converted.balance_converted

number

Converted balance amount in target currency

summary.accounts_not_converted.currency

string | null

ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

summary.accounts_not_converted.currency_converted

string | null

Conversion currency code. ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

summary.accounts_not_converted.is_computed

boolean

Whether the balance has been imputed using forward fill

summary.accounts_not_converted.is_latest

boolean

Whether the date is the latest non-imputed balance for the account

summary.accounts_not_converted.timestamp

string<date-time>

Timestamp of the latest transaction

summary.balance

number

Balance amount

summary.currency

string | null

ISO 4217 currency code for balance

Required string length: 3

Example:

"USD"

summary.date

string<date>

Date of balance

Remove a FileClass from Classification for a User Get EndUser forecasts

⌘I

API Reference

AppStore

Categories

Credentials

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEnrichers

EndUserEntity

EndUserFiles

FileClass

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

Policy

Positions

EnrichedTransactions

Transactions

Funders

Testing

Merchants

Rules

ParsedEndUserSubmission

UserMerchantGroups

Users

Watermarks

Webhooks

Workflows

Authorizations

Query Parameters

Response