API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
EndUserEmails
EndUserFiles
- GETAll EndUserFiles
- GETGet all file classes
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- PATCHUpdate a file rename rule
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- GETGet parsed results from uploaded files
- POSTTrigger file's rename rule
- POSTTrigger splitting a combined end user file into its child files based on its page_classes
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- GETGet EndUser industry
- GETGet EndUser merchant summary
- GETGet EndUser named dates
- GETGet EndUser cashflow P&L
- PUTUpdate EndUser P&L layout
- GETGet EndUser recurring transactions report
- GETGet EndUser scorecard
- POSTRequest EndUser scorecard
- GETGet EndUser transaction data coverage
EndUserAttributes
EnrichmentFeedback
EndUserFinancials
EndUserRules
Integrations
- POSTSend a Finicity Connect email to an end user
- POSTTrigger a cashflow report generation for an end user
- POSTTrigger a statement reports generation for an end user
- POSTTrigger a Finicity VOE transactions report generation for an end user
- PUTUpdate an Integration Link
- GETList Integrations
- POSTCreate an integration
- PUTUpdate Integration
- GETGet IntegrationLinks by Integration
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
EndUserIntegrations
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
ISOApplication
- POSTUpload an ISO application PDF for for an end user
- GETGet EndUser ISO Applications
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
ParsedEndUserSubmission
Users
Get EndUser balance
Get balance for given EndUser on a daily and account granularity
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
Filter for transactions with date earlier than the input value (inclusive). It has precedence over timestamp_max
ISO 4217 currency code to convert to
GBP, USD, EUR Heron-generated id for end user; either end_user_id or end_user_heron_id is required
Filter for transactions with timestamp after the input value (inclusive). It has precedence over timestamp_min
end_user_id for statistics; either end_user_id or end_user_heron_id is required
If true, forecasts the balances of each account
Deprecated (use date_min instead). Filter for transactions with timestamp after the input value
Deprecated (use date_max instead). Filter for transactions with timestamp earlier than the input value
Response
Account associated with balance
ISO 4217 currency code
3Name of the institution
Name of the account
Number of the account
Name of the account owner
Type of the account
Balance amount
Converted balance amount in target currency
ISO 4217 currency code for balance
3Conversion currency code. ISO 4217 currency code for balance
3Whether the balance has been imputed using forward fill
Whether the date is the latest non-imputed balance for the account
Timestamp of the latest transaction
Account associated with balance
ISO 4217 currency code
3Name of the institution
Name of the account
Number of the account
Name of the account owner
Type of the account
Balance amount
Converted balance amount in target currency
ISO 4217 currency code for balance
3Conversion currency code. ISO 4217 currency code for balance
3Whether the balance has been imputed using forward fill
Whether the date is the latest non-imputed balance for the account
Timestamp of the latest transaction
Balance amount
ISO 4217 currency code for balance
3Date of balance
Account associated with balance
ISO 4217 currency code
3Name of the institution
Name of the account
Number of the account
Name of the account owner
Type of the account
Balance amount
Converted balance amount in target currency
ISO 4217 currency code for balance
3Conversion currency code. ISO 4217 currency code for balance
3Whether the balance has been imputed using forward fill
Whether the date is the latest non-imputed balance for the account
Timestamp of the latest transaction
Account associated with balance
ISO 4217 currency code
3Name of the institution
Name of the account
Number of the account
Name of the account owner
Type of the account
Balance amount
Converted balance amount in target currency
ISO 4217 currency code for balance
3Conversion currency code. ISO 4217 currency code for balance
3Whether the balance has been imputed using forward fill
Whether the date is the latest non-imputed balance for the account
Timestamp of the latest transaction
Balance amount
ISO 4217 currency code for balance
3Date of balance
Was this page helpful?