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
95
96
97
98
99
100
101
102
103
104
105

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

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

#[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))
)]

/// `BillPayment`
///
/// Represents a payment applied to vendor bills (accounts payable). Payments can be made by check or credit card; corresponding details are provided via `check_payment` or `credit_card_payment`.
///
/// API reference:
/// <https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/billpayment>
pub struct BillPayment {
    /// The unique sync token of the entity, used for concurrency control
    pub sync_token: Option<String>,
    /// Domain of the transaction. `QBO` for `QuickBooks` Online.
    pub domain: Option<String>,
    /// Reference to the vendor for the transaction.
    pub vendor_ref: Option<NtRef>,
    /// Date of the transaction in YYYY-MM-DD format.
    pub txn_date: Option<String>,
    /// Total amount of the transaction.
    pub total_amt: Option<f64>,
    /// Type of payment for the transaction.
    pub pay_type: Option<PayType>,
    /// Private note for the transaction
    pub private_note: Option<String>,
    /// Indicates if the transaction is a sparse object
    pub sparse: Option<bool>,
    /// Line items for the transaction
    pub line: Option<LineField>,
    /// The unique ID of the entity
    pub id: Option<String>,
    /// Information about a check payment for the transaction. Not applicable to Estimate and `SalesOrder`. Used when `PayType` is `Check`
    pub check_payment: Option<CheckBillPayment>,
    /// Information about a credit card payment for the transaction. Not applicable to Estimate and `SalesOrder`. Used when `PayType` is `CreditCard`
    pub credit_card_payment: Option<CreditCardBillPayment>,
    /// Metadata about the transaction
    pub meta_data: Option<MetaData>,
}

/// `CheckBillPayment`
///
/// Information about a check payment for the transaction.
#[skip_serializing_none]
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct CheckBillPayment {
    pub print_status: Option<String>,
    pub bank_account_ref: Option<NtRef>,
}

/// `CreditCardBillPayment`
///
/// Information about a credit card payment for the transaction.
#[skip_serializing_none]
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct CreditCardBillPayment {
    #[serde(rename = "CCAccountRef")]
    pub cc_account_ref: Option<NtRef>,
}

/// `PayType`
///
/// Method by which a bill payment is made.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum PayType {
    #[default]
    CreditCard,
    Check,
}

impl QBCreatable for BillPayment {
    fn can_create(&self) -> bool {
        self.vendor_ref.is_some()
            && self.total_amt.is_some()
            && self.line.is_some()
            && self.pay_type.as_ref().is_some_and(|e| match e {
                PayType::CreditCard => self.credit_card_payment.is_some(),
                PayType::Check => self.check_payment.is_some(),
            })
        // TODO Currency ref check
    }
}

impl QBVoidable for BillPayment {}
impl QBDeletable for BillPayment {}
impl QBFullUpdatable for BillPayment {
    fn can_full_update(&self) -> bool {
        self.can_create() && self.has_read()
    }
}