xeroizer-3-pre-beta 3.0.0.pre.beta

data/lib/xeroizer/models/invoice_reminder.rb

@@ -0,0 +1,19 @@
+module Xeroizer
+  module Record
+    
+    class InvoiceReminderModel < BaseModel
+      
+      set_api_controller_name 'InvoiceReminders/Settings'
+    
+      set_permissions :read 
+    
+    end
+    
+    class InvoiceReminder < Base
+
+      boolean   :enabled
+
+    end
+    
+  end
+end

data/lib/xeroizer/models/item.rb

@@ -0,0 +1,39 @@
+module Xeroizer
+  module Record
+    
+    class ItemModel < BaseModel
+        
+      set_permissions :read, :write, :update
+      
+    end
+    
+    class Item < Base
+      
+      set_primary_key :item_id
+      set_possible_primary_keys :item_id, :code
+      
+      guid    :item_id
+      string  :code
+      string  :description
+      string  :purchase_description
+      string  :name
+
+      decimal :total_cost_pool # read only
+      decimal :quantity_on_hand # read only
+
+      boolean :is_sold # can be set to false, only if description, and sales_details are nil
+      boolean :is_purchased # can be set to false, only if purchase_description, and purchase_details are nil
+      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'
+      
+      validates_presence_of :code
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/item_purchase_details.rb

@@ -0,0 +1,20 @@
+module Xeroizer
+  module Record
+    
+    class ItemPurchaseDetailsModel < BaseModel
+        
+      set_xml_node_name 'PurchaseDetails'
+        
+    end
+    
+    class ItemPurchaseDetails < Base
+      
+      decimal :unit_price
+      string  :account_code
+      string  :tax_type
+      string  :cogs_account_code, api_name: 'COGSAccountCode'
+
+    end
+    
+  end
+end

data/lib/xeroizer/models/item_sales_details.rb

@@ -0,0 +1,19 @@
+module Xeroizer
+  module Record
+    
+    class ItemSalesDetailsModel < BaseModel
+        
+      set_xml_node_name 'SalesDetails'
+        
+    end
+    
+    class ItemSalesDetails < Base
+      
+      decimal :unit_price
+      string  :account_code
+      string  :tax_type
+       
+    end
+    
+  end
+end

data/lib/xeroizer/models/journal.rb

@@ -0,0 +1,27 @@
+module Xeroizer
+  module Record
+    
+    class JournalModel < BaseModel
+        
+      set_permissions :read
+      
+    end
+    
+    class Journal < Base
+      
+      set_primary_key :journal_id
+      
+      guid      :journal_id
+      date      :journal_date, :internal_name => :date
+      string    :journal_number
+      datetime_utc  :created_date_utc, :api_name => 'CreatedDateUTC'
+      string    :reference
+      guid      :source_id
+      string    :source_type
+      
+      has_many  :journal_lines
+       
+    end
+    
+  end
+end

data/lib/xeroizer/models/journal_line.rb

@@ -0,0 +1,29 @@
+module Xeroizer
+  module Record
+    
+    class JournalLineModel < BaseModel
+        
+    end
+    
+    class JournalLine < Base
+      
+      set_primary_key :journal_line_id
+      
+      guid     :journal_line_id
+      guid     :account_id
+      string   :account_code
+      string   :account_type
+      string   :account_name
+      decimal  :net_amount
+      decimal  :gross_amount
+      decimal  :tax_amount
+      string   :tax_type
+      string   :tax_name
+      string   :description
+
+      has_many :tracking_categories, :model_name => 'JournalLineTrackingCategory'
+       
+    end
+    
+  end
+end

data/lib/xeroizer/models/journal_line_tracking_category.rb

@@ -0,0 +1,21 @@
+module Xeroizer
+  module Record
+    
+    class JournalLineTrackingCategoryModel < BaseModel
+    
+      set_xml_root_name 'TrackingCategories'
+      set_xml_node_name 'TrackingCategory'
+      
+    end
+    
+    class JournalLineTrackingCategory < Base
+      
+      string  :name
+      string  :option
+      guid    :tracking_category_id
+      guid    :tracking_option_id
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/line_amount_type.rb

@@ -0,0 +1,11 @@
+module Xeroizer
+  module Record
+    line_amount_type = {
+      "Inclusive" => 'Line item amounts are inclusive of tax',
+      "Exclusive" => 'Line item amounts are exclusive of tax (default)',
+      "NoTax"     => 'Line item amounts have no tax'
+    }
+
+    LINE_AMOUNT_TYPES = line_amount_type.keys.sort
+  end
+end

data/lib/xeroizer/models/line_item.rb

@@ -0,0 +1,64 @@
+require 'xeroizer/models/account'
+require 'xeroizer/models/line_amount_type'
+
+module Xeroizer
+  module Record
+    class LineItemModel < BaseModel
+      set_permissions
+    end
+
+    class LineItem < Base
+      TAX_TYPE = Account::TAX_TYPE unless defined?(TAX_TYPE)
+
+      string  :item_code
+      string  :description
+      decimal :quantity
+      decimal :unit_amount
+      string  :account_code
+      string  :tax_type
+      decimal :tax_amount
+      decimal :line_amount, :calculated => true
+      decimal :discount_rate
+      decimal :discount_amount
+      string  :line_item_id
+
+      has_many  :tracking, :model_name => 'TrackingCategoryChild'
+
+      def initialize(parent)
+        super(parent)
+        @line_amount_set = false
+      end
+
+      def line_amount=(line_amount)
+        @line_amount_set = true
+        attributes[:line_amount] = line_amount
+      end
+
+      # Calculate the line_total (if there is a quantity and unit_amount).
+      # Description-only lines have been allowed since Xero V2.09.
+      def line_amount(summary_only = false)
+        return attributes[:line_amount] if summary_only || @line_amount_set
+
+        if quantity && unit_amount
+          total = coerce_numeric(quantity) * coerce_numeric(unit_amount)
+          if discount_rate.nonzero?
+            BigDecimal((total * ((100 - discount_rate) / 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/line_item_sum.rb

@@ -0,0 +1,21 @@
+module Xeroizer
+  module Record
+    class LineItemSum
+      def self.total(line_items)
+        sub_total(line_items) + total_tax(line_items)
+      end
+
+      def self.sub_total(line_items)
+        line_items.inject(BigDecimal("0")) do |sum, item|
+          sum += BigDecimal(item.line_amount.to_s).round(2)
+        end
+      end
+
+      def self.total_tax(line_items)
+        line_items.inject(BigDecimal("0")) do |sum, item|
+          sum += BigDecimal(item.tax_amount.to_s).round(2)
+        end
+      end
+    end
+  end
+end

data/lib/xeroizer/models/manual_journal.rb

@@ -0,0 +1,49 @@
+require "xeroizer/models/attachment"
+
+module Xeroizer
+  module Record
+    
+    class ManualJournalModel < BaseModel
+        
+      set_permissions :read, :write, :update
+
+      include AttachmentModel::Extensions
+                  
+    end
+    
+    class ManualJournal < Base
+      
+      JOURNAL_STATUS = {
+        'DRAFT' =>      'Draft',
+        'POSTED' =>     'Posted'
+      } unless defined?(JOURNAL_STATUS)
+      JOURNAL_STATUSES = JOURNAL_STATUS.keys.sort
+
+      include Attachment::Extensions
+            
+      set_primary_key :manual_journal_id
+      set_possible_primary_keys :manual_journal_id
+      list_contains_summary_only true
+      
+      guid          :manual_journal_id
+      date          :date
+      string        :status
+      string        :line_amount_types
+      string        :narration
+      string        :url
+      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
+      validates_associated :journal_lines
+            
+      public
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/manual_journal_line.rb

@@ -0,0 +1,28 @@
+module Xeroizer
+  module Record
+    
+    class ManualJournalLineModel < BaseModel
+                    
+      set_xml_root_name 'JournalLines'
+      set_xml_node_name 'JournalLine'
+                    
+    end
+    
+    class ManualJournalLine < Base
+
+      string    :description
+      string    :tax_type
+      string    :account_code
+      decimal   :line_amount
+      decimal   :tax_amount
+      
+      has_many  :tracking, :model_name => 'TrackingCategoryChild'
+
+      validates_presence_of :account_code, :line_amount      
+            
+      public
+      
+    end
+    
+  end
+end

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

@@ -0,0 +1,18 @@
+module Xeroizer
+  module Record
+    
+    class OptionModel < BaseModel
+            
+    end
+    
+    class Option < Base
+      
+      set_primary_key :tracking_option_id
+      
+      guid   :tracking_option_id
+      string :name
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/organisation.rb

@@ -0,0 +1,85 @@
+require "xeroizer/models/payment_terms"
+module Xeroizer
+  module Record
+    
+    class OrganisationModel < BaseModel
+    
+      set_api_controller_name 'Organisation'
+      set_permissions :read
+      
+    end
+    
+    class Organisation < Base
+      
+      SALES_TAX_BASIS = {
+        'NZ' => 
+          {'PAYMENTS' => 'Payments Basis',
+           'INVOICE' => 'Invoice Basis',
+           'NONE' => 'None'},
+        'GB' => 
+          {
+            'CASH' => 'Cash Scheme',
+            'ACCRUAL' => 'Accrual Scheme',
+            'FLATRATECASH' => 'Flate Rate Cash Scheme',
+            'NONE' => 'None'
+          },
+        'GLOBAL' =>
+          {
+            'CASH' => 'Cash Basis',
+            'ACCRUALS' => 'Accruals Basis',
+            'NONE' => 'None'
+          }
+      } unless defined?(SALES_TAX_BASES)
+
+      SALES_TAX_BASES = SALES_TAX_BASIS.values.map(&:keys).flatten.sort
+      
+      string    :api_key, :api_name => 'APIKey'
+      string    :name
+      string    :legal_name
+      string    :short_code
+      string    :organisation_id
+      boolean   :pays_tax
+      string    :version
+      string    :organisation_type
+      string    :organisation_entity_type
+      string    :line_of_business
+      string    :base_currency
+      string    :country_code
+      boolean   :is_demo_company
+      string    :organisation_status
+      integer   :financial_year_end_day
+      integer   :financial_year_end_month
+      string    :sales_tax_basis
+      string    :sales_tax_period
+      date      :period_lock_date
+      date      :end_of_year_lock_date
+      string    :tax_number
+      string    :registration_number
+      string    :timezone
+      datetime_utc  :created_date_utc, :api_name => 'CreatedDateUTC'
+      string    :sales_tax_basis
+      string    :sales_tax_period
+
+      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
+        if sales_tax_basis
+
+          valid_bases = (SALES_TAX_BASIS[country_code] || SALES_TAX_BASIS['GLOBAL']).keys
+
+          unless valid_bases.include?(sales_tax_basis)
+            valid = false
+          end
+        end
+        
+        valid
+      end
+
+    end
+    
+  end
+end