Cash flows

A cash flow groups together transactions that share similarities. They can be identified as a single budget line. For example, a user who has several ongoing loan repayments will have an associated cash flow for each one.

A cash flow summarizes the group of transactions by computing a labelRoot that normalizes the description fields present in each grouped transaction. The totalAmount and calendar sums listed transaction amounts and divides it into the analyzed months.

The regularity properties gives insights about the periodic regularity of a cash flow.

• dueDays gives the number of days in a month when the transaction is either debited or credited.
• periodicity field reflects the frequency of which the transaction will occur.
• repartition field informs if the cashflow has started, ended or is stable during the analysis period. For example, this field can be used to detect if a loan repayment has started in the last 3 months.

Data sample

Cash flows can be retrieved using the GET /credit-insights/cash-flows endpoint:

{

  "type": "DIRECT_DEBIT",

  "category": "LOAN_REPAYMENT",

  "labelRoot": "LOAN REPAYMENTS FROM BANK X",

  "label": "LOAN REPAYMENTS FROM BANK X - 2",

  "totalAmount": 350.31,

  "totalRejectedAmount": 0,

  "calendar": [

    {

      "month": "2022-01",

      "amount": 116.77

    },

    {

      "month": "2022-02",

      "amount": 116.77

    },

    {

      "month": "2022-03",

      "amount": 116.77

    }

  ],

  "transactions": [],

  "regularity": {

    "dueDays": [

      28

    ],

    "interval": {

      "min": 29,

      "max": 30

    },

    "meanNumberOfDaysInInterval": 31,

    "accuracy": 93,

    "periodicity": "MONTHLY",

    "repartition": "IS_STABLE"

  }

}