ynab_api/models/
transaction_detail.rs

1/*
2 * YNAB API Endpoints
3 *
4 * Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
5 *
6 * The version of the OpenAPI document: 1.72.0
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct TransactionDetail {
16    #[serde(rename = "id")]
17    pub id: String,
18    /// The transaction date in ISO format (e.g. 2016-12-01)
19    #[serde(rename = "date")]
20    pub date: String,
21    /// The transaction amount in milliunits format
22    #[serde(rename = "amount")]
23    pub amount: i64,
24    #[serde(rename = "memo", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
25    pub memo: Option<Option<String>>,
26    #[serde(rename = "cleared")]
27    pub cleared: models::TransactionClearedStatus,
28    /// Whether or not the transaction is approved
29    #[serde(rename = "approved")]
30    pub approved: bool,
31    #[serde(rename = "flag_color", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
32    pub flag_color: Option<Option<models::TransactionFlagColor>>,
33    /// The customized name of a transaction flag
34    #[serde(rename = "flag_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
35    pub flag_name: Option<Option<String>>,
36    #[serde(rename = "account_id")]
37    pub account_id: uuid::Uuid,
38    #[serde(rename = "payee_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
39    pub payee_id: Option<Option<uuid::Uuid>>,
40    #[serde(rename = "category_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
41    pub category_id: Option<Option<uuid::Uuid>>,
42    /// If a transfer transaction, the account to which it transfers
43    #[serde(rename = "transfer_account_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
44    pub transfer_account_id: Option<Option<uuid::Uuid>>,
45    /// If a transfer transaction, the id of transaction on the other side of the transfer
46    #[serde(rename = "transfer_transaction_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
47    pub transfer_transaction_id: Option<Option<String>>,
48    /// If transaction is matched, the id of the matched transaction
49    #[serde(rename = "matched_transaction_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
50    pub matched_transaction_id: Option<Option<String>>,
51    /// If the transaction was imported, this field is a unique (by account) import identifier.  If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'.  For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'.  If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
52    #[serde(rename = "import_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
53    pub import_id: Option<Option<String>>,
54    /// If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
55    #[serde(rename = "import_payee_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
56    pub import_payee_name: Option<Option<String>>,
57    /// If the transaction was imported, the original payee name as it appeared on the statement
58    #[serde(rename = "import_payee_name_original", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
59    pub import_payee_name_original: Option<Option<String>>,
60    /// If the transaction is a debt/loan account transaction, the type of transaction
61    #[serde(rename = "debt_transaction_type", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
62    pub debt_transaction_type: Option<Option<DebtTransactionType>>,
63    /// Whether or not the transaction has been deleted.  Deleted transactions will only be included in delta requests.
64    #[serde(rename = "deleted")]
65    pub deleted: bool,
66    #[serde(rename = "account_name")]
67    pub account_name: String,
68    #[serde(rename = "payee_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
69    pub payee_name: Option<Option<String>>,
70    /// The name of the category.  If a split transaction, this will be 'Split'.
71    #[serde(rename = "category_name", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
72    pub category_name: Option<Option<String>>,
73    /// If a split transaction, the subtransactions.
74    #[serde(rename = "subtransactions")]
75    pub subtransactions: Vec<models::SubTransaction>,
76}
77
78impl TransactionDetail {
79    pub fn new(id: String, date: String, amount: i64, cleared: models::TransactionClearedStatus, approved: bool, account_id: uuid::Uuid, deleted: bool, account_name: String, subtransactions: Vec<models::SubTransaction>) -> TransactionDetail {
80        TransactionDetail {
81            id,
82            date,
83            amount,
84            memo: None,
85            cleared,
86            approved,
87            flag_color: None,
88            flag_name: None,
89            account_id,
90            payee_id: None,
91            category_id: None,
92            transfer_account_id: None,
93            transfer_transaction_id: None,
94            matched_transaction_id: None,
95            import_id: None,
96            import_payee_name: None,
97            import_payee_name_original: None,
98            debt_transaction_type: None,
99            deleted,
100            account_name,
101            payee_name: None,
102            category_name: None,
103            subtransactions,
104        }
105    }
106}
107/// If the transaction is a debt/loan account transaction, the type of transaction
108#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
109pub enum DebtTransactionType {
110    #[serde(rename = "payment")]
111    Payment,
112    #[serde(rename = "refund")]
113    Refund,
114    #[serde(rename = "fee")]
115    Fee,
116    #[serde(rename = "interest")]
117    Interest,
118    #[serde(rename = "escrow")]
119    Escrow,
120    #[serde(rename = "balanceAdjustment")]
121    BalanceAdjustment,
122    #[serde(rename = "credit")]
123    Credit,
124    #[serde(rename = "charge")]
125    Charge,
126}
127
128impl Default for DebtTransactionType {
129    fn default() -> DebtTransactionType {
130        Self::Payment
131    }
132}
133
ynab_api/models/transaction_detail.rs

ynab_api/models/
transaction_detail.rs
