xeroizer 2.17.1 → 3.0.0

data/lib/xeroizer/models/credit_note.rb

@@ -1,12 +1,12 @@
 module Xeroizer
   module Record
-    
+
     class CreditNoteModel < BaseModel
-        
+
       set_permissions :read, :write, :update
-      
+
       include AttachmentModel::Extensions
-      
+
       public
 
         # Retrieve the PDF version of the credit matching the `id`.
@@ -21,11 +21,11 @@ module Xeroizer
             pdf_data
           end
         end
-      
+
     end
-    
+
     class CreditNote < Base
-      
+
       CREDIT_NOTE_STATUS = {
         'AUTHORISED' =>       'Approved credit_notes awaiting payment',
         'DELETED' =>          'Draft credit_notes that are deleted',
@@ -35,7 +35,7 @@ module Xeroizer
         'VOIDED' =>           'Approved credit_notes that are voided'
       } unless defined?(CREDIT_NOTE_STATUS)
       CREDIT_NOTE_STATUSES = CREDIT_NOTE_STATUS.keys.sort
-      
+
       CREDIT_NOTE_TYPE = {
         'ACCRECCREDIT' =>           'Accounts Receivable',
         'ACCPAYCREDIT' =>           'Accounts Payable'
@@ -43,14 +43,15 @@ module Xeroizer
       CREDIT_NOTE_TYPES = CREDIT_NOTE_TYPE.keys.sort
 
       include Attachment::Extensions
-      
+
       set_primary_key :credit_note_id
       set_possible_primary_keys :credit_note_id, :credit_note_number
       list_contains_summary_only true
-      
+
       guid          :credit_note_id
       string        :credit_note_number
       string        :reference
+      guid          :branding_theme_id
       string        :type
       date          :date
       date          :due_date
@@ -65,20 +66,21 @@ module Xeroizer
       datetime      :fully_paid_on_date
       boolean       :sent_to_contact
       decimal       :remaining_credit
+      decimal       :applied_amount
       boolean       :has_attachments
 
       belongs_to    :contact
       has_many      :line_items
       has_many      :allocations
-      
+
       validates_inclusion_of :type, :in => CREDIT_NOTE_TYPES
       validates_inclusion_of :status, :in => CREDIT_NOTE_STATUSES, :allow_blanks => true
       validates_associated :contact
       validates_associated :line_items
       validates_associated :allocations, :allow_blanks => true
-      
+
       public
-      
+
         # Access the contact name without forcing a download of
         # an incomplete, summary credit note.
         def contact_name
@@ -89,20 +91,20 @@ module Xeroizer
         # incomplete, summary credit note.
         def contact_id
           attributes[:contact] && attributes[:contact][:contact_id]
-        end      
-      
+        end
+
         # Swallow assignment of attributes that should only be calculated automatically.
         def sub_total=(value);  raise SettingTotalDirectlyNotSupported.new(:sub_total);   end
         def total_tax=(value);  raise SettingTotalDirectlyNotSupported.new(:total_tax);   end
         def total=(value);      raise SettingTotalDirectlyNotSupported.new(:total);       end
-      
+
         # Calculate sub_total from line_items.
         def sub_total(always_summary = false)
           if !always_summary && (new_record? || (!new_record? && line_items && line_items.size > 0))
-            overall_sum = (line_items || []).inject(BigDecimal.new('0')) { | sum, line_item | sum + line_item.line_amount }
-            
+            overall_sum = (line_items || []).inject(BigDecimal('0')) { | sum, line_item | sum + line_item.line_amount }
+
             # If the default amount types are inclusive of 'tax' then remove the tax amount from this sub-total.
-            overall_sum -= total_tax if line_amount_types == 'Inclusive' 
+            overall_sum -= total_tax if line_amount_types == 'Inclusive'
             overall_sum
           else
             attributes[:sub_total]
@@ -112,7 +114,7 @@ module Xeroizer
         # Calculate total_tax from line_items.
         def total_tax(always_summary = false)
           if !always_summary && (new_record? || (!new_record? && line_items && line_items.size > 0))
-            (line_items || []).inject(BigDecimal.new('0')) { | sum, line_item | sum + line_item.tax_amount }
+            (line_items || []).inject(BigDecimal('0')) { | sum, line_item | sum + line_item.tax_amount }
           else
             attributes[:total_tax]
           end
@@ -126,14 +128,14 @@ module Xeroizer
             attributes[:total]
           end
         end
-        
+
         # Retrieve the PDF version of this credit note.
         # @param [String] filename optional filename to store the PDF in instead of returning the data.
         def pdf(filename = nil)
           parent.pdf(id, filename)
         end
 
-        def save
+        def save!
           # Calling parse_save_response() on the credit note will wipe out
           # the allocations, so we have to manually preserve them.
           allocations_backup = self.allocations

data/lib/xeroizer/models/currency.rb

@@ -3,14 +3,26 @@ module Xeroizer
     
     class CurrencyModel < BaseModel
         
-      set_permissions :read
+      set_permissions :read, :write
+
+      # Currencies can only be created (added), no update or delete is possible
+      def create_method
+        :http_put
+      end
       
     end
     
     class Currency < Base
+
+      # Currency does not have an ID
+      # This method overrides the base model to always treat a Currency as new (so it can be saved)
+      # Attempting to update a currency will result in a validation error.	
+      def new_record?
+      	true
+      end
       
       string  :code
-      string  :description
+      string  :description # read only
       
     end
     

data/lib/xeroizer/models/from_bank_account.rb

@@ -7,6 +7,7 @@ module Xeroizer
     class FromBankAccount < Base
       guid   :account_id
       string :code
+      string :name
     end
   end
 end

data/lib/xeroizer/models/history_record.rb

@@ -0,0 +1,72 @@
+module Xeroizer
+  module Record
+
+    class HistoryRecordModel < BaseModel
+
+      module Extensions
+        def history(id)
+          application.HistoryRecord.history(url, id)
+        end
+
+        def add_note(id, details)
+          application.HistoryRecord.add_note(url, id, details)
+        end
+      end
+
+      set_permissions :read
+
+      # History Records can only be added, no update or delete is possible
+      def create_method
+        :http_put
+      end
+
+      def history(url, id)
+        response_xml = @application.http_get(@application.client, "#{url}/#{CGI.escape(id)}/history")
+
+        response = parse_response(response_xml)
+
+        response.response_items
+      end
+
+      def add_note(url, id, details)
+        record = build(details: details)
+        xml = to_bulk_xml([record])
+        response_xml = @application.http_put(@application.client,
+                                              "#{url}/#{CGI.escape(id)}/history",
+                                              xml,
+                                              raw_body: true
+                                             )
+        response = parse_response(response_xml)
+        if (response_items = response.response_items) && response_items.size > 0
+          response_items.size == 1 ? response_items.first : response_items
+        else
+          response
+        end
+      end
+
+    end
+
+    class HistoryRecord < Base
+
+      module Extensions
+        def history
+          parent.history(id)
+        end
+
+        def add_note(details)
+          parent.add_note(id, details)
+        end
+      end
+
+      datetime_utc :date_utc, :api_name => 'DateUTC'
+      string :date_utc_string, :api_name => 'DateUTCString'
+      string :changes
+      string :user
+      string :details
+
+      validates_presence_of :details
+
+    end
+
+  end
+end

data/lib/xeroizer/models/invoice.rb

@@ -1,4 +1,6 @@
 require "xeroizer/models/attachment"
+require "xeroizer/models/online_invoice"
+require "xeroizer/models/history_record"
 
 module Xeroizer
   module Record
@@ -14,6 +16,8 @@ module Xeroizer
       set_permissions :read, :write, :update
 
       include AttachmentModel::Extensions
+      include OnlineInvoiceModel::Extensions
+      include HistoryRecordModel::Extensions
 
       public
 
@@ -51,6 +55,8 @@ module Xeroizer
       INVOICE_STATUSES = INVOICE_STATUS.keys.sort
 
       include Attachment::Extensions
+      include OnlineInvoice::Extensions
+      include HistoryRecord::Extensions
 
       set_primary_key :invoice_id
       set_possible_primary_keys :invoice_id, :invoice_number
@@ -86,8 +92,10 @@ module Xeroizer
       has_many     :line_items, :complete_on_page => true
       has_many     :payments
       has_many     :credit_notes
+      has_many     :prepayments
 
-      validates_presence_of :date, :due_date, :unless => :new_record?
+      validates_presence_of :date, :if => :new_record?
+      validates_presence_of :due_date, :if => :approved?
       validates_inclusion_of :type, :in => INVOICE_TYPES
       validates_inclusion_of :status, :in => INVOICE_STATUSES, :unless => :new_record?
       validates_inclusion_of :line_amount_types, :in => LINE_AMOUNT_TYPES, :unless => :new_record?
@@ -148,7 +156,7 @@ module Xeroizer
         # Calculate sub_total from line_items.
         def sub_total(always_summary = false)
           if !@sub_total_is_set && not_summary_or_loaded_record(always_summary)
-            overall_sum = (line_items || []).inject(BigDecimal.new('0')) { | sum, line_item | sum + line_item.line_amount }
+            overall_sum = (line_items || []).inject(BigDecimal('0')) { | sum, line_item | sum + line_item.line_amount }
 
             # If the default amount types are inclusive of 'tax' then remove the tax amount from this sub-total.
             overall_sum -= total_tax if line_amount_types == 'Inclusive'
@@ -161,7 +169,7 @@ module Xeroizer
         # Calculate total_tax from line_items.
         def total_tax(always_summary = false)
           if !@total_tax_is_set && not_summary_or_loaded_record(always_summary)
-            (line_items || []).inject(BigDecimal.new('0')) { | sum, line_item | sum + line_item.tax_amount }
+            (line_items || []).inject(BigDecimal('0')) { | sum, line_item | sum + line_item.tax_amount }
           else
             attributes[:total_tax]
           end
@@ -206,6 +214,12 @@ module Xeroizer
           change_status!('AUTHORISED')
         end
 
+        # Send an email containing the invoice.
+        def email
+          email_url = "#{parent.url}/#{CGI.escape(id)}/Email"
+          parent.application.http_post(parent.application.client, email_url, "")
+        end
+
       protected
 
         def change_status!(new_status)

data/lib/xeroizer/models/item.rb

@@ -18,7 +18,6 @@ module Xeroizer
       string  :purchase_description
       string  :name
 
-      decimal :unit_price
       decimal :total_cost_pool # read only
       decimal :quantity_on_hand # read only
 
@@ -27,6 +26,8 @@ module Xeroizer
       boolean :is_tracked_as_inventory # read only, infered from inventory_asset_account_code, cogs_account_code, is_sold and is_purchased
       string  :inventory_asset_account_code
 
+      datetime_utc :updated_date_utc, api_name: 'UpdatedDateUTC'
+      
       belongs_to :purchase_details, :model_name => 'ItemPurchaseDetails'
       belongs_to :sales_details, :model_name => 'ItemSalesDetails'
       

data/lib/xeroizer/models/item_purchase_details.rb

@@ -12,7 +12,7 @@ module Xeroizer
       decimal :unit_price
       string  :account_code
       string  :tax_type
-      decimal :cogs_account_code
+      string  :cogs_account_code, api_name: 'COGSAccountCode'
 
     end
     

data/lib/xeroizer/models/line_item.rb

@@ -4,7 +4,7 @@ require 'xeroizer/models/line_amount_type'
 module Xeroizer
   module Record
     class LineItemModel < BaseModel
-
+      set_permissions
     end
 
     class LineItem < Base
@@ -19,10 +19,13 @@ module Xeroizer
       decimal :tax_amount
       decimal :line_amount, :calculated => true
       decimal :discount_rate
+      decimal :discount_amount
       string  :line_item_id
 
       has_many  :tracking, :model_name => 'TrackingCategoryChild'
 
+      validates_presence_of :description, :unless => Proc.new { |line_item| line_item.item_code.present? }
+
       def initialize(parent)
         super(parent)
         @line_amount_set = false
@@ -39,16 +42,25 @@ module Xeroizer
         return attributes[:line_amount] if summary_only || @line_amount_set
 
         if quantity && unit_amount
-          total = quantity * unit_amount
-          if discount_rate
-            BigDecimal((total * ((100 - discount_rate) / 100)).to_s).round(2)
+          total = coerce_numeric(quantity) * coerce_numeric(unit_amount)
+          if discount_rate.nonzero?
+            BigDecimal((total * ((100 - discount_rate.to_f) / 100)).to_s).round(2)
+          elsif discount_amount
+            BigDecimal((total - discount_amount).to_s).round(2)
           else
             BigDecimal(total.to_s).round(2)
           end
         end
       end
 
+      private
+
+      def coerce_numeric(number)
+        return number if number.is_a? Numeric
+        BigDecimal(number)
+      end
+
     end
-    
+
   end
 end

data/lib/xeroizer/models/manual_journal.rb

@@ -34,7 +34,8 @@ module Xeroizer
       string        :external_link_provider_name # only seems to be read-only at the moment
       boolean       :show_on_cash_basis_reports
       datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
-      
+      boolean       :has_attachments
+
       has_many      :journal_lines, :model_name => 'ManualJournalLine', :complete_on_page => true
       
       validates_presence_of :narration

data/lib/xeroizer/models/online_invoice.rb

@@ -0,0 +1,37 @@
+module Xeroizer
+  module Record
+    
+    class OnlineInvoiceModel < BaseModel
+
+      module Extensions
+        def online_invoice(id)
+          application.OnlineInvoice.online_invoice(url, id)
+        end
+      end
+    
+      set_permissions :read
+
+      def online_invoice(url, id)
+        response_xml = @application.http_get(@application.client, "#{url}/#{CGI.escape(id)}/OnlineInvoice")
+    
+        response = parse_response(response_xml)
+
+        response.response_items.first
+      end
+    
+    end
+    
+    class OnlineInvoice < Base
+
+      module Extensions
+        def online_invoice
+          parent.online_invoice(id)
+        end
+      end
+
+      string :online_invoice_url
+
+    end
+    
+  end
+end

data/lib/xeroizer/models/option.rb

@@ -11,7 +11,7 @@ module Xeroizer
       
       guid   :tracking_option_id
       string :name
-      
+      string :status
     end
     
   end

data/lib/xeroizer/models/organisation.rb

@@ -1,3 +1,4 @@
+require "xeroizer/models/payment_terms"
 module Xeroizer
   module Record
     
@@ -62,6 +63,7 @@ module Xeroizer
       has_many :addresses
       has_many :phones
       has_many :external_links
+      has_one :payment_terms, :model_name => 'PaymentTerms'
 
       validates :sales_tax_basis, :message => "is not a valid option" do
         valid = true

data/lib/xeroizer/models/payment_service.rb

@@ -0,0 +1,22 @@
+module Xeroizer
+  module Record
+
+    class PaymentServiceModel < BaseModel
+
+      set_permissions :read, :write, :update
+
+    end
+
+    class PaymentService < Base
+
+      set_primary_key :payment_service_id
+
+      guid :payment_service_id
+      string :payment_service_name
+      string :payment_service_url
+      string :payment_service_type
+      string :pay_now_text
+
+    end
+  end
+end

data/lib/xeroizer/models/payroll/address.rb

@@ -0,0 +1,53 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class AddressModel < PayrollBaseModel
+
+        class_inheritable_attributes :api_controller_name
+        class_inheritable_attributes :permissions
+        class_inheritable_attributes :xml_root_name
+        class_inheritable_attributes :optional_xml_root_name
+        class_inheritable_attributes :xml_node_name
+
+      end
+
+      class Address < PayrollBase
+
+        class_inheritable_attributes :fields, :possible_primary_keys, :primary_key_name, :summary_only, :validators
+
+
+        string      :address_line1
+        string      :address_line2
+        string      :city
+        string      :region
+        string      :postal_code
+        string      :country
+
+        # US Payroll fields
+        string      :street_address
+        string      :suite_or_apt_or_unit
+        string      :state
+        string      :zip
+        decimal     :latitude
+        decimal     :longitude
+
+      end
+
+      class HomeAddressModel < AddressModel
+        set_xml_node_name 'HomeAddress'
+      end
+
+      class HomeAddress < Address
+      end
+
+      class MailingAddressModel < AddressModel
+        set_xml_node_name 'MailingAddress'
+      end
+
+      class MailingAddress < Address
+      end
+
+    end
+  end
+end

data/lib/xeroizer/models/payroll/bank_account.rb

@@ -1,23 +1,35 @@
 module Xeroizer
   module Record
     module Payroll
-    
+
       class BankAccountModel < PayrollBaseModel
-          
+
       end
-      
+
       class BankAccount < PayrollBase
-        
+
         string      :statement_text
         string      :account_name
-        string      :bsb
+        string      :bsb, :api_name => 'BSB'
         string      :account_number
         boolean     :remainder
         string      :percentage
         decimal     :amount
 
+        # US Payroll fields
+
+        BANK_ACCOUNT_TYPE = {
+          'CHECKING' => '',
+          'SAVINGS' => ''
+        } unless defined?(BANK_ACCOUNT_TYPE)
+
+        string :account_holder_name
+        string :account_type
+        string :routing_number
+
+        validates_inclusion_of :account_type, :in => BANK_ACCOUNT_TYPE
       end
 
-    end 
+    end
   end
 end

data/lib/xeroizer/models/payroll/benefit_line.rb

@@ -0,0 +1,26 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class BenefitLineModel < PayrollBaseModel
+
+      end
+
+      class BenefitLine < PayrollBase
+
+        BENEFIT_TYPE_CALCULATION_TYPE = {
+          'FIXEDAMOUNT' => '',
+          'STANDARDAMOUNT' => ''
+        } unless defined?(BENEFIT_TYPE_CALCULATION_TYPE)
+
+        guid :benefit_type_id, :api_name => 'BenefitTypeID'
+        string :calculation_type
+        decimal :amount
+
+        validates_presence_of :benefit_type_id, :calculation_type, :unless => :new_record?
+        validates_inclusion_of :calculation_type, :in => BENEFIT_TYPE_CALCULATION_TYPE
+      end
+
+    end
+  end
+end

data/lib/xeroizer/models/payroll/benefit_type.rb

@@ -0,0 +1,45 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class BenefitTypeModel < PayrollBaseModel
+
+        set_permissions :read
+
+      end
+
+      class BenefitType < PayrollBase
+
+        BENEFIT_CATEGORIES = {
+          'AFTERTAXBENEFIT' => '',
+          'DEPENDENTCARE' => '',
+          'FLEXIBLESPENDINGACCOUNT' => '',
+          'HEALTHSAVINGSACCOUNTSINGLEPLAN' => '',
+          'HEALTHSAVINGSACCOUNTFAMILYPLAN' => '',
+          'ROTH401KREITREMENTPLAN' => '',
+          'ROTH403BRETIREMENTPLAN' => '',
+          'SECTION125PLAN' => '',
+          'SIMPLEIRARETIREMENTPLAN' => '',
+          '401KRETIREMENTPLAN' => '',
+          '403BRETIREMENTPLAN' => '',
+          '457RETIREMENTPLAN' => ''
+        } unless defined?(BENEFIT_CATEGORIES)
+
+        set_primary_key :benefit_type_id
+
+        guid    :benefit_type_id
+        string  :benefit_type
+        string  :benefit_category
+        string  :liability_account_code
+        string  :expense_account_code
+        decimal :standard_amount
+        decimal :company_max
+        decimal :percentage
+        boolean :show_balance_on_paystub
+
+        validates_inclusion_of :benefit_category, :in => BENEFIT_CATEGORIES
+
+      end
+    end
+  end
+end

data/lib/xeroizer/models/payroll/deduction_line.rb

@@ -0,0 +1,32 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class DeductionLineModel < PayrollBaseModel
+
+      end
+
+      class DeductionLine < PayrollBase
+
+        DEDUCTION_TYPE_CALCULATION_TYPE = {
+          'FIXEDAMOUNT' => '',
+          'PRETAX' => '',
+          'POSTTAX' => ''
+        } unless defined?(DEDUCTION_TYPE_CALCULATION_TYPE)
+
+        guid          :deduction_type_id, :api_name => 'DeductionTypeID'
+        string        :calculation_type
+
+        decimal :percentage
+        decimal :amount
+
+        # US Payroll fields
+        decimal :employee_max
+
+        validates_presence_of :earning_rate_id, :calculation_type, :unless => :new_record?
+        validates_inclusion_of :calculation_type, :in => DEDUCTION_TYPE_CALCULATION_TYPE
+      end
+
+    end
+  end
+end