Revenue
or Debt Investment
), and then aggregating amounts across these labels to give insights into the company.
The key outcomes we achieve for our customers are:
end_users
request.
end_user_id
field, use a canonical reference/identifier for the company/end_users/{end_user_id}/transactions
endpoint for sending requests.end_users
request, indicating that the end_user is ready
for processing.
end_user_id
is processed
, and available for you to retrieve. You can configure your webhook in the dashboard./transactions
endpoint that was previously used by most customers. The new endpoint that is now standard is much more performant, so we recommend using that endpoint instead. If using the old endpoint, you can use the end_user_id
parameter to ensure you only pull transactions for the end_user_id
that was just enriched. If you get transactions for a company that you’ve already sent to Heron before, you can use the last_updated_min
filter to only get transactions where labels have changed since the last time you send and fetched transactions.All Companies
page. This will give you an overview over the companies (i.e., end_user
) you have created.status
column of the main table. To view the generated reports for a company, click on the companies’ name
.Data Checks
at the topUnderwriting Reports
for one of the companies. Here, you will see multiple reports that visualize Deposits, Withdrawals, Debt, Revenue, P&L, risk flags and other financial metrics about the company.transactions
button on the left.Categories
tab. You can inspect all labels there.end_users/{end_user_id_or_heron_id}/scorecard
request.
Data Coverage
& Data Freshness
. Also includes a measure to see what percentage of all transactions (as a proportion of revenue) appear to be going to an unconnected account held by the company we are analysing.ATM Cash Withdrawals
and distinct days with insufficient funds / overdraft fees.Revenue
, Net Operating Cashflow
, etc.Revenue
over time for each month), send a GET end_users/statistics
request. In the parameters, you can specify:
end_user_id
of the company you are looking atdate_granularity
)merchant
, category
or bothcategory_heron_ids
12345
you would send a GET
request to the following:
end_users/forecast
request. You can use similar logic to the historical timeseries section above to get forecasts for the time intervals and category labels you care about.
For more information on forecasts and any feedback, please talk to us!