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

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

use super::common::{CreditCardPayment, MetaData, NtRef};
#[cfg(feature = "builder")]
use crate::error::QBTypeError;
use crate::{
    LineField, QBCreatable, QBDeletable, QBFullUpdatable, QBItem, QBPDFable, QBSendable, 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))
)]

/// `Payment`
///
/// Represents receipt or application of funds against customer balances or invoices.
///
/// Creation requirements:
/// - `QBCreatable::can_create()` returns true when both `total_amt` and `customer_ref` are present.
///
/// Update semantics:
/// - `QBFullUpdatable::can_full_update()` returns true when `has_read()` (ID + sync token) and `can_create()` are both true.
/// - `QBDeletable` and `QBVoidable` are implemented; both require `has_read()`.
///
/// API reference:
/// <https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/payment>
pub struct Payment {
    /// 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>,
    /// Total amount of the payment
    pub total_amt: Option<f64>,
    /// Reference to the customer for the payment
    pub customer_ref: Option<NtRef>,
    /// Reference to the currency for the payment
    pub currency_ref: Option<NtRef>,
    /// Private note for the payment
    pub private_note: Option<String>,
    /// Reference to the payment method
    pub payment_method_ref: Option<NtRef>,
    /// Unapplied amount of the payment
    pub unapplied_amt: Option<f64>,
    /// Reference to the account where the payment is deposited
    pub deposit_to_account_ref: Option<NtRef>,
    /// Exchange rate for the payment
    pub exchange_rate: Option<f64>,
    /// Line items for the payment
    pub line: Option<LineField>,
    /// Source of the transaction
    pub txn_source: Option<String>,
    /// Reference to the accounts receivable account
    #[serde(rename = "ARAccountRef")]
    pub ar_account_ref: Option<NtRef>,
    /// Date of the transaction in YYYY-MM-DD format
    pub txn_date: Option<NaiveDate>,
    /// Information about a credit card payment for the transaction
    pub credit_card_payment: Option<CreditCardPayment>,
    /// Type of location for the transaction
    pub transaction_location_type: Option<String>,
    /// Reference number for the payment
    pub payment_ref_num: Option<String>,
    /// Reference to the tax exemption for the payment
    pub tax_exemption_ref: Option<NtRef>,
}

impl QBCreatable for Payment {
    fn can_create(&self) -> bool {
        self.total_amt.is_some() && self.customer_ref.is_some()
    }
}

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

impl QBSendable for Payment {}
impl QBPDFable for Payment {}