quickbooks-ruby 0.4.0 → 1.0.16

data/lib/quickbooks/model/company_currency.rb

@@ -0,0 +1,19 @@
+module Quickbooks
+  module Model
+    class CompanyCurrency < BaseModel
+      include NameEntity::PermitAlterations
+
+      XML_COLLECTION_NODE = 'CompanyCurrency'
+      XML_NODE = 'CompanyCurrency'
+      REST_RESOURCE = 'companycurrency'
+
+      xml_name XML_NODE
+      xml_accessor :id, :from => 'Id'
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
+      xml_accessor :name, :from => 'Name'
+      xml_accessor :code, :from => 'Code'
+      xml_accessor :active?, :from => 'Active'
+    end
+  end
+end

data/lib/quickbooks/model/company_info.rb

@@ -25,7 +25,8 @@ module Quickbooks
       xml_accessor :name_values, :from => 'NameValue', :as => [NameValue]
 
       def find_name_value(name)
-        name_values.select { |nv| nv.name == name }.first.value
+        nv = name_values.find { |nv| nv.name == name }
+        nv ? nv.value : nil
       end
 
       def find_boolean_name_value(name)

data/lib/quickbooks/model/custom_field.rb

@@ -8,6 +8,24 @@ module Quickbooks
       xml_accessor :boolean_value, :from => 'BooleanValue'
       xml_accessor :date_value, :from => 'DateValue', :as => Date
       xml_accessor :number_value, :from => 'NumberValue', :as => Integer
+
+      def value
+        case type
+        when 'BooleanType' then boolean_value == 'true'
+        when 'StringType' then string_value
+        when 'DateType' then date_value
+        when 'NumberType' then number_value
+        end
+      end
+
+      def value=(value)
+        case type
+        when 'BooleanType' then self.boolean_value = value ? 'true' : 'false'
+        when 'StringType' then self.string_value = value
+        when 'DateType' then self.date_value = value
+        when 'NumberType' then self.number_value = value
+        end
+      end
     end
   end
 end

data/lib/quickbooks/model/customer.rb

@@ -53,12 +53,17 @@ module Quickbooks
       xml_accessor :default_tax_code_ref, :from => 'DefaultTaxCodeRef', :as => BaseReference
       xml_accessor :notes, :from => 'Notes'
       xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
+      xml_accessor :tax_exemption_reason_id, :from => 'TaxExemptionReasonId'
+      xml_accessor :primary_tax_identifier, :from => 'PrimaryTaxIdentifier'
+      xml_accessor :customer_type_ref, :from => 'CustomerTypeRef', :as => BaseReference
+      xml_accessor :isproject?, :from => 'IsProject'
 
       #== Validations
       validate :names_cannot_contain_invalid_characters
       validate :email_address_is_valid
 
-      reference_setters :parent_ref, :sales_term_ref, :payment_method_ref, :default_tax_code_ref, :currency_ref
+      reference_setters :parent_ref, :sales_term_ref, :payment_method_ref, :default_tax_code_ref, :currency_ref,
+                        :customer_type_ref
 
       def job?
         job.to_s == 'true'

data/lib/quickbooks/model/customer_type.rb

@@ -0,0 +1,15 @@
+module Quickbooks
+  module Model
+    class CustomerType < BaseModel
+      XML_COLLECTION_NODE = "CustomerType"
+      XML_NODE = "CustomerType"
+      REST_RESOURCE = 'customertype'
+
+      xml_accessor :id, :from => 'Id'
+      xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
+      xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
+      xml_accessor :name, :from => 'Name'
+      xml_accessor :active?, :from => 'Active'
+    end
+  end
+end

data/lib/quickbooks/model/deposit_line_detail.rb

@@ -2,7 +2,7 @@ module Quickbooks
   module Model
     class DepositLineDetail < BaseModel
 
-      xml_accessor :entity, :from => 'Entity', :as => Entity
+      xml_accessor :entity_ref, :from => 'Entity', :as => BaseReference
       xml_accessor :class_ref, :from => 'ClassRef', :as => BaseReference
       xml_accessor :account_ref, :from => 'AccountRef', :as => BaseReference
       xml_accessor :payment_method_ref, :from => 'PaymentMethodRef', :as => BaseReference
@@ -10,7 +10,7 @@ module Quickbooks
       xml_accessor :txn_type, :from => 'TxnType'
       xml_accessor :custom_fields, :from => 'CustomField', :as => [CustomField]
 
-      reference_setters :class_ref, :account_ref, :payment_method_ref
+      reference_setters :class_ref, :account_ref, :payment_method_ref, :entity_ref
 
     end
   end

data/lib/quickbooks/model/description_line_detail.rb

@@ -0,0 +1,7 @@
+module Quickbooks
+  module Model
+    class DescriptionLineDetail < BaseModel
+
+    end
+  end
+end

data/lib/quickbooks/model/effective_tax_rate.rb

@@ -0,0 +1,15 @@
+require 'time'
+
+module Quickbooks
+  module Model
+    class EffectiveTaxRate < BaseModel
+      XML_COLLECTION_NODE = "EffectiveTaxRate"
+      XML_NODE = "EffectiveTaxRate"
+      REST_RESOURCE = "effectivetaxrate"
+
+      xml_accessor :rate_value, :from => 'RateValue'
+      xml_accessor :effective_date, :from => 'EffectiveDate', :as => Time
+      xml_accessor :end_date, :from => 'EndDate', :as => Time
+    end
+  end
+end

data/lib/quickbooks/model/exchange_rate.rb

@@ -0,0 +1,23 @@
+module Quickbooks
+  module Model
+    class ExchangeRate < BaseModel
+      XML_COLLECTION_NODE = "ExchangeRate"
+      XML_NODE = "ExchangeRate"
+      REST_RESOURCE = "exchangerate"
+
+      xml_accessor :id, :from => "Id"
+      xml_accessor :sync_token, :from => "SyncToken", :as => Integer
+      xml_accessor :meta_data, :from => "MetaData", :as => MetaData
+
+      xml_accessor :custom_fields, :from => 'CustomField', :as => [CustomField]
+      xml_accessor :source_currency_code, :from => 'SourceCurrencyCode'
+      xml_accessor :target_currency_code, :from => 'TargetCurrencyCode'
+      xml_accessor :rate, :from => 'Rate', :as => BigDecimal, :to_xml => to_xml_big_decimal
+      xml_accessor :as_of_date, :from => 'AsOfDate', :as => Date
+
+      validates_presence_of :source_currency_code, :rate, :as_of_date
+      validates_length_of :source_currency_code, :is => 3
+      validates_length_of :target_currency_code, :is => 3
+    end
+  end
+end

data/lib/quickbooks/model/group_line_detail.rb

@@ -3,7 +3,8 @@ module Quickbooks
     class GroupLineDetail < BaseModel
       include HasLineItems
 
-      xml_accessor :group_item_ref, :from => 'CustomerRef', :as => BaseReference
+      xml_accessor :id, :from => 'Id'
+      xml_accessor :group_item_ref, :from => 'GroupItemRef', :as => BaseReference
       xml_accessor :quantity, :from => 'Quantity', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :line_items, :from => 'Line', :as => [Line]
 

data/lib/quickbooks/model/invoice.rb

@@ -24,6 +24,7 @@ module Quickbooks
       xml_accessor :custom_fields, :from => 'CustomField', :as => [CustomField]
       xml_accessor :auto_doc_number, :from => 'AutoDocNumber' # See auto_doc_number! method below for usage
       xml_accessor :doc_number, :from => 'DocNumber'
+      xml_accessor :invoice_link, :from => 'InvoiceLink'
       xml_accessor :txn_date, :from => 'TxnDate', :as => Date
       xml_accessor :currency_ref, :from => 'CurrencyRef', :as => BaseReference
       xml_accessor :exchange_rate, :from => 'ExchangeRate', :as => BigDecimal, :to_xml => to_xml_big_decimal
@@ -35,6 +36,7 @@ module Quickbooks
       xml_accessor :customer_memo, :from => 'CustomerMemo'
       xml_accessor :billing_address, :from => 'BillAddr', :as => PhysicalAddress
       xml_accessor :shipping_address, :from => 'ShipAddr', :as => PhysicalAddress
+      xml_accessor :ship_from_address, :from => 'ShipFromAddr', :as => PhysicalAddress
       xml_accessor :class_ref, :from => 'ClassRef', :as => BaseReference
       xml_accessor :sales_term_ref, :from => 'SalesTermRef', :as => BaseReference
       xml_accessor :due_date, :from => 'DueDate', :as => Date
@@ -48,6 +50,7 @@ module Quickbooks
       xml_accessor :print_status, :from => 'PrintStatus'
       xml_accessor :email_status, :from => 'EmailStatus'
       xml_accessor :balance, :from => 'Balance', :as => BigDecimal, :to_xml => to_xml_big_decimal
+      xml_accessor :home_balance, :from => 'HomeBalance', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :deposit, :from => 'Deposit', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :department_ref, :from => 'DepartmentRef', :as => BaseReference
       xml_accessor :allow_ipn_payment?, :from => 'AllowIPNPayment'
@@ -57,6 +60,7 @@ module Quickbooks
       xml_accessor :allow_online_credit_card_payment?, :from => 'AllowOnlineCreditCardPayment'
       xml_accessor :allow_online_ach_payment?, :from => 'AllowOnlineACHPayment'
       xml_accessor :deposit_to_account_ref, :from => 'DepositToAccountRef', :as => BaseReference
+      xml_accessor :bill_email_cc, :from => 'BillEmailCc', :as => EmailAddress
 
 
       reference_setters
@@ -85,6 +89,9 @@ module Quickbooks
         self.bill_email = EmailAddress.new(email_address_string)
       end
 
+      def billing_email_cc_address=(email_address_string)
+        self.bill_email_cc = EmailAddress.new(email_address_string)
+      end
 
       def wants_billing_email_sent!
         self.email_status = EMAIL_STATUS_NEED_TO_SEND
@@ -94,7 +101,6 @@ module Quickbooks
         email_status == EMAIL_STATUS_NEED_TO_SEND
       end
 
-
       def existence_of_customer_ref
         if customer_ref.nil? || (customer_ref && customer_ref.value == 0)
           errors.add(:customer_ref, "CustomerRef is required and must be a non-zero value.")

data/lib/quickbooks/model/invoice_change.rb

@@ -1,6 +1,7 @@
 module Quickbooks
   module Model
-    # Refer to: https://developer.intuit.com/docs/0100_accounting/0300_developer_guides/change_data_capture
+    # Refer to:
+    # - https://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/change_data_capture
     class InvoiceChange < ChangeModel
       XML_NODE = "Invoice"
     end

data/lib/quickbooks/model/invoice_group_line_detail.rb

@@ -0,0 +1,14 @@
+module Quickbooks
+  module Model
+    class InvoiceGroupLineDetail < InvoiceLineItem
+      include HasLineItems
+
+      xml_accessor :id, :from => 'Id'
+      xml_accessor :group_item_ref, :from => 'GroupItemRef', :as => BaseReference
+      xml_accessor :quantity, :from => 'Quantity', :as => BigDecimal, :to_xml => to_xml_big_decimal
+      xml_accessor :line_items, :from => 'Line', :as => [InvoiceLineItem]
+
+      reference_setters :group_item_ref
+    end
+  end
+end

data/lib/quickbooks/model/invoice_line_item.rb

@@ -1,12 +1,16 @@
 module Quickbooks
   module Model
     class InvoiceLineItem < BaseModel
+      require 'quickbooks/model/invoice_group_line_detail'
 
       #== Constants
       SALES_LINE_ITEM_DETAIL = 'SalesItemLineDetail'
       SUB_TOTAL_LINE_DETAIL = 'SubTotalLineDetail'
       PAYMENT_LINE_DETAIL = 'PaymentLineDetail'
       DISCOUNT_LINE_DETAIL = 'DiscountLineDetail'
+      INVOICE_GROUP_LINE_DETAIL = 'GroupLineDetail'
+      DESCRIPTION_LINE_DETAIL = 'DescriptionLineDetail'
+      DESCRIPTION_DETAIL_TYPE = 'DescriptionOnly'
 
       xml_accessor :id, :from => 'Id'
       xml_accessor :line_num, :from => 'LineNum', :as => Integer
@@ -15,10 +19,16 @@ module Quickbooks
       xml_accessor :detail_type, :from => 'DetailType'
 
       #== Various detail types
-      xml_accessor :sales_line_item_detail, :from => 'SalesItemLineDetail', :as => SalesItemLineDetail
-      xml_accessor :sub_total_line_detail, :from => 'SubTotalLineDetail', :as => SubTotalLineDetail
-      xml_accessor :payment_line_detail, :from => 'PaymentLineDetail', :as => PaymentLineDetail
-      xml_accessor :discount_line_detail, :from => 'DiscountLineDetail', :as => DiscountLineDetail
+      xml_accessor :sales_line_item_detail, :from => SALES_LINE_ITEM_DETAIL, :as => SalesItemLineDetail
+      xml_accessor :sub_total_line_detail, :from => SUB_TOTAL_LINE_DETAIL, :as => SubTotalLineDetail
+      xml_accessor :payment_line_detail, :from => PAYMENT_LINE_DETAIL, :as => PaymentLineDetail
+      xml_accessor :discount_line_detail, :from => DISCOUNT_LINE_DETAIL, :as => DiscountLineDetail
+      xml_accessor :group_line_detail, :from => INVOICE_GROUP_LINE_DETAIL, :as => InvoiceGroupLineDetail
+      xml_accessor :description_line_detail, :from => DESCRIPTION_LINE_DETAIL, :as => DescriptionLineDetail
+
+      def group_line_detail?
+        detail_type.to_s == INVOICE_GROUP_LINE_DETAIL
+      end
 
       def sales_item?
         detail_type.to_s == SALES_LINE_ITEM_DETAIL
@@ -32,6 +42,12 @@ module Quickbooks
         detail_type.to_s == DISCOUNT_LINE_DETAIL
       end
 
+      def description_only?
+        # The detail type for a description-only line detail differs slightly
+        # from the node name (DescriptionOnly vs DescriptionLineDetail)
+        detail_type.to_s == DESCRIPTION_DETAIL_TYPE
+      end
+
       def sales_item!
         self.detail_type = SALES_LINE_ITEM_DETAIL
         self.sales_line_item_detail = SalesItemLineDetail.new
@@ -39,6 +55,13 @@ module Quickbooks
         yield self.sales_line_item_detail if block_given?
       end
 
+      def group_line_detail!
+        self.detail_type = INVOICE_GROUP_LINE_DETAIL
+        self.group_line_detail = InvoiceGroupLineDetail.new
+
+        yield self.group_line_detail if block_given?
+      end
+
       def payment_item!
         self.detail_type = PAYMENT_LINE_DETAIL
         self.payment_line_detail = PaymentLineDetail.new
@@ -53,6 +76,13 @@ module Quickbooks
         yield self.discount_line_detail if block_given?
       end
 
+      def description_only!
+        self.detail_type = DESCRIPTION_DETAIL_TYPE
+        self.description_line_detail = DescriptionLineDetail.new
+
+        yield self.description_line_detail if block_given?
+      end
+
     end
   end
 end

data/lib/quickbooks/model/item.rb

@@ -12,20 +12,25 @@ module Quickbooks
       REST_RESOURCE = 'item'
 
       INVENTORY_TYPE = 'Inventory'
-      NON_INVENTORY_TYPE = 'Non Inventory'
+      NON_INVENTORY_TYPE = 'NonInventory'
       SERVICE_TYPE = 'Service'
-      ITEM_TYPES = [INVENTORY_TYPE, NON_INVENTORY_TYPE, SERVICE_TYPE]
+      CATEGORY_TYPE = 'Category'
+      ITEM_TYPES = [INVENTORY_TYPE, NON_INVENTORY_TYPE, SERVICE_TYPE, CATEGORY_TYPE]
 
       xml_name 'Item'
       xml_accessor :id, :from => 'Id'
       xml_accessor :sync_token, :from => 'SyncToken', :as => Integer
       xml_accessor :meta_data, :from => 'MetaData', :as => MetaData
       xml_accessor :name, :from => 'Name'
+      xml_accessor :sku, :from => 'Sku'
       xml_accessor :description, :from => 'Description'
       xml_accessor :active?, :from => 'Active'
       xml_accessor :sub_item?, :from => 'SubItem'
       xml_accessor :parent_ref, :from => 'ParentRef', :as => Integer
       xml_accessor :level, :from => 'Level', :as => Integer
+      xml_accessor :pref_vendor_ref, :from => 'PrefVendorRef', :as => BaseReference
+      xml_accessor :tax_classification_ref, :from => 'TaxClassificationRef', :as => BaseReference
+      xml_accessor :class_ref, :from => 'ClassRef', :as => BaseReference
 
       # read-only
       xml_accessor :fully_qualified_name, :from => 'FullyQualifiedName'
@@ -45,9 +50,13 @@ module Quickbooks
       xml_accessor :sales_tax_code_ref, :from => 'SalesTaxCodeRef', :as => BaseReference
       xml_accessor :purchase_tax_code_ref, :from => 'PurchaseTaxCodeRef', :as => BaseReference
       xml_accessor :inv_start_date, :from => 'InvStartDate', :as => Date
+      xml_accessor :custom_fields, :from => "CustomField", as: [CustomField]
+      xml_accessor :print_grouped_items?, :from => 'PrintGroupedItems'
+      xml_accessor :item_group_details, :from => 'ItemGroupDetail', :as => ItemGroupDetail
 
       reference_setters :parent_ref, :income_account_ref, :expense_account_ref
       reference_setters :asset_account_ref, :sales_tax_code_ref, :purchase_tax_code_ref
+      reference_setters :pref_vendor_ref, :tax_classification_ref, :class_ref
 
       #== Validations
       validates_length_of :name, :minimum => 1
@@ -75,7 +84,6 @@ module Quickbooks
         end
         errors.empty?
       end
-
     end
   end
 end

data/lib/quickbooks/model/item_group_detail.rb

@@ -0,0 +1,9 @@
+module Quickbooks
+  module Model
+    class ItemGroupDetail < BaseModel
+      include HasLineItems
+
+      xml_accessor :line_items, :from => 'ItemGroupLine', :as => [ItemGroupLine]
+    end
+  end
+end

data/lib/quickbooks/model/item_group_line.rb

@@ -0,0 +1,20 @@
+module Quickbooks
+  module Model
+    class ItemGroupLine < BaseModel
+      xml_accessor :item_ref, :from => 'ItemRef', :as => BaseReference
+      xml_accessor :quantity, :from => 'Qty'
+
+      def id
+        item_ref.value.to_i
+      end
+
+      def name
+        item_ref.name
+      end
+
+      def type
+        item_ref.type
+      end
+    end
+  end
+end

data/lib/quickbooks/model/line.rb

@@ -1,12 +1,15 @@
 module Quickbooks
   module Model
     class Line < BaseModel
+      require 'quickbooks/model/group_line_detail'
+
       #== Constants
       SALES_ITEM_LINE_DETAIL = 'SalesItemLineDetail'
       SUB_TOTAL_LINE_DETAIL = 'SubTotalLineDetail'
       PAYMENT_LINE_DETAIL = 'PaymentLineDetail'
       DISCOUNT_LINE_DETAIL = 'DiscountLineDetail'
       JOURNAL_ENTRY_LINE_DETAIL = 'JournalEntryLineDetail'
+      GROUP_LINE_DETAIL = 'GroupLineDetail'
 
       xml_accessor :id, :from => 'Id'
       xml_accessor :line_num, :from => 'LineNum', :as => Integer
@@ -14,6 +17,7 @@ module Quickbooks
       xml_accessor :amount, :from => 'Amount', :as => BigDecimal, :to_xml => to_xml_big_decimal
       xml_accessor :detail_type, :from => 'DetailType'
       xml_accessor :linked_transactions, :from => 'LinkedTxn', :as => [LinkedTransaction]
+      xml_accessor :line_extras, :from => 'LineEx', :as => LineEx
 
       #== Various detail types
       xml_accessor :sales_item_line_detail, :from => 'SalesItemLineDetail', :as => SalesItemLineDetail
@@ -21,6 +25,7 @@ module Quickbooks
       xml_accessor :payment_line_detail, :from => 'PaymentLineDetail', :as => PaymentLineDetail
       xml_accessor :discount_line_detail, :from => 'DiscountLineDetail', :as => DiscountOverride
       xml_accessor :journal_entry_line_detail, :from => 'JournalEntryLineDetail', :as => JournalEntryLineDetail
+      xml_accessor :group_line_detail, :from => 'GroupLineDetail', :as => GroupLineDetail
 
       def initialize(*args)
         self.linked_transactions ||= []
@@ -72,6 +77,13 @@ module Quickbooks
         yield self.journal_entry_line_detail if block_given?
       end
 
+      def group_line!
+        self.detail_type = GROUP_LINE_DETAIL
+        self.group_line_detail = GroupLineDetail.new
+
+        yield self.group_line_detail if block_given?
+      end
+
       private
 
       def update_linked_transactions(txn_ids, txn_type)