curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/profit_and_loss \
--header 'x-api-key: <api-key>'{
"dates": [
"2023-12-25"
],
"sections": [
{
"metrics": [
{
"confidence": 123,
"indent": 123,
"is_ratio": true,
"name": "<string>",
"values": [
123
]
}
],
"name": "<string>",
"slug": "<string>"
}
]
}Calculates the cashflow profit & loss table for an end user, based on the layout defined (if any)
curl --request GET \
--url https://app.herondata.io/api/end_users/{end_user_id_or_heron_id}/profit_and_loss \
--header 'x-api-key: <api-key>'{
"dates": [
"2023-12-25"
],
"sections": [
{
"metrics": [
{
"confidence": 123,
"indent": 123,
"is_ratio": true,
"name": "<string>",
"values": [
123
]
}
],
"name": "<string>",
"slug": "<string>"
}
]
}ISO 4217 currency code for balance
GBP, USD, EUR, "USD"
The earliest transaction timestamp date to use
"2022-01-01"
The latest transaction timestamp date to use
"2022-01-31"
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
OK
Ordered list of dates representing the columns of the P&L table
Ordered list of P&L sections
Show child attributes
Ordered list of P&L metrics
Show child attributes
Amount weighted confidence for the metric, based on the confidene associated with category labels of related transactions
Indentation level for formatting purposes
Whether the metric is a ratio or not
Name of metric
The list of values ordered according to date
Name of P&L section, e.g,. Operating Expenses
Slugified version of the name
Was this page helpful?