ibflex 1.5.0

A library and a CLI for reading Interactive Brokers Flex reports and comparing to Ledger-cli transactions
Documentation 
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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266

/*!
 * Definitions for Flex Query report
 */

use std::fmt::Display;

use serde::Deserialize;

/**
 * The structure of the IB Flex report.
 */
#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct FlexQueryResponse {
    #[serde(rename = "FlexStatements", default)]
    pub flex_statements: FlexStatements,
}

impl FlexQueryResponse {
    /// Parses the file contents (xml) into the [`FlexQueryResponse`] object.
    pub fn from_xml(xml: &str) -> anyhow::Result<Self> {
        Ok(quick_xml::de::from_str(xml)?)
    }
}

impl From<String> for FlexQueryResponse {
    /**
     * Parses the file contents (xml) into the FlexQueryResponse object.
     */
    fn from(value: String) -> Self {
        quick_xml::de::from_str(&value).expect("parsed XML")
    }
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct FlexStatements {
    #[serde(rename = "@count", default)]
    pub count: i32,

    #[serde(rename = "FlexStatement", default)]
    pub flex_statement: Vec<FlexStatement>,
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct FlexStatement {
    #[serde(rename = "@accountId", default)]
    pub account_id: String,
    #[serde(rename = "@fromDate", default)]
    pub from_date: String,
    #[serde(rename = "@toDate", default)]
    pub to_date: String,
    #[serde(rename = "@period", default)]
    pub period: String,
    #[serde(rename = "@whenGenerated", default)]
    pub when_generated: String,

    #[serde(rename = "Trades", default)]
    pub trades: Trades,
    #[serde(rename = "CashTransactions", default)]
    pub cash_transactions: CashTransactions,
    #[serde(rename = "CashReport", default)]
    pub cash_report: CashReport,
    #[serde(rename = "OpenPositions", default)]
    pub open_positions: OpenPositions,
    #[serde(rename = "CorporateActions", default)]
    pub corporate_actions: CorporateActions,
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct CashTransactions {
    #[serde(rename = "CashTransaction", default)]
    pub cash_transaction: Vec<CashTransaction>,
}

/**
 * .report_date is the real date, when the transaction appears in the IB report.
 * .date is the transaction effective date.
 */
#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct CashTransaction {
    /// .report_date is the real date, when the transaction appears in the IB report.
    #[serde(rename = "@reportDate", default)]
    pub report_date: String,
    /// .dateTime is the transaction effective date.
    #[serde(rename = "@dateTime", default)]
    pub date_time: String,
    #[serde(rename = "@symbol", default)]
    pub symbol: String,
    #[serde(rename = "@isin", default)]
    pub isin: String,
    #[serde(rename = "@listingExchange", default)]
    pub listing_exchange: Option<String>,
    #[serde(rename = "@type", default)]
    pub r#type: String,
    #[serde(rename = "@amount", default)]
    pub amount: String,
    #[serde(rename = "@currency", default)]
    pub currency: String,
    #[serde(rename = "@description", default)]
    pub description: String,
}

impl Display for CashTransaction {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}/{} {:7} {} {} {:>7} {}, {}",
            self.report_date,
            &self.date_time[..10],
            self.symbol,
            self.listing_exchange.as_deref().unwrap_or(""),
            self.r#type,
            self.amount,
            self.currency,
            self.description
        )

    }
}

/// Trades section. The XML preserves the interleaved order of `<Trade>` and
/// `<Lot>` elements; consumers that need lot-matching should iterate `items`.
#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct Trades {
    #[serde(rename = "$value", default)]
    pub items: Vec<TradeItem>,
}

#[derive(Debug, Deserialize, Clone, PartialEq, Eq)]
pub enum TradeItem {
    Trade(Trade),
    Lot(Lot),
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct Trade {
    #[serde(rename = "@reportDate", default)]
    pub report_date: String,
    #[serde(rename = "@currency", default)]
    pub currency: String,
    #[serde(rename = "@symbol", default)]
    pub symbol: String,
    #[serde(rename = "@isin", default)]
    pub isin: String,
    #[serde(rename = "@dateTime", default)]
    pub date_time: String,
    #[serde(rename = "@transactionType", default)]
    pub transaction_type: String,
    #[serde(rename = "@quantity", default)]
    pub quantity: String,
    #[serde(rename = "@tradePrice", default)]
    pub trade_price: String,
    #[serde(rename = "@tradeMoney", default)]
    pub trade_money: String,
    #[serde(rename = "@proceeds", default)]
    pub proceeds: String,
    #[serde(rename = "@ibCommission", default)]
    pub ib_commission: String,
    #[serde(rename = "@ibCommissionCurrency", default)]
    pub ib_commission_currency: String,
    #[serde(rename = "@netCash", default)]
    pub net_cash: String,
    #[serde(rename = "@cost", default)]
    pub cost: String,
    #[serde(rename = "@taxes", default)]
    pub taxes: String,
    #[serde(rename = "@buySell", default)]
    pub buy_sell: String,
    #[serde(rename = "@openCloseIndicator", default)]
    pub open_close_indicator: String,
    #[serde(rename = "@tradeDate", default)]
    pub trade_date: String,
    #[serde(rename = "@openDateTime", default)]
    pub open_date_time: String,
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct Lot {
    #[serde(rename = "@currency", default)]
    pub currency: String,
    #[serde(rename = "@symbol", default)]
    pub symbol: String,
    #[serde(rename = "@isin", default)]
    pub isin: String,
    #[serde(rename = "@dateTime", default)]
    pub date_time: String,
    #[serde(rename = "@quantity", default)]
    pub quantity: String,
    #[serde(rename = "@cost", default)]
    pub cost: String,
    #[serde(rename = "@openDateTime", default)]
    pub open_date_time: String,
    #[serde(rename = "@reportDate", default)]
    pub report_date: String,
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct CashReport {
    #[serde(rename = "CashReportCurrency", default)]
    pub cash_report_currency: Vec<CashReportCurrency>,
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct CashReportCurrency {
    #[serde(rename = "@currency", default)]
    pub currency: String,
    #[serde(rename = "@toDate", default)]
    pub to_date: String,
    #[serde(rename = "@endingCash", default)]
    pub ending_cash: String,
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct OpenPositions {
    #[serde(rename = "OpenPosition", default)]
    pub open_position: Vec<OpenPosition>,
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct OpenPosition {
    #[serde(rename = "@symbol", default)]
    pub symbol: String,
    #[serde(rename = "@isin", default)]
    pub isin: String,
    #[serde(rename = "@position", default)]
    pub position: String,
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct CorporateActions {
    #[serde(rename = "CorporateAction", default)]
    pub corporate_action: Vec<CorporateAction>,
}

#[derive(Debug, Default, Deserialize, Clone, PartialEq, Eq)]
pub struct CorporateAction {
    #[serde(rename = "@actionID", default)]
    pub action_id: String,
    #[serde(rename = "@reportDate", default)]
    pub report_date: String,
    #[serde(rename = "@dateTime", default)]
    pub date_time: String,
    #[serde(rename = "@currency", default)]
    pub currency: String,
    #[serde(rename = "@symbol", default)]
    pub symbol: String,
    #[serde(rename = "@isin", default)]
    pub isin: String,
    #[serde(rename = "@type", default)]
    pub r#type: String,
    #[serde(rename = "@description", default)]
    pub description: String,
    #[serde(rename = "@amount", default)]
    pub amount: String,
    #[serde(rename = "@proceeds", default)]
    pub proceeds: String,
    #[serde(rename = "@value", default)]
    pub value: String,
    #[serde(rename = "@quantity", default)]
    pub quantity: String,
}

// pub enum TxType {
//     "Deposits/Withdrawals",
//     Dividends,
//     WithholdingTax
// }