xeroizer 2.17.1 → 3.0.0

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

@@ -0,0 +1,49 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class DeductionTypeModel < PayrollBaseModel
+
+        set_permissions :read
+
+      end
+
+      class DeductionType < PayrollBase
+
+        DEDUCTION_CATEGORIES = {
+          'AFTERTAXDEDUCTION' => '',
+          'DEPENDENTCARE' => '',
+          'FLEXIBLESPENDINGACCOUNT' => '',
+          'HEALTHSAVINGSACCOUNTSINGLEPLAN' => '',
+          'HEALTHSAVINGSACCOUNTFAMILYPLAN' => '',
+          'ROTH401KREITREMENTPLAN' => '',
+          'ROTH403BRETIREMENTPLAN' => '',
+          'SECTION125PLAN' => '',
+          'SIMPLEIRARETIREMENTPLAN' => '',
+          '401KRETIREMENTPLAN' => '',
+          '403BRETIREMENTPLAN' => '',
+          '457RETIREMENTPLAN' => ''
+        } unless defined?(DEDUCTION_CATEGORIES)
+
+        CALCULATION_TYPES = {
+          'CATCHUPPLAN' => '',
+          'STANDARDPLAN' => ''
+        } unless defined?(CALCULATION_TYPES)
+
+        set_primary_key :deduction_type_id
+
+        guid    :deduction_type_id
+        string  :deduction_type
+        string  :deduction_category
+        string  :calculation_type
+        string  :liability_account_code
+        decimal :standard_amount
+        decimal :company_max
+
+        validates_inclusion_of :deduction_category, :in => DEDUCTION_CATEGORIES
+        validates_inclusion_of :calculation_type, :in => CALCULATION_TYPES
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class EarningsLineModel < PayrollBaseModel
+
+      end
+
+      class EarningsLine < PayrollBase
+
+        EARNINGS_RATE_CALCULATION_TYPE = {
+          'USEEARNINGSRATE' => 'Use the rate per unit recorded for the earnings rate under Settings',
+          'ENTEREARNINGSRATE' => 'The rate per unit is be added manually to the earnings line',
+          'ANNUALSALARY' => 'If the employee receives a salary, the annual salary amount and units of work per week are added to the earnings line'
+        } unless defined?(EARNINGS_RATE_CALCULATION_TYPE)
+
+        guid          :earning_rate_id, :api_name => 'EarningsRateID'
+        string        :calculation_type
+
+        decimal       :number_of_units_per_week
+        decimal       :annual_salary
+        decimal       :rate_per_unit
+        decimal       :normal_number_of_units
+
+        # US Payroll fields
+        guid          :earnings_type_id
+        decimal       :units_or_hours
+        decimal       :amount
+        decimal       :fixed_amount
+        decimal       :number_of_units
+
+        validates_presence_of :earning_rate_id, :if => Proc.new { |el| el.earnings_type_id.blank? }
+        validates_presence_of :earnings_type_id, :if => Proc.new { |el| el.earning_rate_id.blank? }
+        validates_inclusion_of :calculation_type, :in => EARNINGS_RATE_CALCULATION_TYPE, :unless => :new_record?
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class EarningsTypeModel < PayrollBaseModel
+
+        set_permissions :read
+
+      end
+
+      class EarningsType < PayrollBase
+
+        EARNINGS_CATEGORIES = {
+          'REGULAREARNINGS' => '',
+          'OVERTIMEEARNINGS' => '',
+          'ALLOWANCE' => '',
+          'COMMISSION' => '',
+          'BONUS' => '',
+          'CASHTIPS' => '',
+          'NONCASHTIPS' => '',
+          'ADDITIONALEARNINGS' => '',
+          'RETROACTIVEPAY' => '',
+          'CLERGYHOUSINGALLOWANCE' => '',
+          'CLERGYHOUSINGINKIND' => ''
+        } unless defined?(EARNINGS_CATEGORIES)
+
+        RATE_TYPES = {
+          'FIXEDAMOUNT' => '',
+          'MULTIPLE' => '',
+          'RATEPERUNIT' => ''
+        } unless defined?(RATE_TYPES)
+
+        set_primary_key :earnings_type_id
+
+        guid    :earnings_type_id
+        guid    :earnings_rate_id
+        string  :earnings_type
+        string  :expense_account_code
+        string  :earnings_category
+        string  :rate_type
+        string  :type_of_units
+        decimal :multiple
+        boolean :do_not_accrue_time_off
+        boolean :is_supplemental
+        decimal :amount
+
+        validates_inclusion_of :earnings_category, :in => EARNINGS_CATEGORIES
+        validates_inclusion_of :rate_type, :in => RATE_TYPES
+
+      end
+    end
+  end
+end

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

@@ -1,15 +1,18 @@
 module Xeroizer
   module Record
     module Payroll
-    
+
       class EmployeeModel < PayrollBaseModel
-          
+
         set_permissions :read, :write, :update
-          
+
+        def create_method
+          :http_post
+        end
       end
-      
+
       class Employee < PayrollBase
-        
+
         set_primary_key :employee_id
 
         guid          :employee_id
@@ -34,12 +37,31 @@ module Xeroizer
         string        :employee_group_name
         date          :termination_date
         datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
-  
-        belongs_to    :home_address, :internal_name_singular => "home_address", :model_name => "HomeAddress"
+
+        has_one       :home_address, :internal_name_singular => "home_address", :model_name => "HomeAddress"
+        has_one       :tax_declaration, :internal_name_singular => "tax_declaration", :model_name => "TaxDeclaration"
+        has_one       :pay_template, :internal_name_singular => "pay_template", :model_name => "PayTemplate"
         has_many      :bank_accounts
 
+        # US Payroll fields
+        string        :job_title
+        string        :employee_number
+        string        :social_security_number
+        guid          :pay_schedule_id
+        string        :employment_basis
+        guid          :holiday_group_id
+        boolean       :is_authorised_to_approve_time_off
+
+        has_many      :salary_and_wages
+        has_many      :work_locations
+        has_one       :payment_method, :model_name => "PaymentMethod"
+        has_one       :mailing_address, :internal_name_singular => "mailing_address", :model_name => "MailingAddress"
+
+        validates_presence_of :first_name, :last_name, :unless => :new_record?
+        validates_presence_of :date_of_birth
+        validates_presence_of :pay_schedule_id, :if => Proc.new { | record | !record.salary_and_wages.blank? }
       end
 
-    end 
+    end
   end
 end

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

@@ -0,0 +1,27 @@
+module Xeroizer
+  module Record
+    module Payroll
+      class LeaveApplicationModel < PayrollBaseModel
+        set_permissions :read, :write, :update
+      end
+
+      class LeaveApplication < PayrollBase
+        set_primary_key :leave_application_id
+
+        guid          :leave_application_id
+        guid          :employee_id
+        guid          :leave_type_id
+
+        string        :title
+        date          :start_date
+        date          :end_date
+
+        string        :description
+
+        has_many      :leave_periods
+
+        validates_presence_of :employee_id, :leave_type_id, :title, :start_date, :end_date
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class LeaveLineModel < PayrollBaseModel
+
+      end
+
+      class LeaveLine < PayrollBase
+
+        LEAVE_TYPE_CALCULATION_TYPE = {
+          'FIXEDAMOUNTEACHPERIOD' => 'You can enter a manually calculated rate for the accrual, accrue a fixed amount of leave each pay period based on an annual entitlement (for example, if you pay your employees monthly, you would accrue 1/12th of their annual entitlement each month), or accrue an amount relative to the number of hours an employee worked in the pay period',
+          'ENTERRATEINPAYTEMPLATE' => '',
+          'BASEDONORDINARYEARNINGS' => ''
+        } unless defined?(LEAVE_TYPE_CALCULATION_TYPE)
+
+        guid :leave_type_id, :api_name => 'LeaveTypeID'
+        string :calculation_type
+
+        decimal :annual_number_of_units
+        decimal :full_time_number_of_units_per_period
+        decimal :number_of_units
+
+        validates_presence_of :leave_type_id, :calculation_type, :unless => :new_record?
+        validates_inclusion_of :calculation_type, :in => LEAVE_TYPE_CALCULATION_TYPE
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Xeroizer
+  module Record
+    module Payroll
+      class LeavePeriodModel < PayrollBaseModel
+      end
+
+      class LeavePeriod < PayrollBase
+        decimal     :number_of_units
+        date        :pay_period_start_date
+        date        :pay_period_end_date
+        string      :leave_period_status
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class PayItemsModel < PayrollBaseModel
+
+        set_permissions :read
+
+      end
+
+      class PayItems < PayrollBase
+
+        has_many      :earnings_types
+        has_many      :benefit_types
+        has_many      :deduction_types
+        has_many      :reimbursement_types
+        has_many      :time_off_types
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class PayRunModel < PayrollBaseModel
+
+        set_permissions :read, :write, :update
+
+      end
+
+      class PayRun < PayrollBase
+
+        set_primary_key :pay_run_id
+
+        guid :pay_run_id
+        guid :pay_schedule_id
+        date :pay_run_period_end_date
+        string :pay_run_status
+        date :pay_run_period_start_date
+        date :payment_date
+        decimal :earnings
+        decimal :deductions
+        decimal :reimbursement
+        decimal :net_pay
+        decimal :tax
+        datetime_utc :updated_date_utc, :api_name => 'UpdatedDateUTC'
+
+        has_many :paystubs
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class PayScheduleModel < PayrollBaseModel
+
+        set_permissions :read, :write, :update
+
+        def create_method
+          :http_post
+        end
+      end
+
+      class PaySchedule < PayrollBase
+
+        SCHEDULE_TYPES = {
+          'WEEKLY' => 'Once per week on the same Day each week',
+          'MONTHLY' => 'Once a month on the same Day each month',
+          'BIWEEKLY' => 'Every 14 days on the same Day each period',
+          'QUARTERLY' => 'Once a quarter on the same Day',
+          'SEMIMONTHLY' => 'Twice a month on the same 2 Days each period',
+          'FOURWEEKLY' => '',
+          'YEARLY' => ''
+        } unless defined?(SCHEDULE_TYPES)
+
+        set_primary_key :pay_schedule_id
+
+        guid :pay_schedule_id
+        string :pay_schedule_name
+        date :payment_date
+        date :start_date
+        string :schedule_type
+
+        validates_presence_of :pay_schedule_name, :payment_date,
+          :start_date, :schedule_type, :unless => :new_record?
+        validates_inclusion_of :schedule_type, :in => SCHEDULE_TYPES
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class PayTemplateModel < PayrollBaseModel
+
+      end
+
+      class PayTemplate < PayrollBase
+
+        has_many      :earnings_lines
+        has_many      :deduction_lines
+        has_many      :super_lines
+        has_many      :reimbursement_lines
+        has_many      :leave_lines
+
+        # US Payroll fields
+        has_many      :benefit_lines
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class PaymentMethodModel < PayrollBaseModel
+
+      end
+
+      class PaymentMethod < PayrollBase
+
+        PAYMENT_METHOD_TYPE = {
+          'CHECK' => '',
+          'MANUAL' => '',
+          'DIRECTDEPOSIT' => ''
+        } unless defined?(PAYMENT_METHOD_TYPE)
+
+        string    :payment_method_type
+        has_many  :bank_accounts
+
+        validates_inclusion_of :payment_method_type, :in => PAYMENT_METHOD_TYPE
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class PaystubModel < PayrollBaseModel
+
+        set_permissions :read, :write, :update
+
+      end
+
+      class Paystub < PayrollBase
+
+        set_primary_key :paystub_id
+
+        guid          :paystub_id
+        guid          :employee_id
+        guid          :pay_run_id
+        string        :first_name
+        string        :last_name
+        datetime      :last_edited
+        decimal       :earnings
+        decimal       :deductions
+        decimal       :tax
+        decimal       :reimbursements
+        decimal       :net_pay
+        datetime_utc  :updated_date_utc, :api_name => 'UpdatedDateUTC'
+        date          :payment_date
+
+        has_many      :earnings_lines
+        has_many      :leave_earnings_lines, :model_name => 'EarningsLine'
+        has_many      :timesheet_earnings_lines, :model_name => 'EarningsLine'
+        has_many      :deduction_lines
+        has_many      :reimbursement_lines
+        has_many      :benefit_lines
+        has_many      :time_off_lines
+
+        belongs_to    :pay_run
+
+        validates_presence_of :paystub_id, :unless => :new_record?
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Xeroizer
+  module Record
+    module Payroll
+    
+      class ReimbursementLineModel < PayrollBaseModel
+          
+      end
+      
+      class ReimbursementLine < PayrollBase
+        
+        guid :reimbursement_type_id, :api_name => 'ReimbursementTypeID'
+
+        string :description
+        decimal :amount
+        
+        validates_presence_of :reimbursement_type_id, :unless => :new_record?
+      end
+
+    end 
+  end
+end

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

@@ -0,0 +1,22 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class ReimbursementTypeModel < PayrollBaseModel
+
+        set_permissions :read
+
+      end
+
+      class ReimbursementType < PayrollBase
+
+        set_primary_key :reimbursement_type_id
+
+        guid    :reimbursement_type_id
+        string  :reimbursement_type
+        string  :expense_or_liability_account_code
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Xeroizer
+  module Record
+    module Payroll
+
+      class SalaryAndWageModel < PayrollBaseModel
+
+      end
+
+      class SalaryAndWage < PayrollBase
+
+        SALARY_AND_WAGE_TYPE = {
+          'HOURLY' => '',
+          'SALARY' => ''
+        } unless defined?(SALARY_AND_WAGE_TYPE)
+
+        guid          :salary_and_wages_id
+        guid          :earnings_type_id
+        string        :salary_wages_type
+        decimal       :hourly_rate
+        decimal       :annual_salary
+        decimal       :standard_hours_per_week
+        datetime      :effective_date
+
+        validates_presence_of :salary_and_wage_id, :unless => :new_record?
+        validates_inclusion_of :salary_wages_type, :in => SALARY_AND_WAGE_TYPE
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Xeroizer
+  module Record
+    module Payroll
+    
+      class SuperLineModel < PayrollBaseModel
+          
+      end
+      
+      class SuperLine < PayrollBase
+
+        SUPERANNUATION_CONTRIBUTION_TYPE = {
+          'SGC' => 'Mandatory 9% contribution',
+          'SALARYSACRIFICE' => 'Pre-tax reportable employer superannuation contribution, which is displayed separately on payment summaries',
+          'EMPLOYERADDITIONAL' => 'Additional employer superannuation contribution, which is displayed as RESC on payment summaries',
+          'EMPLOYEE' => 'Post-tax employee superannuation contribution'
+        } unless defined?(SUPERANNUATION_CONTRIBUTION_TYPE)
+        
+        SUPERANNUATION_CALCULATION_TYPE = {
+          'FIXEDAMOUNT' => 'For voluntary superannuation, the contribution amount can be a fixed rate or a percentage of earnings. For SGC contributions it must be a percentage',
+          'PERCENTAGEOFEARNINGS' => '',
+          'STATUTORY' => ''
+        } unless defined?(SUPERANNUATION_CALCULATION_TYPE)
+
+        guid  :super_membership_id, :api_name => 'SuperMembershipID'
+        string  :contribution_type
+        string  :calculation_type
+        integer :expense_account_code
+        integer :liability_account_code
+
+        decimal :minimum_monthly_earnings
+        decimal :percentage
+
+        validates_presence_of :super_membership_id, :contribution_type, :calculation_type, :expense_account_code, :liability_account_code, :unless => :new_record?
+        validates_inclusion_of :contribution_type, :in => SUPERANNUATION_CONTRIBUTION_TYPE
+        validates_inclusion_of :calculation_type, :in => SUPERANNUATION_CALCULATION_TYPE
+      end
+
+    end 
+  end
+end

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