Income insights
Belvo's unique identifier for the current item.
The link.id
the data belongs to.
The ISO-8601 timestamp of when the data point was created in Belvo's database.
An array of enriched income stream objects.
Unique ID for the bank account to be verified for income streams.
The type of income used in the calculations.
We return one of the following enum values:
SALARY
GOVERNMENT
INTEREST
RENT
RETIREMENT
FREELANCE
ALTERNATIVE_INCOME
TRANSFER
DEPOSIT
UNKNOWN
How often the income is received.
We return one of the following enum values:
MONTHLY
- For transactions that occur once per month.FORTNIGHTLY
- For transactions that occur once every two weeks.WEEKLY
- For transactions that occur once per week.IRREGULAR
- For transactions that do not occur on a defined frequency pattern.SINGLE
- For transactions that occur only once and do not repeat.
The average amount of income received from the source over periods_with_income
.
The median amount of income received from the source over within a natural month.
The average income transaction amount from the source.
The amount of the most recent income received from the source.
The three-letter currency code of the income. For example:
• 🇧🇷 BRL (Brazilian Real) • 🇨🇴 COP (Colombian Peso) • 🇲🇽 MXN (Mexican Peso)
The description of the most recent income from the stream.
The date when the most recent income from the stream was received, in YYYY-MM-DD
format.
The stability of the income based on its amount, with a range from 0 to 1, where 1 represents perfect stability.
Note: For transactions with frequency
=SINGLE
, this value returns null
.
The regularity of the income based in its frequency, with a range from 0 to 1, where 1 represents perfect regularity.
Note: For transactions with frequency
=SINGLE
, this value returns null
.
The income trend during a period of time calculated between last income and first income received, where:
- a negative float means that the income trend is decreasing during the time period.
- a positive float means that the income trend is increasing during the time period.
Note: For transactions with frequency
=SINGLE
, this value returns null
.
Number of period units (based on rolling months) used to generate insights and calculations.
Note: A rolling month is a period of 30 days. For example, 2023-01-15 to 2023-02-15.
Number of period units (based on rolling months) with data to perform calculations.
Note: A rolling month is a period of 30 days. For example, 2023-01-15 to 2023-02-15.
Number of period units (based on rolling months) with at least one income available.
Note: A rolling month is a period of 30 days. For example, 2023-01-15 to 2023-02-15.
Number of income transactions over the lookback_periods
.
The type of source we generate income insights from. We return one of the following enum values:
BANK
The date when the first transaction occurred, in YYYY-MM-DD
format.
The date when when the last transaction occurred, in YYYY-MM-DD
format.
The best working day of the month to charge the user.
Additional working days that have been identified as good days to charge the user.
Average amount of income received per month across all the accounts for the specific user.
Average amount of regular income (with a frequency of MONTHLY
, FORTNIGHTLY
, or WEEKLY
) received per month for the specific user.
Average amount of irregular income (with a frequency of SINGLE
or IRREGULAR
) received per month for the specific user.
Average amount of income received per month for the specific user with LOW
confidence.
Average amount of income received per month for the specific user with MEDIUM
confidence.
Average amount of income received per month for the specific user with HIGH
confidence.
Total amount of all income received for the specific user.
Total amount of regular income (with a frequency of MONTHLY
, FORTNIGHTLY
, WEEKLY
) for the specific user.
Total amount of irregular income (with a frequency of SINGLE
or IRREGULAR
) for the specific user.
Total amount of income for the specific user with LOW
confidence.
Total amount of income for the specific user with MEDIUM
confidence.
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "created_at": "2022-02-09T08:45:50.406032Z", "income_streams": [ { … } ], "income_source_type": "BANK", "first_transaction_date": "2022-06-09", "last_transaction_date": "2023-02-09", "best_working_day_to_charge": 22, "good_working_days_to_charge": [ 17, 7, 2 ], "number_of_income_streams": 1, "monthly_average": 2500, "monthly_average_regular": 2500, "monthly_average_irregular": 0, "monthly_average_low_confidence": 0, "monthly_average_medium_confidence": 0, "monthly_average_high_confidence": 2500, "total_income_amount": 22500, "total_regular_income_amount": 22500, "total_irregular_income_amount": 0, "total_low_confidence": 0, "total_medium_confidence": 0, "total_high_confidence": 22500 }