Skip to main content
GET
Get EndUser merchant summary

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_id_or_heron_id
string
required

Query Parameters

category_label_or_heron_id
string[] | null
Minimum array length: 1
analytics_group
(enum<string> | null)[] | null
Minimum array length: 1

The category analytics group

Available options:
revenue,
cost_of_goods_sold,
operational_expenses,
tax_expenses,
intra_company,
debt,
equity,
other_income,
special_items,
other,
null
Example:

"debt"

group_by_counterparty_txn_clusters
boolean
default:false

Whether to group by counterparty transaction clusters

account_ids
string[] | null

Account ids to include in the summary, if not provided, all accounts are included

Response

200 - application/json

OK

by_merchant_summary
object[]