1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
use serde::{Serialize, Deserialize};
use super::{
CraBankIncomeEmployer, CraBankIncomeHistoricalSummary, CraPredictionInterval,
CreditBankIncomeCategory, CreditBankIncomePayFrequency,
};
///Detailed information for the income source.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CraBankIncomeSource {
///The account ID with which this income source is associated.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub account_id: Option<String>,
///The object containing employer data.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub employer: Option<CraBankIncomeEmployer>,
/**Maximum of all dates within the specific income sources in the user’s bank account for days requested by the client.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).*/
#[serde(default, skip_serializing_if = "Option::is_none")]
pub end_date: Option<chrono::NaiveDate>,
///The predicted average monthly net income amount for the income source(s).
#[serde(default, skip_serializing_if = "Option::is_none")]
pub forecasted_average_monthly_income: Option<f64>,
///The prediction interval(s) for the forecasted average monthly income.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub forecasted_average_monthly_income_prediction_intervals: Vec<
CraPredictionInterval,
>,
///An estimate of the average gross monthly income based on the historical net amount and income category for the income source(s).
#[serde(default, skip_serializing_if = "Option::is_none")]
pub historical_average_monthly_gross_income: Option<f64>,
///The average monthly net income amount estimated based on the historical data for the income source(s).
#[serde(default, skip_serializing_if = "Option::is_none")]
pub historical_average_monthly_income: Option<f64>,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub historical_summary: Option<Vec<CraBankIncomeHistoricalSummary>>,
/**The income category.
`BANK_INTEREST`: Interest earned from a bank account.
`BENEFIT_OTHER`: Government benefits other than retirement, unemployment, child support, or disability. Currently used only in the UK, to represent benefits such as Cost of Living Payments.
`CASH`: Deprecated and used only for existing legacy implementations. Has been replaced by `CASH_DEPOSIT` and `TRANSFER_FROM_APPLICATION`.
`CASH_DEPOSIT`: A cash or check deposit.
`CHILD_SUPPORT`: Child support payments received.
`GIG_ECONOMY`: Income earned as a gig economy worker, e.g. driving for Uber, Lyft, Postmates, DoorDash, etc.
`LONG_TERM_DISABILITY`: Disability payments, including Social Security disability benefits.
`OTHER`: Income that could not be categorized as any other income category.
`MILITARY`: Veterans benefits. Income earned as salary for serving in the military (e.g. through DFAS) will be classified as `SALARY` rather than `MILITARY`.
`RENTAL`: Income earned from a rental property. Income may be identified as rental when the payment is received through a rental platform, e.g. Airbnb; rent paid directly by the tenant to the property owner (e.g. via cash, check, or ACH) will typically not be classified as rental income.
`RETIREMENT`: Payments from private retirement systems, pensions, and government retirement programs, including Social Security retirement benefits.
`SALARY`: Payment from an employer to an earner or other form of permanent employment.
`TAX_REFUND`: A tax refund.
`TRANSFER_FROM_APPLICATION`: Deposits from a money transfer app, such as Venmo, Cash App, or Zelle.
`UNEMPLOYMENT`: Unemployment benefits. In the UK, includes certain low-income benefits such as the Universal Credit.*/
#[serde(default, skip_serializing_if = "Option::is_none")]
pub income_category: Option<CreditBankIncomeCategory>,
///The most common name or original description for the underlying income transactions.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub income_description: Option<String>,
///A unique identifier for an income source.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub income_source_id: Option<String>,
///The ISO 4217 currency code of the amount or balance.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub iso_currency_code: Option<String>,
/**The expected date of the end user’s next paycheck for the income source.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).*/
#[serde(default, skip_serializing_if = "Option::is_none")]
pub next_payment_date: Option<chrono::NaiveDate>,
///The income pay frequency.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub pay_frequency: Option<CreditBankIncomePayFrequency>,
/**Minimum of all dates within the specific income sources in the user's bank account for days requested by the client.
The date will be returned in an ISO 8601 format (YYYY-MM-DD).*/
#[serde(default, skip_serializing_if = "Option::is_none")]
pub start_date: Option<chrono::NaiveDate>,
///Total amount of earnings in the user’s bank account for the specific income source for days requested by the client.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub total_amount: Option<f64>,
///Number of transactions for the income source within the start and end date.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub transaction_count: Option<i64>,
/**The unofficial currency code associated with the amount or balance. Always `null` if `iso_currency_code` is non-null.
Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.*/
#[serde(default, skip_serializing_if = "Option::is_none")]
pub unofficial_currency_code: Option<String>,
}
impl std::fmt::Display for CraBankIncomeSource {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
write!(f, "{}", serde_json::to_string(self).unwrap())
}
}