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

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

@@ -0,0 +1,50 @@
+module Xeroizer
+  module Record
+    module Payroll
+    
+      class TaxDeclarationModel < PayrollBaseModel
+        set_xml_node_name 'TaxDeclaration'
+      end
+      
+      class TaxDeclaration < PayrollBase
+        
+        EMPLOYMENT_BASIS = {
+          'FULLTIME' => '',
+          'PARTTIME' => '',
+          'CASUAL' => '',
+          'LABOURHIRE' => '',
+          'SUPERINCOMESTREAM' => ''
+          
+        } unless defined?(EMPLOYMENT_BASIS)
+
+        TFN_EXEMPTION_TYPE = {
+          'NOTQUOTED' => 'Employee has not provided a TFN.',
+          'PENDING' => 'Employee has made a separate application or Enquiry to the ATO for a new or existing TFN.',
+          'PENSIONER' => 'Employee is claiming that they are in receipt of a pension, benefit or allowance.',
+          'UNDER18' => 'Employee is claiming an exemption as they are under the age of 18 and do not earn enough to pay tax.'
+        } unless defined?(TFN_EXEMPTION_TYPE)
+
+        string      :tax_file_number
+        
+        string      :tfn_exemption_type, :api_name => 'TFNExemptionType'
+        string      :employment_basis
+
+        boolean      :australian_resident_for_tax_purposes
+        boolean      :tax_free_threshold_claimed
+        boolean      :has_help_debt, :api_name => 'HasHELPDebt'
+        boolean      :has_sfss_debt, :api_name => 'HasSFSSDebt'
+        boolean      :eligible_to_receive_leave_loading
+
+        decimal      :tax_offset_estimated_amount
+        decimal      :upward_variation_tax_withholding_amount
+        decimal      :approved_withholding_variation_percentage
+
+        datetime_utc :updated_date_utc, :api_name => 'UpdatedDateUTC'
+        
+        validates_inclusion_of :employment_basis, :in => EMPLOYMENT_BASIS
+        validates_inclusion_of :tfn_exemption_type, :in => EMPLOYMENT_BASIS
+      end
+
+    end 
+  end
+end

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

@@ -0,0 +1,20 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class TimeOffLineModel < PayrollBaseModel
+
+      end
+
+      class TimeOffLine < PayrollBase
+
+        guid :time_off_type_id, :api_name => 'TimeOffTypeID'
+        decimal :hours
+        decimal :balance
+
+        validates_presence_of :time_off_type_id, :unless => :new_record?
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class TimeOffTypeModel < PayrollBaseModel
+
+        set_permissions :read
+
+      end
+
+      class TimeOffType < PayrollBase
+
+        TIME_OFF_CATEGORIES = {
+          'PAID' => '',
+          'UNPAID' => ''
+        } unless defined?(TIME_OFF_CATEGORIES)
+
+        set_primary_key :time_off_type_id
+
+        guid    :time_off_type_id
+        string  :time_off_type
+        string  :time_off_category
+        string  :expense_account_code
+        string  :liability_account_code
+        boolean :show_balance_to_employee
+
+        validates_inclusion_of :time_off_category, :in => TIME_OFF_CATEGORIES
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class WorkLocationModel < PayrollBaseModel
+
+      end
+
+      class WorkLocation < PayrollBase
+
+        guid        :work_location_id
+        boolean     :is_primary
+        string      :street_address
+        string      :suite_or_apt_or_unit
+        string      :city
+        string      :state
+        string      :zip
+        decimal     :latitude
+        decimal     :longitude
+
+        validates_presence_of :work_location_id, :unless => :new_record?
+      end
+    end
+  end
+end

data/lib/xeroizer/models/phone.rb

@@ -0,0 +1,26 @@
+module Xeroizer
+  module Record
+    
+    class PhoneModel < BaseModel
+            
+    end
+    
+    class Phone < Base
+      
+      PHONE_TYPE = {
+        'DEFAULT' =>    'Default',
+        'DDI' =>        'Direct Dial-In',
+        'MOBILE' =>     'Mobile',
+        'FAX' =>        'Fax'
+      } unless defined?(PHONE_TYPE)
+
+      string :phone_type, :internal_name => :type
+      string :phone_number, :internal_name => :number
+      string :phone_area_code, :internal_name => :area_code
+      string :phone_country_code, :internal_name => :country_code
+
+      validates_length_of :phone_number, :max => 50
+    end
+    
+  end
+end

data/lib/xeroizer/models/prepayment.rb

@@ -0,0 +1,41 @@
+module Xeroizer
+  module Record
+
+    class PrepaymentModel < BaseModel
+
+      set_xml_root_name 'Prepayments'
+      set_permissions :read
+
+    end
+
+    class Prepayment < Base
+      set_primary_key :prepayment_id
+
+      guid          :prepayment_id
+      date          :date
+      string        :status
+      string        :line_amount_types
+      decimal       :sub_total
+      decimal       :total_tax
+      decimal       :total
+      datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      string        :currency_code
+      datetime_utc  :fully_paid_on_date
+      string        :type
+      string        :reference
+      decimal       :currency_rate
+      decimal       :remaining_credit
+      decimal       :applied_amount
+      boolean       :has_attachments
+
+      belongs_to    :contact
+      has_many      :line_items
+      has_many      :payments
+
+      def contact_id
+        contact.id if contact
+      end
+
+    end
+  end
+end

data/lib/xeroizer/models/purchase_order.rb

@@ -0,0 +1,49 @@
+require "xeroizer/models/attachment"
+
+module Xeroizer
+  module Record
+    
+    class PurchaseOrderModel < BaseModel
+        
+      set_permissions :read, :write, :update
+
+      include AttachmentModel::Extensions
+    end
+    
+    class PurchaseOrder < Base
+      include Attachment::Extensions
+      
+      set_primary_key :purchase_order_id
+      set_possible_primary_keys :purchase_order_id
+      
+      guid    :purchase_order_id
+      string  :purchase_order_number
+      string  :date_string
+      date    :date
+      string  :delivery_date_string
+      date    :delivery_date
+      string  :delivery_address
+      string  :attention_to
+      string  :telephone
+      string  :delivery_instructions
+      boolean :has_errors 
+      boolean :is_discounted 
+      string  :reference
+      string  :type
+      decimal  :currency_rate
+      string  :currency_code
+      guid    :branding_theme_id 
+      string  :status 
+      string  :line_amount_types
+      decimal  :sub_total
+      decimal  :total_tax
+      decimal  :total 
+      datetime_utc :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      boolean :has_attachments
+
+      has_many     :line_items
+      belongs_to :contact, :model_name => 'Contact'      
+    end
+    
+  end
+end

data/lib/xeroizer/models/receipt.rb

@@ -0,0 +1,39 @@
+module Xeroizer
+  module Record
+    
+    class ReceiptModel < BaseModel
+        
+      set_permissions :read, :write, :update
+      
+      include AttachmentModel::Extensions
+
+    end
+    
+    class Receipt < Base
+      
+      include Attachment::Extensions
+      
+      set_primary_key :receipt_id
+      set_possible_primary_keys :receipt_id, :receipt_number
+
+      guid          :receipt_id
+      string        :receipt_number
+      string        :reference
+      string        :status
+      string        :line_amount_types
+      decimal       :sub_total, :calculated => true
+      decimal       :total_tax, :calculated => true
+      decimal       :total, :calculated => true
+      date          :date
+      string        :url
+      boolean       :has_attachments
+      datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+      
+      belongs_to    :user
+      belongs_to    :contact
+      has_many      :line_items
+
+    end
+    
+  end
+end

data/lib/xeroizer/models/repeating_invoice.rb

@@ -0,0 +1,80 @@
+require "xeroizer/models/attachment"
+
+module Xeroizer
+  module Record
+
+    class RepeatingInvoiceModel < BaseModel
+
+      set_permissions :read
+
+      include AttachmentModel::Extensions
+
+    end
+
+    class RepeatingInvoice < Base
+
+      INVOICE_TYPE = {
+        'ACCREC' => 'Accounts Receivable',
+        'ACCPAY' => 'Accounts Payable'
+      } unless defined?(INVOICE_TYPE)
+
+      INVOICE_STATUS = {
+        'AUTHORISED' => 'Approved invoices awaiting payment',
+        'DRAFT' =>      'Invoices saved as draft or entered via API',
+      } unless defined?(INVOICE_STATUS)
+
+      include Attachment::Extensions
+
+      set_primary_key :repeating_invoice_id
+      set_possible_primary_keys :repeating_invoice_id
+      list_contains_summary_only false
+
+      guid    :repeating_invoice_id
+      string  :reference
+      guid    :branding_theme_id
+      string  :type
+      string  :status
+      string  :line_amount_types
+      decimal :sub_total, :calculated => true
+      decimal :total_tax, :calculated => true
+      decimal :total, :calculated => true
+      string  :currency_code
+      boolean :has_attachments
+
+      belongs_to :contact
+      belongs_to :schedule
+      has_many   :line_items, :complete_on_page => true
+
+      public
+
+        # Access the contact name without forcing a download of
+        # an incomplete, summary invoice.
+        def contact_name
+          attributes[:contact] && attributes[:contact][:name]
+        end
+
+        # Access the contact ID without forcing a download of an
+        # incomplete, summary invoice.
+        def contact_id
+          attributes[:contact] && attributes[:contact][:contact_id]
+        end
+
+        # Helper method to check if the invoice has been approved.
+        def approved?
+          [ 'AUTHORISED' ].include? status
+        end
+
+        # 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
+
+    end
+
+  end
+end

data/lib/xeroizer/models/sales.rb

@@ -0,0 +1,13 @@
+module Xeroizer
+  module Record
+    
+    class SalesModel < BaseModel
+      set_permissions :read
+    end
+    
+    class Sales < Base
+      string :day
+      string :type
+    end
+  end
+end

data/lib/xeroizer/models/schedule.rb

@@ -0,0 +1,34 @@
+module Xeroizer
+  module Record
+
+    class ScheduleModel < BaseModel
+
+    end
+
+    class Schedule < Base
+
+      UNIT = {
+        'WEEKLY'  => 'Weekly',
+        'MONTHLY' => 'Monthly',
+        'YEARLY'  => 'Yearly',
+      } unless defined?(UNIT)
+
+      PAYMENT_TERM = {
+        'DAYSAFTERBILLDATE'  => 'day(s) after bill date',
+        'DAYSAFTERBILLMONTH' => 'day(s) after bill month',
+        'OFCURRENTMONTH'     => 'of the current month',
+        'OFFOLLOWINGMONTH'   => 'of the following month',
+      } unless defined?(PAYMENT_TERM)
+
+      integer :period
+      string  :unit
+      integer :due_date
+      string  :due_date_type
+      date    :start_date
+      date    :next_scheduled_date
+      date    :end_date
+
+    end
+
+  end
+end

data/lib/xeroizer/models/tax_component.rb

@@ -0,0 +1,13 @@
+module Xeroizer
+  module Record
+    class TaxComponentModel < BaseModel
+      set_permissions :read
+    end
+
+    class TaxComponent < Base
+      string      :name
+      decimal     :rate
+      boolean     :is_compound
+    end
+  end
+end

data/lib/xeroizer/models/tax_rate.rb

@@ -0,0 +1,36 @@
+module Xeroizer
+  module Record
+
+    class TaxRateModel < BaseModel
+
+      set_permissions :read
+
+      # TaxRates can be created using either POST or PUT.
+      # POST will also silently update the tax, which can
+      # be unexpected.  PUT is only for create.
+      def create_method
+        :http_put
+      end
+    end
+
+    class TaxRate < Base
+      set_primary_key :name
+      set_possible_primary_keys :tax_type, :name
+
+      string  :name
+      string  :tax_type
+      string  :report_tax_type # Read-only except for AU, NZ, and UK versions
+      string  :status
+      boolean :can_apply_to_assets
+      boolean :can_apply_to_equity
+      boolean :can_apply_to_expenses
+      boolean :can_apply_to_liabilities
+      boolean :can_apply_to_revenue
+      decimal :display_tax_rate
+      decimal :effective_rate
+
+      has_many :tax_components
+    end
+
+  end
+end