GET
/
api
/
end_users
/
{end_user_id_or_heron_id}
/
profit_and_loss
Get EndUser cashflow P&L
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>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_id_or_heron_id
string
required

Query Parameters

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
enum<string> | null

ISO 4217 currency code for balance

Available options:
GBP,
USD,
EUR
Example:

"USD"

to_date
string<date> | null

The latest transaction timestamp date to use

Example:

"2022-01-31"

from_date
string<date> | null

The earliest transaction timestamp date to use

Example:

"2022-01-01"

Response

200 - application/json

OK

The response is of type object.