ib-flex 0.2.3

Type-safe parser for Interactive Brokers (IBKR) FLEX XML statements: trades, positions, cash flows, corporate actions, and P&L.
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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289

use ib_flex::parse_activity_flex;
use rust_decimal::Decimal;
use std::str::FromStr;

#[test]
fn test_parse_extended_activity_statement() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse extended activity XML");

    // Verify basic fields
    assert_eq!(statement.account_id.as_deref(), Some("U1234567"));
    assert_eq!(statement.from_date.unwrap().to_string(), "2025-01-01");
    assert_eq!(statement.to_date.unwrap().to_string(), "2025-01-31");

    // Verify core trade is parsed
    assert_eq!(statement.trades.items.len(), 1);
    let trade = &statement.trades.items[0];
    // Trade symbol is a required String field
    assert_eq!(trade.symbol.as_deref(), Some("AAPL"));
}

#[test]
fn test_account_information() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert!(statement.account_information.is_some());
    let acct_info = statement.account_information.as_ref().unwrap();

    assert_eq!(acct_info.account_id.as_deref(), Some("U1234567"));
    assert_eq!(acct_info.account_type.as_deref(), Some("INDIVIDUAL"));
    assert_eq!(acct_info.acct_alias.as_deref(), Some("Main"));
    assert_eq!(acct_info.currency.as_deref(), Some("USD"));
    assert_eq!(acct_info.name.as_deref(), Some("John Doe"));
    assert_eq!(acct_info.master_name.as_deref(), Some("MASTER"));
}

#[test]
fn test_change_in_nav() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    // ChangeInNAV is now a single element, not a wrapper
    let nav = statement
        .change_in_nav
        .as_ref()
        .expect("Expected ChangeInNAV");

    assert_eq!(nav.account_id.as_deref(), Some("U1234567"));
    assert_eq!(nav.from_date.unwrap().to_string(), "2025-01-01");
    assert_eq!(nav.to_date.unwrap().to_string(), "2025-01-31");
    assert_eq!(
        nav.starting_value,
        Some(Decimal::from_str("100000.00").unwrap())
    );
    assert_eq!(
        nav.ending_value,
        Some(Decimal::from_str("107500.00").unwrap())
    );
    // New field names matching production schema
    assert_eq!(nav.mtm, Some(Decimal::from_str("2500.00").unwrap()));
    assert_eq!(nav.realized, Some(Decimal::from_str("1500.00").unwrap()));
    assert_eq!(
        nav.change_in_unrealized,
        Some(Decimal::from_str("1000.00").unwrap())
    );
    assert_eq!(
        nav.deposits_withdrawals,
        Some(Decimal::from_str("5000.00").unwrap())
    );
    assert_eq!(nav.commissions, Some(Decimal::from_str("-50.00").unwrap()));
}

#[test]
fn test_equity_summary() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert_eq!(statement.equity_summary.items.len(), 1);
    let summary = &statement.equity_summary.items[0];

    assert_eq!(summary.account_id.as_deref(), Some("U1234567"));
    assert_eq!(summary.report_date.unwrap().to_string(), "2025-01-31");
    assert_eq!(summary.cash, Some(Decimal::from_str("50000.00").unwrap()));
    assert_eq!(summary.stock, Some(Decimal::from_str("40000.00").unwrap()));
    assert_eq!(
        summary.options,
        Some(Decimal::from_str("15000.00").unwrap())
    );
    assert_eq!(summary.bonds, Some(Decimal::from_str("2500.00").unwrap()));
    assert_eq!(summary.total, Some(Decimal::from_str("107500.00").unwrap()));
}

#[test]
fn test_cash_report() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert_eq!(statement.cash_report.items.len(), 1);
    let report = &statement.cash_report.items[0];

    assert_eq!(report.account_id.as_deref(), Some("U1234567"));
    assert_eq!(report.currency.as_deref(), Some("USD"));
    assert_eq!(report.from_date.unwrap().to_string(), "2025-01-01");
    assert_eq!(report.to_date.unwrap().to_string(), "2025-01-31");
    assert_eq!(
        report.starting_cash,
        Some(Decimal::from_str("45000.00").unwrap())
    );
    assert_eq!(
        report.commissions,
        Some(Decimal::from_str("-50.00").unwrap())
    );
    assert_eq!(report.deposits, Some(Decimal::from_str("5000.00").unwrap()));
    assert_eq!(report.withdrawals, Some(Decimal::from_str("0.00").unwrap()));
    assert_eq!(report.dividends, Some(Decimal::from_str("100.00").unwrap()));
    assert_eq!(
        report.ending_cash,
        Some(Decimal::from_str("50050.00").unwrap())
    );
}

#[test]
fn test_trade_confirms() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert_eq!(statement.trade_confirms.items.len(), 1);
    let confirm = &statement.trade_confirms.items[0];

    assert_eq!(confirm.account_id.as_deref(), Some("U1234567"));
    assert_eq!(confirm.exec_id.as_deref(), Some("00012345.001"));
    assert_eq!(confirm.order_id.as_deref(), Some("12345"));
    assert_eq!(confirm.trade_date.unwrap().to_string(), "2025-01-15");
    assert_eq!(confirm.trade_time.as_deref(), Some("09:30:00"));
    assert_eq!(confirm.symbol.as_deref(), Some("AAPL"));
    assert_eq!(confirm.quantity, Some(Decimal::from_str("100").unwrap()));
    assert_eq!(confirm.price, Some(Decimal::from_str("150.00").unwrap()));
}

#[test]
fn test_option_eae() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert_eq!(statement.option_eae.items.len(), 1);
    let eae = &statement.option_eae.items[0];

    assert_eq!(eae.account_id.as_deref(), Some("U1234567"));
    assert_eq!(eae.transaction_id.as_deref(), Some("1001"));
    assert_eq!(eae.date.unwrap().to_string(), "2025-01-20");
    assert_eq!(eae.symbol.as_deref(), Some("AAPL  250120P00145000"));
    assert_eq!(eae.quantity, Some(Decimal::from_str("1").unwrap()));
    assert_eq!(eae.strike, Some(Decimal::from_str("145.00").unwrap()));
    assert_eq!(eae.underlying_symbol.as_deref(), Some("AAPL"));
}

#[test]
fn test_fx_transactions() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert_eq!(statement.fx_transactions.items.len(), 1);
    let fx = &statement.fx_transactions.items[0];

    assert_eq!(fx.account_id.as_deref(), Some("U1234567"));
    assert_eq!(fx.transaction_id.as_deref(), Some("2001"));
    assert_eq!(fx.from_currency.as_deref(), Some("USD"));
    assert_eq!(fx.to_currency.as_deref(), Some("EUR"));
    assert_eq!(fx.quantity, Some(Decimal::from_str("1000.00").unwrap()));
    assert_eq!(fx.proceeds, Some(Decimal::from_str("-920.50").unwrap()));
    assert_eq!(
        fx.fx_rate_to_base,
        Some(Decimal::from_str("1.087").unwrap())
    );
}

#[test]
fn test_change_in_dividend_accruals() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert_eq!(statement.change_in_dividend_accruals.items.len(), 1);
    let div = &statement.change_in_dividend_accruals.items[0];

    assert_eq!(div.account_id.as_deref(), Some("U1234567"));
    assert_eq!(div.symbol.as_deref(), Some("MSFT"));
    assert_eq!(div.ex_date.unwrap().to_string(), "2025-01-15");
    assert_eq!(
        div.pay_date.as_ref().map(|d| d.to_string()),
        Some("2025-02-15".to_string())
    );
    assert_eq!(div.gross_rate, Some(Decimal::from_str("0.75").unwrap()));
    assert_eq!(div.net_amount, Some(Decimal::from_str("75.00").unwrap()));
}

#[test]
fn test_open_dividend_accruals() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert_eq!(statement.open_dividend_accruals.items.len(), 1);
    let div = &statement.open_dividend_accruals.items[0];

    assert_eq!(div.account_id.as_deref(), Some("U1234567"));
    assert_eq!(div.symbol.as_deref(), Some("GOOGL"));
    assert_eq!(div.ex_date.unwrap().to_string(), "2025-01-25");
    assert_eq!(
        div.pay_date.as_ref().map(|d| d.to_string()),
        Some("2025-02-25".to_string())
    );
    assert_eq!(div.quantity, Some(Decimal::from_str("50").unwrap()));
    assert_eq!(div.gross_rate, Some(Decimal::from_str("0.50").unwrap()));
}

#[test]
fn test_interest_accruals() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert_eq!(statement.interest_accruals.items.len(), 1);
    let interest = &statement.interest_accruals.items[0];

    assert_eq!(interest.account_id.as_deref(), Some("U1234567"));
    assert_eq!(interest.currency.as_deref(), Some("USD"));
    assert_eq!(interest.from_date.unwrap().to_string(), "2025-01-01");
    assert_eq!(interest.to_date.unwrap().to_string(), "2025-01-31");
    assert_eq!(
        interest.starting_balance,
        Some(Decimal::from_str("50000.00").unwrap())
    );
    assert_eq!(
        interest.interest_accrued,
        Some(Decimal::from_str("12.50").unwrap())
    );
    assert_eq!(
        interest.ending_balance,
        Some(Decimal::from_str("50012.50").unwrap())
    );
}

#[test]
fn test_transfers() {
    let xml = include_str!("fixtures/activity_extended.xml");
    let statement = parse_activity_flex(xml).expect("Failed to parse");

    assert_eq!(statement.transfers.items.len(), 1);
    let transfer = &statement.transfers.items[0];

    assert_eq!(transfer.account_id.as_deref(), Some("U1234567"));
    assert_eq!(transfer.symbol.as_deref(), Some("TSLA"));
    assert_eq!(transfer.quantity, Some(Decimal::from_str("25").unwrap()));
    assert_eq!(transfer.direction.as_deref(), Some("IN"));
    assert_eq!(transfer.date.unwrap().to_string(), "2025-01-05");
}

#[test]
fn test_extended_types_default_to_empty() {
    // Test with minimal XML that doesn't include extended sections
    let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
    <FlexQueryResponse queryName="Test" type="AF">
        <FlexStatements count="1">
            <FlexStatement accountId="U1234567" fromDate="2025-01-01"
                           toDate="2025-01-31" whenGenerated="2025-01-31;150000">
                <Trades />
                <OpenPositions />
                <CashTransactions />
                <CorporateActions />
                <SecuritiesInfo />
                <ConversionRates />
            </FlexStatement>
        </FlexStatements>
    </FlexQueryResponse>"#;

    let statement = parse_activity_flex(xml).expect("Failed to parse");

    // All extended sections should default to empty
    assert!(statement.account_information.is_none());
    assert!(statement.change_in_nav.is_none()); // Single element, not wrapper
    assert_eq!(statement.equity_summary.items.len(), 0);
    assert_eq!(statement.cash_report.items.len(), 0);
    assert_eq!(statement.trade_confirms.items.len(), 0);
    assert_eq!(statement.option_eae.items.len(), 0);
    assert_eq!(statement.fx_transactions.items.len(), 0);
    assert_eq!(statement.change_in_dividend_accruals.items.len(), 0);
    assert_eq!(statement.open_dividend_accruals.items.len(), 0);
    assert_eq!(statement.interest_accruals.items.len(), 0);
    assert_eq!(statement.transfers.items.len(), 0);
}