Get Personal Cashflow

GET

/public/v3/customers/{customer_id}/cashflow/personal

Returns monthly cashflow amounts for personal bank accounts.

Parameters

ParameterData typeRequired?Description
customer_idstringyesCustomer ID

Query parameters

none

Request Body Parameters

none

Response Body Parameters

ParameterData typeRequired?Description
typestringyesCashflow type, possible values: INCOME, FIXED_COSTS, FLEXIBLE_COSTS
predictedfloatyesPredicted monthly value
averagefloatyesAverage monthly value
dataCashflow DatayesArray of data

Cashflow data

ParameterData typeRequired?Description
amountfloatyesAmount
yearintyesYear
monthstringyesMonth
currencystringyesCurrency

Request example

Response example

Was this article helpful?

Friendly Score UK Ltd.

41 Luke Street

London EC2A 4DP

Call us on +44 20 3996 3540

Company registered in England

Company number 09168668, ICO ZA111687

VAT registration number 206 9758 80

Authorised and Regulated by the Financial Conduct Authority. (FRN: 821100, 781963)