quickbooks-types 0.1.1

Type definitions for QuickBooks Online API
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

use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;

use super::common::{MetaData, NtRef};
#[cfg(feature = "builder")]
use crate::error::QBTypeError;
use crate::{QBCreatable, QBFullUpdatable, QBItem};

#[skip_serializing_none]
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize, Default)]
#[serde(rename_all = "PascalCase", default)]
#[cfg_attr(
    feature = "builder",
    derive(Builder),
    builder(default, build_fn(error = "QBTypeError"), setter(into, strip_option))
)]

/// Account
///
/// Represents a general ledger account in `QuickBooks` Online (for example: Bank, Income, Expense).
/// Accounts categorize transactions and track balances. Many entities reference an account via `*Ref` fields.
///
/// Creation requirements:
/// - `QBCreatable::can_create()` returns true when `name` is set and either `account_type` or `account_sub_type` is set.
///
/// Update semantics:
/// - `QBFullUpdatable::can_full_update()` returns true when `has_read()` (ID + sync token present) and `name` are set.
///
/// API reference:
/// <https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account>
pub struct Account {
    /// The unique ID of the entity
    pub id: Option<String>,
    /// The unique sync token of the entity, used for concurrency control
    pub sync_token: Option<String>,
    /// Metadata about the entity
    #[serde(skip_serializing)]
    pub meta_data: Option<MetaData>,
    /// Name of the account
    pub name: Option<String>,
    /// Account number
    pub acct_num: Option<String>,
    /// Reference to the currency for the account
    pub currency_ref: Option<NtRef>,
    /// Reference to the parent account if this is a sub-account
    pub parent_ref: Option<NtRef>,
    /// Description of the account
    pub descripton: Option<String>,
    /// Indicates if the account is active
    pub active: Option<bool>,
    /// Indicates if the account is a sub-account
    pub sub_account: Option<bool>,
    /// Classification of the account
    pub classification: Option<String>,
    /// Fully qualified name of the account
    pub fully_qualified_name: Option<String>,
    /// Location type for transactions in this account
    pub txn_location_type: Option<String>,
    /// Type of account
    pub account_type: Option<AccountType>,
    /// Current balance including sub-accounts
    pub current_balance_with_sub_accounts: Option<f64>,
    /// Alternative name for the account
    pub account_alias: Option<String>,
    /// Reference to the tax code associated with the account
    pub tax_code_ref: Option<NtRef>,
    /// Sub-type of the account
    pub account_sub_type: Option<String>,
    /// Current balance of the account
    pub current_balance: Option<f64>,
}

/// `AccountType`
///
/// High-level classification of an account (for example: Bank, `OtherAsset`, Income).
/// Note: This enum is currently a placeholder; concrete variants will be added as the API surface is implemented.
#[derive(Clone, Debug, Default, Deserialize, PartialEq, Serialize)]
#[serde(rename_all = "PascalCase")]
pub enum AccountType {
    #[default]
    TODO, // TODO: Define actual types
}

impl QBCreatable for Account {
    fn can_create(&self) -> bool {
        self.name.is_some() && (self.account_type.is_some() || self.account_sub_type.is_some())
    }
}

impl QBFullUpdatable for Account {
    fn can_full_update(&self) -> bool {
        self.name.is_some() && self.has_read()
    }
}