quickbooks_types/models/
account.rs

1use serde::{Deserialize, Serialize};
2use serde_with::skip_serializing_none;
3
4use super::common::{MetaData, NtRef};
5#[cfg(feature = "builder")]
6use crate::error::QBTypeError;
7use crate::{QBCreatable, QBFullUpdatable, QBItem};
8
9#[skip_serializing_none]
10#[derive(Clone, Debug, Deserialize, PartialEq, Serialize, Default)]
11#[serde(rename_all = "PascalCase", default)]
12#[cfg_attr(
13    feature = "builder",
14    derive(Builder),
15    builder(default, build_fn(error = "QBTypeError"), setter(into, strip_option))
16)]
17
18/// Account
19///
20/// Represents a general ledger account in `QuickBooks` Online (for example: Bank, Income, Expense).
21/// Accounts categorize transactions and track balances. Many entities reference an account via `*Ref` fields.
22///
23/// API reference:
24/// <https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account>
25pub struct Account {
26    /// The unique ID of the entity
27    pub id: Option<String>,
28    /// The unique sync token of the entity, used for concurrency control
29    pub sync_token: Option<String>,
30    /// Metadata about the entity
31    #[serde(skip_serializing)]
32    pub meta_data: Option<MetaData>,
33    /// Name of the account
34    pub name: Option<String>,
35    /// Account number
36    pub acct_num: Option<String>,
37    /// Reference to the currency for the account
38    pub currency_ref: Option<NtRef>,
39    /// Reference to the parent account if this is a sub-account
40    pub parent_ref: Option<NtRef>,
41    /// Description of the account
42    pub descripton: Option<String>,
43    /// Indicates if the account is active
44    pub active: Option<bool>,
45    /// Indicates if the account is a sub-account
46    pub sub_account: Option<bool>,
47    /// Classification of the account
48    pub classification: Option<String>,
49    /// Fully qualified name of the account
50    pub fully_qualified_name: Option<String>,
51    /// Location type for transactions in this account
52    pub txn_location_type: Option<String>,
53    /// Type of account
54    pub account_type: Option<AccountType>,
55    /// Current balance including sub-accounts
56    pub current_balance_with_sub_accounts: Option<f64>,
57    /// Alternative name for the account
58    pub account_alias: Option<String>,
59    /// Reference to the tax code associated with the account
60    pub tax_code_ref: Option<NtRef>,
61    /// Sub-type of the account
62    pub account_sub_type: Option<String>,
63    /// Current balance of the account
64    pub current_balance: Option<f64>,
65}
66
67/// `AccountType`
68///
69/// High-level classification of an account (for example: Bank, `OtherAsset`, Income).
70/// Note: This enum is currently a placeholder; concrete variants will be added as the API surface is implemented.
71#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
72#[serde(rename_all = "PascalCase")]
73pub enum AccountType {
74    #[default]
75    TODO, // TODO: Define actual types
76}
77
78impl QBCreatable for Account {
79    fn can_create(&self) -> bool {
80        self.name.is_some() && (self.account_type.is_some() || self.account_sub_type.is_some())
81    }
82}
83
84impl QBFullUpdatable for Account {
85    fn can_full_update(&self) -> bool {
86        self.name.is_some() && self.has_read()
87    }
88}
quickbooks_types/models/account.rs

quickbooks_types/models/
account.rs
