Operation keyword: `income`

Income product verifies income source, amount, regularity, and stability. Additionally, it can project future income and income trend, based on the historic performance.

The income product is built on categorised data; therefore, some fields may have null values. Namely, if the income definition contains a category called "Salary" but there are no salary transactions in the statement, then all respective fields will have a **null** value (see the example below):

Key | Description | Description | Optional |
---|---|---|---|

all_months | Integer | The count of all months in the processed statement(s) | |

average_days_between_payments | Float | The average amount of days between income payments | |

average_monthly_income | Float | Average monthly income for the period | |

days_since_last_income_payment | Float | The count of days since the last income payment | |

debt_to_income_ratio | Float | The fraction of an account's monthly gross income that goes toward paying debt | |

income_by_category | Array of income by category objects | A list of descriptive statistics for each income category. If there are no transactions with the specific income category, then the respective fields are optional | Yes |

average_income_payment | Float | Average transaction amount of the respective income category | |

category_id | Integer | ID of the respective income category | |

days_since_last_payment | Integer | The count of days since the last payment of the respective income category | |

income_by_source | Array of income by source objects | A list of descriptive statistics for each source under respective category. If category does not contain sources, this array will not be displayed (including all fields within this array) | Yes |

average_monthly_income | Float | Average monthly income for the period | |

source | String | Name of the income source (e.g., company name) | |

median_income_payment | Float | Median transaction amount of the respective income category | |

number_of_income_payments | Integer | The count of transactions under respective income category | |

regularity | Float | Represents income regularity that is defined by patterns of received income payments. For example, salary is received every month is regular income. Float is in interval [0,1], where 1 represents perfect regularity | |

stability | Float | Represents income stability that is defined by fluctuations of received income payments. Float is in interval [0,1], where 1 represents perfect stability | |

trend | Float | Represents income trend. Output is positive float if income is increasing during given time period or with negative number if income is decreasing during time period | |

monthly_discretionary_income | Float | Monthly amount of an account's income that is left for spending, investing, or saving, etc | |

months_with_income | Integer | The count of months with income | |

projected_average_monhtly_income_next_3_months | Float | Projected average monthly income for the next 3 months based on historic income trends. Forecast will be provided if statement has enough historical data | Yes |

whole_months | Integer | The count of whole months in the account. Whole month count correlates to all_months as number is in interval [all_months -2, all_months] | |

status | String | Processing record state | |

type | String | Response type |