How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Heron End User Calculations API

The EndUserCalculations API from Heron — 18 operation(s) for endusercalculations.

Heron End User Calculations API is one of 48 APIs that Heron publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include EndUserCalculations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 18 operations across 18 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 2021-07-19.

Requests are made against a single base URL, https://app.herondata.io.

18 operations 18 paths 49 schemas 16 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2021-07-19
Base URL
https://app.herondata.io/api
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Heron End User Calculations API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 18

Across 18 paths, the API surfaces 18 operations — 16 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

EndUserCalculations 18
GET
/api/end_users/balance
Get EndUser balance
9 params → 200404
GET
/api/end_users/forecast
Get EndUser forecasts
8 params → 200
GET
/api/end_users/statistics
Get EndUser statistics
10 params → 200
GET
/api/end_users/{end_user_id_or_heron_id}/anomalies
Get EndUser anomalies
2 params → 200
GET
/api/end_users/{end_user_id_or_heron_id}/bank_statement_summary
Get EndUser bank statement summary
4 params → 200
GET
/api/end_users/{end_user_id_or_heron_id}/benchmarks
Get EndUser metric benchmarks
1 param → 200
GET
/api/end_users/{end_user_id_or_heron_id}/debt_candidates
Get EndUser debt candidates
1 param → 200
GET
/api/end_users/{end_user_id_or_heron_id}/export_spreadsheet
Export as a spreadsheet
1 param → 200400500
GET
/api/end_users/{end_user_id_or_heron_id}/grouped_transactions_report
Get EndUser transactions grouped by counterparty or merchant
1 param → 200
GET
/api/end_users/{end_user_id_or_heron_id}/heron_score
Get EndUser Heron Score (beta)
3 params → 200
GET
/api/end_users/{end_user_id_or_heron_id}/merchant_summary
Get EndUser merchant summary
5 params → 200
GET
/api/end_users/{end_user_id_or_heron_id}/named_dates
Get EndUser named dates
1 param → 200
GET
/api/end_users/{end_user_id_or_heron_id}/profit_and_loss
Get EndUser cashflow P&L
5 params → 200
PUT
/api/end_users/{end_user_id_or_heron_id}/profit_and_loss_layout
Update EndUser P&L layout
1 param body → 200
GET
/api/end_users/{end_user_id_or_heron_id}/recurring_transactions_report
Get EndUser recurring transactions report
2 params → 200
GET
/api/end_users/{end_user_id_or_heron_id}/scorecard
Get EndUser scorecard
3 params → 200
POST
/api/end_users/{end_user_id_or_heron_id}/scorecard/async
Request EndUser scorecard
2 params → 202
GET
/api/end_users/{end_user_id_or_heron_id}/transaction_data_coverage
Get EndUser transaction data coverage
4 params → 200

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are BankStatementSummaryRow (31 properties), DataSourceAccount (20 properties), MerchantSummaryRowMetrics (17 properties), Rule (11 properties). Each schema is shown below with its type and property counts.

ProfitAndLossLayoutUpdateSchema
object
2 properties 2 required
MerchantCategory
object
3 properties 1 required
DataSourceAccountReconciliationMetric
object
3 properties 3 required
PnlSection
object
3 properties
RuleViolation
object
2 properties
GroupedTransaction
object
5 properties
AccountBalance
object
3 properties 1 required
BankStatementSummaryRow
object
31 properties
DataSourceAccount
object
20 properties 1 required
AccountDataSourcesReconciliation
object
3 properties 3 required
PnlMetricFractionTerm
object
2 properties
AccountTransactionDataCoverage
object
3 properties 3 required
AccountTransactionDataCoverageRange
object
5 properties 3 required
MetricBenchmarksSchema
object
6 properties
EndUserStatsOutputMetrics
object
3 properties
AccountDataSourceReconciliationRange
object
4 properties 4 required
EndUserAccountBalanceForecast
object
3 properties
EndUserBalanceForecast
object
4 properties
EndUserDailyBalance
object
5 properties
EndUserTransactionGroup
object
2 properties
EndUserAccountInfo
object
7 properties
GroupedTransactionsCategory
object
2 properties
EndUserBankStatementSummary
object
9 properties 1 required
Rule
object
11 properties
NamedDateSchema
object
2 properties
EndUserStatsOutputSchema
object
5 properties
ProfitAndLossLayoutSchema
object
1 property
ProfitAndLossSchema
object
2 properties
GroupedTransactionMerchant
object
6 properties
AnomalySchema
object
5 properties
EndUserGroupedTransactionsReport
object
3 properties
DataSourceAccountDateReconciliationMetrics
object
3 properties 3 required
EndUserAccountBalance
object
10 properties
PnlMetric
object
5 properties
MerchantSummaryRowMetrics
object
17 properties
Money
object
2 properties
EndUserTransactionDataCoverageSchema
object
4 properties 3 required
EndUserRecurringTransactionsReport
object
8 properties
Metric
object
9 properties
EndUserBalanceOutputSchema
object
4 properties
EndUserStatsOutputMetricsInstance
object
3 properties
MerchantSummaryRow
object
7 properties
PnlSectionLayout
object
4 properties
PnlMetricLayout
object
5 properties
EndUserForecastOutputSchema
object
5 properties
HeronScoreSchema
object
6 properties
HeronScoreFeatureGroupContribution
object
2 properties
EndUserRecurringTransaction
object
11 properties 3 required
EndUserMerchantSummary
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heron-endusercalculations-api-openapi.yml Raw ↑

Other APIs Heron publishes across the network.

Heron Analytics API
Heron App Store API
Heron Authentication API
Heron Broker Funder Policies API
Heron Broker Submissions API
Heron Categories API
Heron Clear API
Heron Credentials API
Heron CRM Integrations API
Heron Email Templates API
Heron End Users API
Heron End User Accounts API
Where this information came from

This is an independent, third-party profile of Heron End User Calculations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.