xeroizer 0.1.0

data/lib/xeroizer/models/contact.rb

@@ -0,0 +1,46 @@
+module Xeroizer
+  module Record
+    
+    class ContactModel < BaseModel
+            
+      set_permissions :read, :write, :update
+      
+    end
+    
+    class Contact < Base
+      
+      CONTACT_STATUS = {
+        'ACTIVE' =>     'Active',
+        'DELETED' =>    'Deleted'
+      } unless defined?(CONTACT_STATUS)
+      
+      set_primary_key :contact_id
+      set_possible_primary_keys :contact_id, :contact_number
+      
+      guid      :contact_id
+      string    :contact_number
+      string    :contact_status
+      string    :name
+      string    :tax_number
+      string    :bank_account_details
+      string    :accounts_receivable_tax_type
+      string    :accounts_payable_tax_type
+      string    :first_name
+      string    :last_name
+      string    :email_address
+      string    :contact_groups
+      string    :default_currency
+      datetime  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      boolean   :is_supplier
+      boolean   :is_customer
+      
+      has_many  :addresses
+      has_many  :phones
+      
+      validates_presence_of :name
+      validates_inclusion_of :contact_status, :in => CONTACT_STATUS.keys, :allow_blanks => true
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/credit_note.rb

@@ -0,0 +1,113 @@
+module Xeroizer
+  module Record
+    
+    class CreditNoteModel < BaseModel
+        
+      set_permissions :read, :write, :update
+      
+      public
+
+        # Retrieve the PDF version of the credit matching the `id`.
+        # @param [String] id invoice's ID.
+        # @param [String] filename optional filename to store the PDF in instead of returning the data.
+        def pdf(id, filename = nil)
+          pdf_data = @application.http_get(@application.client, "#{url}/#{CGI.escape(id)}", :response => :pdf)
+          if filename
+            File.open(filename, "w") { | fp | fp.write pdf_data }
+            nil
+          else
+            pdf_data
+          end
+        end
+      
+    end
+    
+    class CreditNote < Base
+      
+      CREDIT_NOTE_STATUS = {
+        'AUTHORISED' =>       'Approved credit_notes awaiting payment',
+        'DELETED' =>          'Draft credit_notes that are deleted',
+        'DRAFT' =>            'CreditNotes saved as draft or entered via API',
+        'PAID' =>             'CreditNotes approved and fully paid',
+        'SUBMITTED' =>        'CreditNotes entered by an employee awaiting approval',
+        'VOID' =>             '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'
+      } unless defined?(CREDIT_NOTE_TYPE)
+      CREDIT_NOTE_TYPES = CREDIT_NOTE_TYPE.keys.sort
+      
+      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
+      string    :type
+      date      :date
+      date      :due_date
+      string    :status
+      string    :line_amount_types
+      decimal   :sub_total, :calculated => true
+      decimal   :total_tax, :calculated => true
+      decimal   :total, :calculated => true
+      datetime  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      string    :currency_code
+      datetime  :fully_paid_on_date
+      
+      belongs_to  :contact
+      has_many    :line_items
+      
+      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
+      
+      public
+      
+        # 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
+          if new_record? || complete_record_downloaded?
+            sum = (line_items || []).inject(BigDecimal.new('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.
+            sum -= total_tax if line_amount_types == 'Inclusive' 
+            sum
+          else
+            attributes[:sub_total]
+          end
+        end
+      
+        # Calculate total_tax from line_items.
+        def total_tax
+          if new_record? || complete_record_downloaded?
+            (line_items || []).inject(BigDecimal.new('0')) { | sum, line_item | sum + line_item.tax_amount }
+          else
+            attributes[:total_tax]
+          end
+        end
+      
+        # Calculate the total from line_items.
+        def total
+          sub_total + total_tax
+        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
+              
+    end
+    
+  end
+end

data/lib/xeroizer/models/currency.rb

@@ -0,0 +1,18 @@
+module Xeroizer
+  module Record
+    
+    class CurrencyModel < BaseModel
+        
+      set_permissions :read
+      
+    end
+    
+    class Currency < Base
+      
+      string  :code
+      string  :description
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/invoice.rb

@@ -0,0 +1,138 @@
+module Xeroizer
+  module Record
+    
+    class InvoiceModel < BaseModel
+        
+      set_permissions :read, :write, :update
+      
+      public
+      
+        # Retrieve the PDF version of the invoice matching the `id`.
+        # @param [String] id invoice's ID.
+        # @param [String] filename optional filename to store the PDF in instead of returning the data.
+        def pdf(id, filename = nil)
+          pdf_data = @application.http_get(@application.client, "#{url}/#{CGI.escape(id)}", :response => :pdf)
+          if filename
+            File.open(filename, "w") { | fp | fp.write pdf_data }
+            nil
+          else
+            pdf_data
+          end
+        end
+      
+    end
+    
+    class Invoice < Base
+      
+      INVOICE_TYPE = {
+        'ACCREC' =>           'Accounts Receivable',
+        'ACCPAY' =>           'Accounts Payable'
+      } unless defined?(INVOICE_TYPE)
+      INVOICE_TYPES = INVOICE_TYPE.keys.sort
+
+      INVOICE_STATUS = {
+        'AUTHORISED' =>       'Approved invoices awaiting payment',
+        'DELETED' =>          'Draft invoices that are deleted',
+        'DRAFT' =>            'Invoices saved as draft or entered via API',
+        'PAID' =>             'Invoices approved and fully paid',
+        'SUBMITTED' =>        'Invoices entered by an employee awaiting approval',
+        'VOID' =>             'Approved invoices that are voided'
+      } unless defined?(INVOICE_STATUS)
+      INVOICE_STATUSES = INVOICE_STATUS.keys.sort
+      
+      LINE_AMOUNT_TYPE = {
+        "Inclusive" =>        'CreditNote lines are inclusive tax',
+        "Exclusive" =>        'CreditNote lines are exclusive of tax (default)',
+        "NoTax"     =>        'CreditNotes lines have no tax'
+      } unless defined?(LINE_AMOUNT_TYPE)
+      LINE_AMOUNT_TYPES = LINE_AMOUNT_TYPE.keys.sort
+      
+      set_primary_key :invoice_id
+      set_possible_primary_keys :invoice_id, :invoice_number
+      list_contains_summary_only true
+      
+      guid      :invoice_id
+      string    :invoice_number
+      string    :reference
+      guid      :branding_theme_id
+      string    :url
+      string    :type
+      date      :date
+      date      :due_date
+      string    :status
+      string    :line_amount_types
+      decimal   :sub_total, :calculated => true
+      decimal   :total_tax, :calculated => true
+      decimal   :total, :calculated => true
+      decimal   :amount_due
+      decimal   :amount_paid
+      decimal   :amount_credited
+      datetime  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      string    :currency_code
+      datetime  :fully_paid_on_date
+      
+      belongs_to  :contact
+      has_many    :line_items
+      has_many    :payments
+      
+      validates_presence_of :date, :due_date
+      validates_inclusion_of :type, :in => INVOICE_TYPES
+      validates_inclusion_of :status, :in => INVOICE_STATUSES
+      validates_inclusion_of :line_amount_types, :in => LINE_AMOUNT_TYPES
+      validates_associated :contact
+      validates_associated :line_items
+      
+      public
+            
+        # Helper method to check if the invoice is accounts payable.
+        def accounts_payable?
+          type == 'ACCPAY'
+        end
+
+        # Helper method to check if the invoice is accounts receivable.
+        def accounts_receivable?
+          type == 'ACCREC'
+        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
+          if new_record? || (!new_record? && line_items && line_items.size > 0)
+            sum = (line_items || []).inject(BigDecimal.new('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.
+            sum -= total_tax if line_amount_types == 'Inclusive' 
+            sum
+          else
+            attributes[:sub_total]
+          end
+        end
+
+        # Calculate total_tax from line_items.
+        def total_tax
+          if new_record? || (!new_record? && line_items && line_items.size > 0)
+            (line_items || []).inject(BigDecimal.new('0')) { | sum, line_item | sum + line_item.tax_amount }
+          else
+            attributes[:total_tax]
+          end
+        end
+
+        # Calculate the total from line_items.
+        def total
+          sub_total + total_tax
+        end
+        
+        # Retrieve the PDF version of this invoice.
+        # @param [String] filename optional filename to store the PDF in instead of returning the data.
+        def pdf(filename = nil)
+          parent.pdf(id, filename)
+        end
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/item.rb

@@ -0,0 +1,27 @@
+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
+      
+      belongs_to :purchase_details, :model_name => 'ItemPurchaseSaleDetails'
+      belongs_to :sales_details, :model_name => 'ItemPurchaseSaleDetails'
+      
+      validates_presence_of :code
+      
+    end
+    
+  end
+end

data/lib/xeroizer/models/item_purchase_sale_details.rb

@@ -0,0 +1,17 @@
+module Xeroizer
+  module Record
+    
+    class ItemPurchaseSaleDetailsModel < BaseModel
+        
+    end
+    
+    class ItemPurchaseSaleDetails < Base
+      
+      decimal :unit_price
+      string  :account_code
+      string  :tax_type
+       
+    end
+    
+  end
+end

data/lib/xeroizer/models/journal.rb

@@ -0,0 +1,25 @@
+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  :created_date_utc, :api_name => 'CreatedDateUTC'
+      string    :reference
+      
+      has_many  :journal_lines
+       
+    end
+    
+  end
+end

data/lib/xeroizer/models/journal_line.rb

@@ -0,0 +1,28 @@
+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
+
+      has_many :tracking_categories, :model_name => 'TrackingCategoryChild'
+       
+    end
+    
+  end
+end

data/lib/xeroizer/models/line_item.rb

@@ -0,0 +1,43 @@
+require 'xeroizer/models/account'
+
+module Xeroizer
+  module Record
+    
+    class LineItemModel < BaseModel
+        
+    end
+    
+    class LineItem < Base
+      
+      LINE_AMOUNT_TYPE = {
+        "Inclusive" =>        'CreditNote lines are inclusive tax',
+        "Exclusive" =>        'CreditNote lines are exclusive of tax (default)',
+        "NoTax"     =>        'CreditNotes lines have no tax'
+      } unless defined?(LINE_AMOUNT_TYPE)
+      LINE_AMOUNT_TYPES = LINE_AMOUNT_TYPE.keys.sort
+      
+      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
+      
+      has_many  :tracking, :model_name => 'TrackingCategoryChild'
+      
+      # Swallow assignment of attributes that should only be calculated automatically.
+      def line_amount=(value);  raise SettingTotalDirectlyNotSupported.new(:line_amount);   end
+      
+      # Calculate the line_total.
+      def line_amount
+        quantity * unit_amount
+      end
+      
+    end
+    
+  end
+end