Skip to main content
API docs by Redocly

Heron Data API (2021-07-19)

Download OpenAPI specification:Download

Support: [email protected]
Read Tutorial

EnrichmentFeedback

Bulk create category feedback

Provide bulk feedback on Transaction Categories

Authorizations:
BasicAuth
Request Body schema: application/json

A list of objects containing a Transaction's heron id and the suggested Category. If you provide a heron_id for Category, you don't need to provide other fields. If heron_id is provided, we disregard label.

Array
object (CategoryFeedback)
source
string or null <= 120 characters
Default: null

your identifier for where the feedback comes from e.g. bob_the_underwriter

transaction_heron_id
required
string

heron id of transaction

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "num_annotations": 1
}

Create category, merchant feedback

Provide feedback on a Transaction's Categories and Merchants

Authorizations:
BasicAuth
path Parameters
heron_id
required
string

Transaction heron_id

Request Body schema: application/json

A partial Transaction object with the suggested Category and/or Merchant. If you provide a heron_id for Category or Merchant, you don't need to provide other fields. If you don't know the Merchant heron_id nor name, you can just send the is_correct boolean. If heron_id is provided, we disregard name and label. If is_correct is set to true, we disregard all other Merchant fields.

object (TransactionFeedbackSchema)
object
Default: {}
object
Default: {}
source
string or null <= 120 characters
Default: null

your identifier for where the feedback comes from e.g. bob_the_underwriter

Responses

Request samples

Content type
application/json
{
  • "transaction": {
    }
}

Categories

Get categories

Get available categories

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

EndUserDataSources

Update a data source

Update a data source

Authorizations:
BasicAuth
path Parameters
heron_id
required
string
Request Body schema: application/json
is_enabled
boolean
Default: true

Whether or not the data source is enabled. If disabled, hides related transactions from analytics

Responses

Request samples

Content type
application/json
{
  • "is_enabled": true
}

Response samples

Content type
application/json
{
  • "created": "2023-08-16T16:32:22.040862",
  • "data_source_accounts": [
    ],
  • "heron_id": "dso_DdxQe6EZK2Cs9wuRYvoDZV",
  • "is_enabled": true,
  • "last_updated": "2023-09-27T16:32:22.040910",
  • "metadata": {
    },
  • "reference_id": "pdf_ZqDefQ7MSde9FN4Sfwteyn",
  • "status": "new",
  • "type": "pdf"
}

Get data sources

Get a list of data sources for a company

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

EndUsers

List EndUsers

Get a list of EndUsers

Authorizations:
BasicAuth
query Parameters
limit
integer [ 1 .. 10000 ]
Default: 1000

Pagination limit per page

include_data_sources
boolean
Default: false
Example: include_data_sources=true

Whether the to include data sources for each end user

is_portfolio
boolean or null
Default: null
Example: is_portfolio=true

Whether the end user is part of a lending portfolio

end_user_id
string or null
Default: null
Example: end_user_id=your_end_user_id

Filter by ID associated with end_user_id field in transactions

status
string or null
Default: null
Enum: "new" "ready" "processed" "reviewed" "review_requested" "failed"
Example: status=reviewed

Filter by status of end user

heron_id
string or null
Default: null
Example: heron_id=eus_8UpzDVDvPRetuDtwZw42Fu

Unique ID generated by Heron

order_by
string
Default: "last_updated_desc"
Enum: "last_updated_desc" "last_updated_asc"

Order to return end users by

page
integer >= 1
Default: 1

Pagination page number

name
string or null
Default: null
Example: name=your_end_user_name

Filter by name associated with end user

Responses

Response samples

Content type
application/json
{
  • "_meta": {
    },
  • "end_users": [
    ]
}

Create EndUser

Create a new end user. If transactions have previously been sent for this end_user_id, use PUT end_users to update instead.

Authorizations:
BasicAuth
Request Body schema: application/json
object (EndUser)
end_user_id
required
string

id defined by user; links to the end_user_id for transactions

is_portfolio
boolean

Whether the end user is part of a lending portfolio

name
string or null

Name of end user; may help to improve categorisation accuracy

profit_and_loss_layout
any or null
status
string
Enum: "new" "ready" "review_requested" "reviewed"

Status of end user; 'ready' triggers async processing, 'review_requested' triggers manual review request

Responses

Request samples

Content type
application/json
{
  • "end_user": {
    }
}

Response samples

Content type
application/json
{
  • "end_user": {
    }
}

Update EndUser

Confirm an end user is ready for async procesing by sending a status of "ready". The end_user_id must have previously been sent with at least one Transaction.

Webhook Tutorial
Authorizations:
BasicAuth
Request Body schema: application/json

Dictionary representing an EndUser

object (EndUser)
end_user_id
required
string

id defined by user; links to the end_user_id for transactions

is_portfolio
boolean

Whether the end user is part of a lending portfolio

name
string or null

Name of end user; may help to improve categorisation accuracy

profit_and_loss_layout
any or null
status
string
Enum: "new" "ready" "review_requested" "reviewed"

Status of end user; 'ready' triggers async processing, 'review_requested' triggers manual review request

Responses

Callbacks

Request samples

Content type
application/json
{
  • "end_user": {
    }
}

Response samples

Content type
application/json
{
  • "end_user": {
    }
}

Callback payload samples

Callback
POST: $yourWebhookUrl
Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "data": {
    },
  • "meta": { },
  • "topic": "string"
}

Delete EndUser by heron_id or end_user_id

Delete an end user. You must delete associated transactions before doing this.

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

Responses

Get EndUser by heron_id or end_user_id

Get an end user using its end_user_id or heron_id

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

Responses

Response samples

Content type
application/json
{
  • "end_user": {
    }
}

Send patch transactions for a pdf statement

Send patch transactions processed pdf that will override the extracted transactions in the specified statement

Authorizations:
BasicAuth
path Parameters
heron_id
required
string

heron_id of the pdf

Request Body schema: application/json
exclude
boolean

True if the statement should be excluded from processing

index
required
integer

The index of the statement in the pdf to patch

object (PdfPatchStatementSummary)
required
Array of objects (PdfPatchTransaction)

The full list of transactions that will be used to override the extracted transactions for the specified statement

Responses

Request samples

Content type
application/json
{
  • "exclude": true,
  • "index": 0,
  • "summary": {
    },
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "ok": true
}

EndUserCalculations

Get EndUser balance

Get balance for given EndUser on a daily and account granularity

Authorizations:
BasicAuth
query Parameters
to_currency
string or null
Enum: "GBP" "USD" "EUR"
Example: to_currency=USD

ISO 4217 currency code to convert to

timestamp_min
string or null <date-time>
Default: null
Example: timestamp_min=2023-09-27T16:32:22.024487

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

include_forecast
boolean
Default: false

If true, forecasts the balances of each account

date_min
string or null <date>
Default: null
Example: date_min=2023-09-27

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

date_max
string or null <date>
Default: null
Example: date_max=2023-09-26

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

end_user_id
string or null
Default: null
Example: end_user_id=your_end_user_id

end_user_id for statistics; either end_user_id or end_user_heron_id is required

end_user_heron_id
string or null
Default: null
Example: end_user_heron_id=eus_j9Hsdj3C8Mr6BYx34dM9QL

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

timestamp_max
string or null <date-time>
Default: null
Example: timestamp_max=2023-09-26T16:32:22.024543

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

Responses

Response samples

Content type
application/json
{
  • "daily_balances": [
    ],
  • "forecasted": [
    ],
  • "summary": {
    }
}

Get EndUser forecasts

Get forecast amounts for a given EndUser and category

Authorizations:
BasicAuth
query Parameters
to_currency
string or null
Enum: "GBP" "USD" "EUR"
Example: to_currency=USD

ISO 4217 currency code to convert to

to_date
string or null <date>
Default: null
Example: to_date=2022-01-31

The latest transaction timestamp date to use in forecasting

category_heron_id
string
Example: category_heron_id=ctg_bLf8NBiJ8jqekUa7cFEeDS

Heron ID of category to be forecasted; either category_heron_id or category_label must be present

date_granularity
string
Default: "month"
Enum: "week" "month"
Example: date_granularity=month

Aggregate results over time, i.e., aggregate by week or by month

end_user_id
string or null
Default: null
Example: end_user_id=your_end_user_id

end_user_id for statistics; either end_user_id or end_user_heron_id is required

from_date
string or null <date>
Default: null
Example: from_date=2022-01-01

The earliest transaction timestamp date to use in forecasting

category_label
string
Example: category_label=Revenue

Label of category to be forecasted; either category_heron_id or category_label must be present

end_user_heron_id
string or null
Default: null
Example: end_user_heron_id=eus_j9Hsdj3C8Mr6BYx34dM9QL

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get EndUser statistics

Get summarized statistics for a given EndUser

Authorizations:
BasicAuth
query Parameters
to_currency
string or null
Enum: "GBP" "USD" "EUR"
Example: to_currency=USD

ISO 4217 currency code to convert to

to_date
string or null <date>
Default: null
Example: to_date=2023-09-26

Filter for transactions with timestamp before the input value (as date)

date_granularity
string
Default: "month"
Enum: "day" "week" "month" "quarter" "year"
Example: date_granularity=month

Aggregate results over time, e.g., by week or by quarter

end_user_id
string or null
Default: null
Example: end_user_id=your_end_user_id

end_user_id for statistics; either end_user_id or end_user_heron_id is required

category_heron_ids
Array of strings
Default: []
Example: category_heron_ids=ctg_jDG5tB7fC8ZjBPUPyqSytJ&category_heron_ids=ctg_22zLn4JX5dfzd5Ti6HGWVH

Filter by specific categories

merchant_heron_ids
Array of strings
Default: []
Example: merchant_heron_ids=mrc_U3MGsKDoAYrLhT8oE76MZU&merchant_heron_ids=mrc_VgUBCMTYYQgczoh2SPra8u

Filter by specific merchants

from_date
string or null <date>
Default: null
Example: from_date=2023-09-27

Filter for transactions with timestamp after the input value (as date)

end_user_heron_id
string or null
Default: null
Example: end_user_heron_id=eus_j9Hsdj3C8Mr6BYx34dM9QL

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

group_by
string
Default: "category"
Enum: "category" "merchant"
Example: group_by=category

Pivot results by merchant or by category

Responses

Response samples

Content type
application/json
{
  • "statistics": [
    ]
}

Get EndUser anomalies

Get anomalies for given EndUser given a category label or heron id

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser to upload

query Parameters
category_label_or_heron_id
required
string
Example: category_label_or_heron_id=Revenue

Label or Heron ID of category to find anomalies for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get EndUser bank statement summary

Get the bank statement summary by month for an end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string
query Parameters
grouping
string
Default: "by_month"
Enum: "by_month" "rolling_30_days_from_last_txn" "rolling_30_days_from_today"

Determines how to group transactions. It supports calendar month (by_month) or rolling 30-day period (from last txns with rolling_30_days_from_last_txn or from today with rolling_30_days_from_today)

Responses

Response samples

Content type
application/json
{
  • "average": {
    },
  • "by_month": {
    },
  • "grouping": "string",
  • "rolling_30_days_from_last_txn": {
    },
  • "rolling_30_days_from_today": {
    },
  • "total": {
    }
}

Get EndUser metric benchmarks

Get the benchmarks for each metric for an end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

Responses

Response samples

Content type
application/json
{
  • "benchmarks": [
    ]
}

Get EndUser Heron Score (beta)

Get Heron Score for end user with a breakdown of the feature group contributions which resulted in the score. The score is calculated for the day of last transaction. This is a beta feature and is subject to change.

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string
query Parameters
date
string or null <date>
Default: null
Example: date=2023-01-19

Cut-off date to consider transactions to for calculating heron score (inclusive)

min_category_confidence
number or null
Default: null
Example: min_category_confidence=0.8

Minimum company categorisation confidence to calculate Heron Score

Responses

Response samples

Content type
application/json
{
  • "data_quality_issues": [
    ],
  • "feature_groups_contributions": {
    },
  • "predicted_at": "2019-08-24T14:15:22Z",
  • "reference_timestamp": "2019-08-24T14:15:22Z",
  • "status": "not_available",
  • "value": 0
}

Get EndUser industry

Predict the industry of the end user based on its name

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser

query Parameters
naics_code_max_digits
integer [ 2 .. 6 ]
Example: naics_code_max_digits=6

Maximum number of digits in NAICS code

naics_code_min_digits
integer [ 2 .. 6 ]
Example: naics_code_min_digits=2

Minimum number of digits in NAICS code

Responses

Response samples

Content type
application/json
{
  • "label": "Fruit and Vegetable Preserving and Specialty Food Manufacturing",
  • "probability": 0.42,
  • "taxonomy": "naics",
  • "taxonomy_value": "3114"
}

Get EndUser merchant summary

Get the summary of transactions by merchant for an end user for a given category

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string
query Parameters
category_label_or_heron_id
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{
  • "by_merchant_summary": [
    ]
}

Get EndUser P&L

Calculates the profit & loss table for an end user, based on the layout defined (if any)

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string
query Parameters
to_date
string or null <date>
Default: null
Example: to_date=2022-01-31

The latest transaction timestamp date to use

from_date
string or null <date>
Default: null
Example: from_date=2022-01-01

The earliest transaction timestamp date to use

dates_ascending
boolean
Default: false

If true, dates are sorted left to right by ascending order. False by default, i.e., by default sorted in descending date order so more recent dates are first

currency
string or null = 3 characters
Example: currency=USD

ISO 4217 currency code for balance

Responses

Response samples

Content type
application/json
{
  • "dates": [
    ],
  • "sections": [
    ]
}

Update EndUser P&L layout

Update the profit and loss layout for the end user, which determines how the profit and loss table is calculated

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string
Request Body schema: application/json
category_labels
required
Array of strings non-empty

List of category labels to assign to a different section

section_slug
required
string

Slug of section to assign labels to

Responses

Request samples

Content type
application/json
{
  • "category_labels": [
    ],
  • "section_slug": "operational_expenses"
}

Response samples

Content type
application/json
{
  • "sections": [
    ]
}

Get EndUser scorecard

Get scorecard metrics and rule violations for a user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string
query Parameters
date
string or null <date>
Default: null
Example: date=2023-01-19

Cut-off date to consider transactions to for calculating scorecard (inclusive)

named_date
string or null
Default: null
Enum: "end_user_created" "end_user_last_updated" "last_transaction"
Example: named_date=end_user_created

Qualitative description for date to calculate scorecard

Responses

Response samples

Content type
application/json
{
  • "metrics": [
    ],
  • "rule_violations": [
    ]
}

EndUserRules

Evaluate all rules for an end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

EndUserIntegrations

Upload Inscribe

Upload Inscribe JSON for a specified end user to translate into Heron Data format and add transactions for the end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser to upload

Request Body schema: application/json
customer_name
string or null
Default: null
object (InscribeParsedDetails)

Responses

Request samples

Content type
application/json
{
  • "customer_name": null,
  • "parsed_details": {
    }
}

Response samples

Content type
application/json
{
  • "_summary": {
    }
}

Get Integration Links

Get a list of integration links for a specified end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser

Responses

Response samples

Content type
application/json
{
  • "links": [
    ]
}

Upload Ocrolus

Upload Ocrolus JSON for a specified end user to translate into Heron Data format and add transactions for the end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser to upload

Request Body schema: application/json
required
object (OcrolusResponse)
required
Array of objects (OcrolusBankAccount)
name
required
string

Responses

Request samples

Content type
application/json
{
  • "response": {
    }
}

Response samples

Content type
application/json
{
  • "_summary": {
    }
}

Get PDFs

Get list of PDFs for a specified end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser to upload

query Parameters
with_processed_results
boolean

Include processed results where applicable per pdf

Responses

Response samples

Content type
application/json
{
  • "pdfs": [
    ]
}

Upload PDF

Upload encoded PDF of transactions for a specified end user to translate into Heron Data format

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser to upload

Request Body schema: application/json
account_id
string or null
Default: null

Unique ID for account associated with PDF

currency
string or null
Default: null
Enum: "USD" "GBP"

ISO 4217 currency code for transactions in account. We currently only support GBP and USD PDFs

filename
string or null
Default: null

The filename of the PDF

pdf_base64
required
string^data\:\w+\/\w+\;base64\,

The base64 encoded string of the PDF file. If using Javascript, this is directly the output of the FileReader.readAsDataURL() output. See https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsDataURL for more info

read_us_dates
boolean or null
Default: null

True if date formats in the statement are US: month/date/year

reference_id
string or null <= 140 characters
Default: null

An optional field for your unique identifier for the PDF

Responses

Request samples

Content type
application/json
{
  • "account_id": "checking_account_202348",
  • "currency": "USD",
  • "filename": "my-favourite.pdf",
  • "pdf_base64": "string",
  • "read_us_dates": null,
  • "reference_id": "my-favourite-pdf"
}

Response samples

Content type
application/json
{
  • "pdf_heron_id": "string",
  • "request_id": "string"
}

Upload Plaid assets

Upload Plaid asset JSON for a specified end user to translate into Heron Data format and add transactions for the end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser to upload

Request Body schema: application/json
required
object (PlaidAssetReport)
date_generated
required
string <date-time>
days_requested
required
integer
required
Array of objects (PlaidAssetReportItem)

Responses

Request samples

Content type
application/json
{
  • "report": {
    }
}

Response samples

Content type
application/json
{
  • "_summary": {
    }
}

Upload Plaid transactions

Upload Plaid transactions JSON for a specified end user to translate into Heron Data format and add transactions for the end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser to upload

Request Body schema: application/json
Array of objects (PlaidAccountSnapshot)
required
Array of objects (PlaidTransaction)

Responses

Request samples

Content type
application/json
{
  • "accounts": [
    ],
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "_summary": {
    }
}

Upload P&L in CSV format

Upload P&L for a specified end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser to upload

Request Body schema: application/json
csv
required
string

P&L of an end user in CSV format. String must be encoded.

currency
required
string
Enum: "USD" "GBP"

ISO 4217 currency code for transactions in account. We currently only support GBP and USD P&Ls

Responses

Request samples

Content type
application/json
{
  • "csv": "date%2Crevenue%0D%0AOct%202021%2C23580.87%0D%0ASept%202021%2C13464.07",
  • "currency": "USD"
}

Response samples

Content type
application/json
{
  • "_summary": {
    }
}

Upload Yodlee

Upload Yodlee JSON files for a specified end user to translate into Heron Data format and add transactions for the end user

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser to upload

Request Body schema: application/json
Array of objects (YodleeAccount)
Array of objects (YodleeTransaction)

Responses

Request samples

Content type
application/json
{
  • "accounts": [
    ],
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "_summary": {
    }
}

EndUserAccounts

Get Missing Accounts (beta)

Get a list of possible missing accounts for a given End User. This endpoint is in beta and likely to change.

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string

The end_user_id or heron_id of EndUser

Responses

Response samples

Content type
application/json
{
  • "missing_accounts": [
    ]
}

EnrichedTransactions

Get end user transactions

Get all unique transactions for a single end user. Set end user status to "ready" to initiate transaction enrichment, otherwise may contain both enriched and unenriched transactions

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string
query Parameters
page
integer >= 1
Default: 1

Results page

last_updated_min
string or null <date-time>
Default: null
Example: last_updated_min=2023-09-27T16:32:22.120290

Filter for transactions whose values were last updated in Heron systems after the specified input value, isoformat

per_page
integer [ 1 .. 50000 ]
Default: 100

Desired results per page

Responses

Response samples

Content type
application/json
{
  • "_meta": {
    },
  • "transactions_enriched": [
    ]
}

Get enriched transaction

Get enriched transaction

Authorizations:
BasicAuth
path Parameters
reference_id_or_heron_id
required
string

Responses

Response samples

Content type
application/json
{
  • "transaction_enriched": {
    }
}

Transactions

Create end user transactions (async)

Upload transactions for a specific end user. Does not include enriching transactions -- set end user status = 'ready' to initiate processing. For synchronous enrichment, please instead use "Enrich transactions (sync)"

Authorizations:
BasicAuth
path Parameters
end_user_id_or_heron_id
required
string
Request Body schema: application/json
Array of objects (AccountBalance)

Bank account balance information for a particular account_id. The balance here must be the latest balance after all the transactions in this batch have been applied.

required
Array of objects (EndUserTransactionPostAsync) non-empty

Responses

Request samples

Content type
application/json
{
  • "balances": [
    ],
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "request_id": "string",
  • "transactions_loaded": 0
}

Delete transactions

Delete transactions

Authorizations:
BasicAuth
query Parameters
account_id
string or null
Default: null

account_id of transactions to be deleted

only_duplicates
boolean or null
Default: null

if true, deletes only transactions that are marked as duplicates

request_id
string or null
Default: null

Request ID of transactions to be deleted

heron_ids
Array of strings
Default: []

Heron IDs of transactions to be deleted

end_user_id
string or null
Default: null

end_user_id of transactions to be deleted

heron_id
string or null
Default: null
Example: heron_id=txn_SG6t5hMsv6fwUwFzJreZYh

(legacy) Heron ID of transaction to be deleted

reference_ids
Array of strings
Default: []

Reference IDs of transactions to be deleted

Responses

Callbacks

Response samples

Content type
application/json
{
  • "message": "string"
}

Callback payload samples

Callback
POST: $yourWebhookUrl
Content type
application/json
{
  • "created": "2023-09-27T16:32:22.017476",
  • "data": {
    },
  • "meta": { },
  • "topic": "end_user.processed"
}

Get transactions

Get transactions

Authorizations:
BasicAuth
query Parameters
timestamp_date_max
string <date>
Example: timestamp_date_max=2020-04-27

Filter by latest transaction timestamp

merchant_group_id
string

Filter by merchant group id

order_by
string
Default: "id_asc"
Enum: "amount_asc" "amount_desc" "abs_amount_asc" "abs_amount_desc" "description_asc" "description_desc" "timestamp_asc" "timestamp_desc" "id_asc" "id_desc" "confidence_asc" "confidence_desc"

What to order transactions by

reference_id
string

Reference Id of transaction

min_amount
number

Filter by minimum amount of transaction

max_amount
number

Filter by maximum amount of transaction

is_recurring
boolean

Filter by whether the transaction is recurring

to_date
string <date>

Deprecated; see created_date_ or timestamp_date_

last_updated_max
string <date-time>
Example: last_updated_max=2023-09-27T16:32:22.012943

Filter for transactions whose values were last updated in Heron systems before the specified input value

end_user_id
string

End user id of transaction

description_regex
string

Filter by regex matching transaction description

timestamp_date_min
string <date>
Example: timestamp_date_min=2020-04-27

Filter by earliest transaction timestamp

created_date_min
string <date>
Example: created_date_min=2020-04-27

Filter by earliest transaction upload date - when Heron received the transaction

request_id
string

Request-Id header returned in the response of POST transactions. Sending this parameter will return all transactions sent in a particular POST request, including any duplicates.

confidence_max
number [ 0 .. 1 ]

Filter by maximum confidence of annotation associated with transaction

description_keyword
string

Filter by keyword match on transaction description; case insensitive

has_matching_transaction
boolean

Filter by whether the transaction has a matching transaction

page
integer >= 1
Default: 1

Page of transaction to return

last_updated_min
string <date-time>
Example: last_updated_min=2023-09-27T16:32:22.012925

Filter for transactions whose values were last updated in Heron systems after the specified input value

created_date_max
string <date>
Example: created_date_max=2020-04-27

Filter by latest transaction upload date - when Heron received the transaction

include_duplicates
boolean

Whether or not to include duplicate transactions in the response. Defaults to false unless request_id is provided, in which case it defaults to true.

category_heron_id
Array of strings or null
Default: []
Example: category_heron_id=ctg_aR5kSKkhCQUHvmLC5zsnNL

Filter by the heron_id of the category that the transaction is annotated with

limit
integer [ 1 .. 10000 ]
Default: 1000

Number of transactions to return per page

transaction_code
string

Filter by transaction code

heron_id
string
Example: heron_id=txn_9etzy2V3Nf8VrVopr5BNfC

Heron generated Id of transaction

confidence_min
number [ 0 .. 1 ]

Filter by minimum confidence of annotation associated with transaction

from_date
string <date>

Deprecated; see created_date_ or timestamp_date_

Responses

Response samples

Content type
application/json
{
  • "_meta": {
    },
  • "_summary": {
    },
  • "transactions": [
    ]
}

Enrich transactions (sync)

Enrich and categorize transactions and consume them in a sync response. For business lending and underwriting, please use "Create end user transactions" instead. Please send a maximum of 249 transactions per request.

Authorizations:
BasicAuth
Request Body schema: application/json
required
Array of objects (Transaction1) non-empty
Array (non-empty)
account_id
string or null

Your unique ID for account associated with transaction

amount
required
number

Amount. Inflows to an account should be positive, and outflows from an account should be negative. If using Plaid, please flip the amount sign for all transactions.

balance
number or null

The running balance of the account after transaction ocurred

categories_default
string or null

Category of transaction that you may have received from other sources

currency
string or null = 3 characters

ISO 4217 currency code

date
string or null <date>

The date of the transaction; 'timestamp' field takes priority over 'date'

description
required
string

The text description for the transaction

end_user_id
string or null <= 140 characters

Your unique ID for end user associated with transaction

mcc_code
string or null^\d{4}$

Merchant category code associated with transaction that you may have received from other sources

order
integer

If sending a batch of transactions, the order in which the transaction occurs, where a higher value is equivalent to a more recent transaction

reference_id
string or null <= 140 characters

Your unique ID for transaction

timestamp
string or null <date-time>

The ISO 8601 timezone aware timestamp of the transaction; takes precedence over 'date'

transaction_code
string or null <= 140 characters

Code associated with transaction to indicate the type of transaction

Responses

Request samples

Content type
application/json
{
  • "transactions": [
    ]
}

Response samples

Content type
application/json
{
  • "_summary": {
    },
  • "transactions": [
    ]
}

Testing

Test endpoint (no authentication)

Test endpoint (no authentication)

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "hello": "string"
}

Test authentication

Test authentication

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "hello": "string"
}

Integrations

List Integrations

Get a list of Integrations

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{}

Create an integration

Create an integration e.g. with Plaid

Authorizations:
BasicAuth
Request Body schema: application/json
object (IntegrationSchema)
base_url
required
string <url>

Base URL of the API integration

client_id
required
string

Client ID for API access (this is encrypted in transit and at-rest with a custom key)

client_secret
required
string

Client Secret for API access (this is encrypted in transit and at-rest with a custom key)

name
required
string

A name for your integration

resource
string
Default: "transaction"
Enum: "transaction" "assets_report"

For integrations with multiple available reousrces, the specific resource

type
required
string
Enum: "plaid" "ocrolus" "truelayer"

The integration type, a specific provider

webhook_url
string or null <url>

URL provided by you to which we'll forward all webhooks (optional)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Update Integration

Update an Integration

Authorizations:
BasicAuth
path Parameters
heron_id
required
string
Request Body schema: application/json

Integration

object (IntegrationSchema)
base_url
required
string <url>

Base URL of the API integration

client_id
required
string

Client ID for API access (this is encrypted in transit and at-rest with a custom key)

client_secret
required
string

Client Secret for API access (this is encrypted in transit and at-rest with a custom key)

name
required
string

A name for your integration

resource
string
Default: "transaction"
Enum: "transaction" "assets_report"

For integrations with multiple available reousrces, the specific resource

type
required
string
Enum: "plaid" "ocrolus" "truelayer"

The integration type, a specific provider

webhook_url
string or null <url>

URL provided by you to which we'll forward all webhooks (optional)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete IntegrationLinks by Integration

Delete all IntegrationLinks for an Integration filtered by end user

Authorizations:
BasicAuth
path Parameters
heron_id
required
string

The Integration's heron_id

query Parameters
end_user_id_or_heron_id
required
string

Delete that end user's IntegrationLinks

Responses

Get IntegrationLinks by Integration

Get a list of IntegrationLinks for an Integration filtered by end user

Authorizations:
BasicAuth
path Parameters
heron_id
required
string

The Integration's heron_id

query Parameters
end_user_id_or_heron_id
required
string

Return only IntegrationLinks for that end user

Responses

Response samples

Content type
application/json
{
  • "links": [
    ]
}

Create an integration Link

Create a Link for an active Integration every time a customer connects their bank. In Plaid, this is a Plaid Link every time a customer connects their bank. For Plaid, call this after exchanging a public token for an Item access_token.

Authorizations:
BasicAuth
path Parameters
heron_id
required
string
Request Body schema: application/json
access_token
required
string

The generated token that grants access to the bank (this is encrypted in transit and at-rest with a custom key)

end_user_id
required
string

A unique identifier for your end user (customer) generated by you

end_user_name
string

An human readable name for this end user, like the company legal name

item_id
required
string

Unique identifier for each bank connection made by your end users. In Plaid this is the 'item_id'.

Responses

Request samples

Content type
application/json
{
  • "access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
  • "end_user_id": "490d02bf-ea74-4197-87e1-ec02a8c20901",
  • "end_user_name": "Acme Corp",
  • "item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op"
}

Merchants

Extract Merchant from a transaction description

Extract Merchant from a transaction description

Authorizations:
BasicAuth
Request Body schema: application/json

The bank transaction description as a string

description
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "PAYPAL* AMZN Mktp 198748320"
}

Response samples

Content type
application/json
{}

Search Merchants by name

Search Merchants by name

Authorizations:
BasicAuth
query Parameters
name
required
string

Full or partial name, minimum 3 characters

only_priority
boolean

If true, only returns priority merchants

Responses

Response samples

Content type
application/json
{
  • "merchants": [
    ]
}

Get Merchant by heron_id

Get Merchant by heron_id

Authorizations:
BasicAuth
path Parameters
heron_id
required
string

The Merchant heron_id

Responses

Response samples

Content type
application/json
{
  • "merchant": {
    }
}

Rules

Get rules

Read all available rules

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Create a single rule

Create a new rule to send a 'end_user.review_required' webhook after processing if rule condition evaluates to true

Authorizations:
BasicAuth
Request Body schema: application/json
object (Rule)
condition
string
Enum: "equal" "not_equal" "greater_than" "greater_than_or_equal" "less_than" "less_than_or_equal" "contains"

Key for how to compare metric value to rule value

date_range
string
Enum: "latest" "last_30_days" "last_90_days" "last_120_days" "last_180_days" "last_365_days" "next_30_days" "next_60_days" "next_90_days" "next_180_days" "last_1_calendar_months" "last_3_calendar_months" "last_6_calendar_months" "last_12_calendar_months"

Date range corresponding to metric

group
string or null
Enum: "data_quality_datasource" "data_quality_account" "data_quality_transaction"

Used to display rules by the stage in the underwriting workflow to which they apply.

metric_label
string
Enum: "data_volume" "date_range" "data_freshness" "has_balance_ratio" "data_coverage" "accounts" "category_coverage" "inflows" "outflows" "deposit_days" "net_amount" "merchant_coverage" "confidence" "revenue_anomalies" "last_debt_investment" "last_debt_investment_days" "merchant_heron_ids" "revenue_daily_average" "cogs_daily_average" "opex_daily_average" "debt_repayment_daily_average" "debt_investment" "debt_investors" "nsf_fees" "nsf_days" "unconnected_account_ratio" "inflow_daily_average" "outflow_daily_average" "revenue_sources" "debt_investment_count" "debt_collection" "atm_withdrawals" "tax_payments" "tax_payment_amount" "revenue" "annualized_revenue" "cogs" "average_credit_card_spend" "opex" "revenue_profit_and_loss" "annualized_revenue_profit_and_loss" "cogs_profit_and_loss" "opex_profit_and_loss" "revenue_monthly_average" "debt_repayment" "category_debt_repayment_count" "category_other_expenses_count" "category_revenue_count" "category_postage_count" "category_debt_investment_count" "category_atm_cash_outflows_count" "category_rent_count" "insurance_in_out_ratio" "rent_in_out_ratio" "taxes_in_out_ratio" "travel_in_out_ratio" "company_investments_in_out_ratio" "atm_cash_outflows_in_out_ratio" "overdraft_nsf_fees_in_out_ratio" "reconciled_intra_company_transfers_to_insurance_ratio" "insurance_to_general_payment_ratio" "insurance_to_advertising_ratio" "insurance_to_credit_card_ratio" "insurance_to_check_deposits_ratio" "insurance_to_atm_cash_inflows_ratio" "insurance_to_debt_repayment_ratio" "insurance_to_charges_fees_ratio" "insurance_to_travel_ratio" "insurance_to_inventory_ratio" "insurance_to_none_ratio" "equity_investment_to_advertising_ratio" "equity_investment_to_debt_repayment_ratio" "equity_investment_to_charges_fees_ratio" "equity_investment_to_unreconciled_intra_company_transfers_ratio" "equity_investment_to_travel_ratio" "equity_investment_to_company_investments_ratio" "general_payment_to_credit_card_ratio" "general_payment_to_p2p_transfers_ratio" "general_payment_to_company_investments_ratio" "general_payment_to_none_ratio" "debt_investment_to_overdraft_nsf_fees_ratio" "debt_investment_to_other_expenses_ratio" "debt_investment_to_none_ratio" "advertising_to_p2p_transfers_ratio" "advertising_to_other_expenses_ratio" "credit_card_to_check_deposits_ratio" "credit_card_to_charges_fees_ratio" "credit_card_to_travel_ratio" "credit_card_to_inventory_ratio" "credit_card_to_revenue_ratio" "credit_card_to_payroll_and_consultants_ratio" "credit_card_to_none_ratio" "rent_to_check_deposits_ratio" "rent_to_postage_ratio" "rent_to_special_outflows_ratio" "rent_to_travel_ratio" "rent_to_p2p_transfers_ratio" "rent_to_payroll_and_consultants_ratio" "check_deposits_to_debt_repayment_ratio" "check_deposits_to_postage_ratio" "check_deposits_to_unreconciled_intra_company_transfers_ratio" "check_deposits_to_revenue_ratio" "special_inflows_to_charges_fees_ratio" "special_inflows_to_utilities_ratio" "special_inflows_to_unreconciled_intra_company_transfers_ratio" "special_inflows_to_travel_ratio" "special_inflows_to_revenue_ratio" "special_inflows_to_atm_cash_outflows_ratio" "special_inflows_to_payroll_and_consultants_ratio" "refunds_to_atm_cash_inflows_ratio" "refunds_to_charges_fees_ratio" "refunds_to_utilities_ratio" "refunds_to_unreconciled_intra_company_transfers_ratio" "refunds_to_travel_ratio" "refunds_to_overdraft_nsf_fees_ratio" "refunds_to_atm_cash_outflows_ratio" "atm_cash_inflows_to_charges_fees_ratio" "atm_cash_inflows_to_utilities_ratio" "atm_cash_inflows_to_unreconciled_intra_company_transfers_ratio" "atm_cash_inflows_to_atm_cash_outflows_ratio" "atm_cash_inflows_to_other_expenses_ratio" "debt_repayment_to_taxes_ratio" "debt_repayment_to_postage_ratio" "debt_repayment_to_special_outflows_ratio" "debt_repayment_to_atm_cash_outflows_ratio" "debt_repayment_to_payroll_and_consultants_ratio" "check_outflows_to_charges_fees_ratio" "check_outflows_to_utilities_ratio" "check_outflows_to_travel_ratio" "check_outflows_to_p2p_transfers_ratio" "check_outflows_to_revenue_ratio" "check_outflows_to_other_expenses_ratio" "check_outflows_to_payroll_and_consultants_ratio" "taxes_to_travel_ratio" "taxes_to_p2p_transfers_ratio" "taxes_to_revenue_ratio" "taxes_to_atm_cash_outflows_ratio" "taxes_to_other_expenses_ratio" "taxes_to_payroll_and_consultants_ratio" "charges_fees_to_postage_ratio" "charges_fees_to_overdraft_nsf_fees_ratio" "charges_fees_to_revenue_ratio" "charges_fees_to_company_investments_ratio" "charges_fees_to_other_expenses_ratio" "charges_fees_to_none_ratio" "utilities_to_postage_ratio" "utilities_to_special_outflows_ratio" "utilities_to_travel_ratio" "utilities_to_overdraft_nsf_fees_ratio" "utilities_to_other_expenses_ratio" "postage_to_unreconciled_intra_company_transfers_ratio" "postage_to_p2p_transfers_ratio" "postage_to_none_ratio" "unreconciled_intra_company_transfers_to_travel_ratio" "unreconciled_intra_company_transfers_to_p2p_transfers_ratio" "unreconciled_intra_company_transfers_to_atm_cash_outflows_ratio" "unreconciled_intra_company_transfers_to_other_expenses_ratio" "special_outflows_to_p2p_transfers_ratio" "special_outflows_to_atm_cash_outflows_ratio" "travel_to_p2p_transfers_ratio" "travel_to_inventory_ratio" "travel_to_other_expenses_ratio" "travel_to_payroll_and_consultants_ratio" "travel_to_none_ratio" "p2p_transfers_to_overdraft_nsf_fees_ratio" "p2p_transfers_to_atm_cash_outflows_ratio" "inventory_to_overdraft_nsf_fees_ratio" "inventory_to_company_investments_ratio" "inventory_to_atm_cash_outflows_ratio" "inventory_to_other_expenses_ratio" "overdraft_nsf_fees_to_other_expenses_ratio" "revenue_to_payroll_and_consultants_ratio" "latest_balance" "balance_minimum" "balance_average" "change_in_balance" "negative_balance_days" "mean_balance_velocity" "mean_abs_balance_velocity" "weekday_balance_average" "weekday_with_highest_avg" "weekday_with_lowest_avg" "gross_operating_cashflow_daily_average" "net_operating_cashflow_daily_average" "gross_operating_cashflow" "net_operating_cashflow" "gross_operating_cashflow_profit_and_loss" "net_operating_cashflow_profit_and_loss" "debt_service_coverage_ratio" "predicted_nsf_fees" "predicted_balance_daily_average" "heron_score"

Label corresponding to metric

name
string or null <= 140 characters

Description of rule. Sent with webhook response, so can be used as a reference to the rule

selector
object

key-value pairs of the desired selector that should select whichend users to apply this rule. They are evaluated as an AND condition(all must be true to run this rule for an end user). Leave empty toapply to all end users.

value
number or null

Numeric value to compare to a metric; use this when the threshold is numeric

value_str
string or null

String value to compare to a metric; use this when the threshold is a string

Responses

Request samples

Content type
application/json
{
  • "rule": {
    }
}

Response samples

Content type
application/json
{
  • "rule": {
    }
}

Delete rule by heron_id

Delete a rule

Authorizations:
BasicAuth
path Parameters
heron_id
required
string

Responses

Response samples

Content type
application/json
{
  • "heron_id": "string"
}

Update rule by heron_id

Update a rule

Authorizations:
BasicAuth
path Parameters
heron_id
required
string
Request Body schema: application/json

Rule

object (RuleUpdateSchema)
condition
string
Enum: "equal" "not_equal" "greater_than" "greater_than_or_equal" "less_than" "less_than_or_equal" "contains"

Key for how to compare metric value to rule value

date_range
string
Enum: "latest" "last_30_days" "last_90_days" "last_120_days" "last_180_days" "last_365_days" "next_30_days" "next_60_days" "next_90_days" "next_180_days" "last_1_calendar_months" "last_3_calendar_months" "last_6_calendar_months" "last_12_calendar_months"

Date range corresponding to metric

group
string or null
Enum: "data_quality_datasource" "data_quality_account" "data_quality_transaction"

Used to display rules by the stage in the underwriting workflow to which they apply.

metric_label
string
Enum: "data_volume" "date_range" "data_freshness" "has_balance_ratio" "data_coverage" "accounts" "category_coverage" "inflows" "outflows" "deposit_days" "net_amount" "merchant_coverage" "confidence" "revenue_anomalies" "last_debt_investment" "last_debt_investment_days" "merchant_heron_ids" "revenue_daily_average" "cogs_daily_average" "opex_daily_average" "debt_repayment_daily_average" "debt_investment" "debt_investors" "nsf_fees" "nsf_days" "unconnected_account_ratio" "inflow_daily_average" "outflow_daily_average" "revenue_sources" "debt_investment_count" "debt_collection" "atm_withdrawals" "tax_payments" "tax_payment_amount" "revenue" "annualized_revenue" "cogs" "average_credit_card_spend" "opex" "revenue_profit_and_loss" "annualized_revenue_profit_and_loss" "cogs_profit_and_loss" "opex_profit_and_loss" "revenue_monthly_average" "debt_repayment" "category_debt_repayment_count" "category_other_expenses_count" "category_revenue_count" "category_postage_count" "category_debt_investment_count" "category_atm_cash_outflows_count" "category_rent_count" "insurance_in_out_ratio" "rent_in_out_ratio" "taxes_in_out_ratio" "travel_in_out_ratio" "company_investments_in_out_ratio" "atm_cash_outflows_in_out_ratio" "overdraft_nsf_fees_in_out_ratio" "reconciled_intra_company_transfers_to_insurance_ratio" "insurance_to_general_payment_ratio" "insurance_to_advertising_ratio" "insurance_to_credit_card_ratio" "insurance_to_check_deposits_ratio" "insurance_to_atm_cash_inflows_ratio" "insurance_to_debt_repayment_ratio" "insurance_to_charges_fees_ratio" "insurance_to_travel_ratio" "insurance_to_inventory_ratio" "insurance_to_none_ratio" "equity_investment_to_advertising_ratio" "equity_investment_to_debt_repayment_ratio" "equity_investment_to_charges_fees_ratio" "equity_investment_to_unreconciled_intra_company_transfers_ratio" "equity_investment_to_travel_ratio" "equity_investment_to_company_investments_ratio" "general_payment_to_credit_card_ratio" "general_payment_to_p2p_transfers_ratio" "general_payment_to_company_investments_ratio" "general_payment_to_none_ratio" "debt_investment_to_overdraft_nsf_fees_ratio" "debt_investment_to_other_expenses_ratio" "debt_investment_to_none_ratio" "advertising_to_p2p_transfers_ratio" "advertising_to_other_expenses_ratio" "credit_card_to_check_deposits_ratio" "credit_card_to_charges_fees_ratio" "credit_card_to_travel_ratio" "credit_card_to_inventory_ratio" "credit_card_to_revenue_ratio" "credit_card_to_payroll_and_consultants_ratio" "credit_card_to_none_ratio" "rent_to_check_deposits_ratio" "rent_to_postage_ratio" "rent_to_special_outflows_ratio" "rent_to_travel_ratio" "rent_to_p2p_transfers_ratio" "rent_to_payroll_and_consultants_ratio" "check_deposits_to_debt_repayment_ratio" "check_deposits_to_postage_ratio" "check_deposits_to_unreconciled_intra_company_transfers_ratio" "check_deposits_to_revenue_ratio" "special_inflows_to_charges_fees_ratio" "special_inflows_to_utilities_ratio" "special_inflows_to_unreconciled_intra_company_transfers_ratio" "special_inflows_to_travel_ratio" "special_inflows_to_revenue_ratio" "special_inflows_to_atm_cash_outflows_ratio" "special_inflows_to_payroll_and_consultants_ratio" "refunds_to_atm_cash_inflows_ratio" "refunds_to_charges_fees_ratio" "refunds_to_utilities_ratio" "refunds_to_unreconciled_intra_company_transfers_ratio" "refunds_to_travel_ratio" "refunds_to_overdraft_nsf_fees_ratio" "refunds_to_atm_cash_outflows_ratio" "atm_cash_inflows_to_charges_fees_ratio" "atm_cash_inflows_to_utilities_ratio" "atm_cash_inflows_to_unreconciled_intra_company_transfers_ratio" "atm_cash_inflows_to_atm_cash_outflows_ratio" "atm_cash_inflows_to_other_expenses_ratio" "debt_repayment_to_taxes_ratio" "debt_repayment_to_postage_ratio" "debt_repayment_to_special_outflows_ratio" "debt_repayment_to_atm_cash_outflows_ratio" "debt_repayment_to_payroll_and_consultants_ratio" "check_outflows_to_charges_fees_ratio" "check_outflows_to_utilities_ratio" "check_outflows_to_travel_ratio" "check_outflows_to_p2p_transfers_ratio" "check_outflows_to_revenue_ratio" "check_outflows_to_other_expenses_ratio" "check_outflows_to_payroll_and_consultants_ratio" "taxes_to_travel_ratio" "taxes_to_p2p_transfers_ratio" "taxes_to_revenue_ratio" "taxes_to_atm_cash_outflows_ratio" "taxes_to_other_expenses_ratio" "taxes_to_payroll_and_consultants_ratio" "charges_fees_to_postage_ratio" "charges_fees_to_overdraft_nsf_fees_ratio" "charges_fees_to_revenue_ratio" "charges_fees_to_company_investments_ratio" "charges_fees_to_other_expenses_ratio" "charges_fees_to_none_ratio" "utilities_to_postage_ratio" "utilities_to_special_outflows_ratio" "utilities_to_travel_ratio" "utilities_to_overdraft_nsf_fees_ratio" "utilities_to_other_expenses_ratio" "postage_to_unreconciled_intra_company_transfers_ratio" "postage_to_p2p_transfers_ratio" "postage_to_none_ratio" "unreconciled_intra_company_transfers_to_travel_ratio" "unreconciled_intra_company_transfers_to_p2p_transfers_ratio" "unreconciled_intra_company_transfers_to_atm_cash_outflows_ratio" "unreconciled_intra_company_transfers_to_other_expenses_ratio" "special_outflows_to_p2p_transfers_ratio" "special_outflows_to_atm_cash_outflows_ratio" "travel_to_p2p_transfers_ratio" "travel_to_inventory_ratio" "travel_to_other_expenses_ratio" "travel_to_payroll_and_consultants_ratio" "travel_to_none_ratio" "p2p_transfers_to_overdraft_nsf_fees_ratio" "p2p_transfers_to_atm_cash_outflows_ratio" "inventory_to_overdraft_nsf_fees_ratio" "inventory_to_company_investments_ratio" "inventory_to_atm_cash_outflows_ratio" "inventory_to_other_expenses_ratio" "overdraft_nsf_fees_to_other_expenses_ratio" "revenue_to_payroll_and_consultants_ratio" "latest_balance" "balance_minimum" "balance_average" "change_in_balance" "negative_balance_days" "mean_balance_velocity" "mean_abs_balance_velocity" "weekday_balance_average" "weekday_with_highest_avg" "weekday_with_lowest_avg" "gross_operating_cashflow_daily_average" "net_operating_cashflow_daily_average" "gross_operating_cashflow" "net_operating_cashflow" "gross_operating_cashflow_profit_and_loss" "net_operating_cashflow_profit_and_loss" "debt_service_coverage_ratio" "predicted_nsf_fees" "predicted_balance_daily_average" "heron_score"

Label corresponding to metric

name
string or null <= 140 characters

Description of rule. Sent with webhook response, so can be used as a reference to the rule

selector
object

key-value pairs of the desired selector that should select whichend users to apply this rule. They are evaluated as an AND condition(all must be true to run this rule for an end user). Leave empty toapply to all end users.

value
number or null

Numeric value to compare to a metric; use this when the threshold is numeric

value_str
string or null

String value to compare to a metric; use this when the threshold is a string

Responses

Request samples

Content type
application/json
{
  • "rule": {
    }
}

Response samples

Content type
application/json
{
  • "rule": {
    }
}

Users

Get user's company overview layout

Authorizations:
BasicAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save user's company overview layout

Authorizations:
BasicAuth
Request Body schema: application/json

The new company overview layout

Array
group_name
required
string
id
required
string

A unique id used to reference the group

required
Array of objects (Widget)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Save user's settings

Authorizations:
BasicAuth
Request Body schema: application/json

The new settings

use_new_company_layout
boolean

Responses

Request samples

Content type
application/json
{
  • "use_new_company_layout": true
}