v1

latestOpenAPI 3.0.02026-07-26224386470.0 KB
EndUserCalculations

Get EndUser cashflow P&L

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

get/api/end_users/{end_user_id_or_heron_id}/profit_and_loss

Path parameters

end_user_id_or_heron_idstring required

Query parameters

from_datestring date nullable
Example:2022-01-01

The earliest transaction timestamp date to use

to_datestring date nullable
Example:2022-01-31

The latest transaction timestamp date to use

dates_ascendingboolean

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'GBP' | 'USD' | 'EUR' | 'CAD' | 'AUD' | 'null' nullable
Example:USD

ISO 4217 currency code for balance

Response

OK

datesstring[]

Ordered list of dates representing the columns of the P&L table