GET
/
api
/
transactions

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

to_date
string

Deprecated; see created_date_ or timestamp_date_

confidence_min
number

Filter by minimum confidence of annotation associated with transaction

Required range: 0 < x < 1
limit
integer
default:
1000

Number of transactions to return per page

Required range: 1 < x < 10000
transaction_code
string

Filter by transaction code

timestamp_date_min
string

Filter by earliest transaction timestamp

has_matching_transaction
boolean

Filter by whether the transaction has a matching 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.

has_merchant
boolean | null

Filter by whether the transaction has a merchant entity associated with it

from_date
string

Deprecated; see created_date_ or timestamp_date_

reference_id
string

Reference Id of transaction

end_user_id
string

End user id of transaction

description_keyword
string

Filter by keyword match on transaction description; case insensitive

min_amount
number

Filter by minimum amount of transaction

confidence_max
number

Filter by maximum confidence of annotation associated with transaction

Required range: 0 < x < 1
category_heron_id
string[] | null

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

order_by
enum<string>
default:
id_asc

What to order transactions by

Available options:
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
description_regex
string

Filter by regex matching transaction description

page
integer
default:
1

Page of transaction to return

Required range: x > 1
created_date_min
string

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

merchant_group_id
string

Filter by merchant group id

merchant_heron_id
string

Filter by merchant heron id

last_updated_min
string

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

is_recurring
boolean

Filter by whether the transaction is recurring

created_date_max
string

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

timestamp_date_max
string

Filter by latest transaction timestamp

max_amount
number

Filter by maximum amount of transaction

account_ids
string[] | null

Account ids to include. If not provided, all accounts are included

last_updated_max
string

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

heron_id
string

Heron generated Id of 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.

Response

200 - application/json
_meta
object
_summary
object
transactions
object[]