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
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEntity
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
- PATCHUpdate Parsed Results
- 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
Save user's settings
curl --request PUT \
--url https://app.herondata.io/api/users/current/settings \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"balance_sheet_categories": {
"current_assets": {},
"current_liabilities": {},
"equity": {},
"fixed_assets": {},
"non_current_liabilities": {},
"other_assets": {}
},
"financials_metrics": {},
"low_balance_days_threshold": 123,
"pnl_categories": {
"cogs": {},
"income": {},
"operating_expenses": {},
"other_expenses": {},
"other_income": {}
},
"required_revenue_per_month": 123,
"use_new_company_layout": true,
"use_new_end_user_table": true
}'Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
A list of example line item labels that map to this category
A list of example line item labels that map to this category
A list of example line item labels that map to this category
A list of example line item labels that map to this category
A list of example line item labels that map to this category
The context to be used in the query
A list of date ranges to be used in the query
The type of formula to be used
The value to be used in the formula
The metric to be used
The date range to be used in the query. It will override the date range specified in the metric spec
A filter to be applied before computing the metric
A list of filters to be applied before computing the metric
The value to be used if the metric is not available
The group to be used in the query
The unit to be used in the query
A list of example line item labels that map to this category
A list of example line item labels that map to this category
A list of example line item labels that map to this category
A list of example line item labels that map to this category
Response
OK
Was this page helpful?
curl --request PUT \
--url https://app.herondata.io/api/users/current/settings \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"balance_sheet_categories": {
"current_assets": {},
"current_liabilities": {},
"equity": {},
"fixed_assets": {},
"non_current_liabilities": {},
"other_assets": {}
},
"financials_metrics": {},
"low_balance_days_threshold": 123,
"pnl_categories": {
"cogs": {},
"income": {},
"operating_expenses": {},
"other_expenses": {},
"other_income": {}
},
"required_revenue_per_month": 123,
"use_new_company_layout": true,
"use_new_end_user_table": true
}'