ibflex 1.4.3

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

/*!
 * Definitions for Flex Query report
 */

use std::fmt::Display;

use serde::Deserialize;

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

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, PartialEq, Eq)]
pub struct FlexStatements {
    #[serde(rename = "@count")]
    pub count: i32,

    #[serde(rename = "FlexStatement")]
    pub flex_statement: FlexStatement,
}

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

    #[serde(rename = "CashTransactions")]
    pub cash_transactions: CashTransactions,
}

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

    }
}

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