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

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

use super::common::{Addr, Email, MetaData, NtRef, PhoneNumber, WebAddr};
#[cfg(feature = "builder")]
use crate::error::QBTypeError;
use crate::{QBFullUpdatable, QBSparseUpdateable};

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

/// `CompanyInfo`
///
/// Represents the company profile and contact settings for a `QuickBooks` Online company.
///
/// Update semantics:
/// - `QBFullUpdatable::can_full_update()` returns true when `sync_token`, `company_name`, and `company_addr` are present.
///
/// API reference:
/// <https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/companyinfo>
pub struct CompanyInfo {
    /// 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>,
    /// Company address information
    pub company_addr: Option<Addr>,
    /// Name of the company
    pub company_name: Option<String>,
    /// Date the company was started in YYYY-MM-DD format
    pub company_start_date: Option<NaiveDate>,
    /// Country of the company
    pub country: Option<String>,
    /// Address used for customer communications
    pub customer_communication_addr: Option<Addr>,
    /// Domain of the company. Typically `QBO` for `QuickBooks` Online
    pub domain: Option<String>,
    /// Company email information
    pub email: Option<Email>,
    /// Month when the fiscal year starts
    pub fiscal_year_start_month: Option<String>,
    /// Legal address of the company
    pub legal_addr: Option<Addr>,
    /// Legal name of the company
    pub legal_name: Option<String>,
    /// Custom name-value pairs for the company
    pub name_value: Option<Vec<NtRef>>,
    /// Primary phone number for the company
    pub primary_phone: Option<PhoneNumber>,
    /// Indicates if the entity is a sparse object
    pub sparse: Option<bool>,
    /// Languages supported by the company
    pub supported_languages: Option<String>,
    /// Web address (website URL) of the company
    pub web_addr: Option<WebAddr>,
}

impl QBFullUpdatable for CompanyInfo {
    fn can_full_update(&self) -> bool {
        self.sync_token.is_some() && self.company_name.is_some() && self.company_addr.is_some()
    }
}

impl QBSparseUpdateable for CompanyInfo {
    fn can_sparse_update(&self) -> bool {
        self.can_full_update()
    }
}