Class: PayrollRun

Inherits:
Object
  • Object
show all
Defined in:
app/models/payroll_run.rb

Class Method Summary collapse

Class Method Details

.compute_payroll(transaction_header_id:, user_name:, reset_prior_to_generate: false, payroll_transaction_detail_id: 0) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'app/models/payroll_run.rb', line 79

def compute_payroll(
  transaction_header_id:,
  user_name:, reset_prior_to_generate: false,
  payroll_transaction_detail_id: 0
)
  PayrollTransactionHeader.transaction_details(
    transaction_header_id: transaction_header_id,
    user_name: user_name
  )
  PayrollTransactionHeader.generate_payroll(
    payroll_transaction_header_id: transaction_header_id.to_i,
    payroll_transaction_detail_id: payroll_transaction_detail_id,
    reset_prior_to_generate: reset_prior_to_generate,
    user_name: user_name
  )
end

.create_transaction(payroll_period:, user_name:, recompute: true) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
 
# File 'app/models/payroll_run.rb', line 171

def create_transaction(payroll_period:, user_name:, recompute: true)
  scheduled_deposit_date = payroll_period.latest_deposit_date

  transaction_header_id = payroll_period.create_transaction(
    scheduled_deposit_date: scheduled_deposit_date,
    user_name: user_name
  )[1][0]['payroll_transaction_header']
  compute_payroll(transaction_header_id: transaction_header_id, user_name: user_name) if recompute
  transaction_header_id
end

.process_step_1(payroll_period_id:, clone_from_payroll_period_id:, create_default_hours_per_week:, create_employees_default_hours_per_week:, default_hours_per_week:, user_name:) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'app/models/payroll_run.rb', line 31

def process_step_1(
  payroll_period_id:,
  clone_from_payroll_period_id:,
  create_default_hours_per_week:,
  create_employees_default_hours_per_week:,
  default_hours_per_week:,
  user_name:
)
  payroll_period = PayrollPeriod.find(payroll_period_id)

  clone_timesheets_result = {}
  if clone_from_payroll_period_id
    clone_timesheets_result = payroll_period.clone_timesheets(
      from_payroll_period_id: clone_from_payroll_period_id,
      create_default_hours_per_week: create_default_hours_per_week,
      create_employees_default_hours_per_week: create_employees_default_hours_per_week,
      default_hours_per_week: default_hours_per_week,
      user_name: user_name
    )
  end

  { clone_timesheets_result: clone_timesheets_result }
end

.process_step_2(payroll_period_id:, company:, user_name:, force_create_transaction: false, recompute: true) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'app/models/payroll_run.rb', line 55

def process_step_2(
  payroll_period_id:,
  # scheduled_deposit_date:,
  company:, user_name:,
  force_create_transaction: false,
  recompute: true
)
  previous_step_data = step_1_data(company: company)
  payroll_period = PayrollPeriod.find(payroll_period_id)

  if previous_step_data['CurrentOpenPayrollPeriodId'] == payroll_period_id.to_i && !force_create_transaction
    payroll_transaction_header_id = previous_step_data['Current_Open_Payroll_Transaction_Header_Id']
    PayrollTransactionHeader.find(payroll_transaction_header_id)
    unless PayrollTransactionHeader.find(payroll_transaction_header_id).payroll_transaction_details.exists?
      compute_payroll(transaction_header_id: payroll_transaction_header_id, user_name: user_name)
    end
    payroll_transaction_header_id
  elsif previous_step_data['Next_Payroll_Period_Id'] == payroll_period_id.to_i || force_create_transaction
    create_transaction(payroll_period: payroll_period, user_name: user_name, recompute: recompute)
  else
    payroll_period.payroll_transaction_header_ids&.first
  end
end

.process_step_4(payroll_transaction_header:, user_name:) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'app/models/payroll_run.rb', line 151

def process_step_4(payroll_transaction_header:, user_name:)
  payroll_transaction_header_id = payroll_transaction_header.payroll_transaction_header_id

  ActiveRecord::Base.execute_procedure(
    'pr_insert_payroll_transaction_header_log',
    payroll_transaction_header_id,
    PayrollTransactionHeader::STAGES[:SENT_FOR_APPROVAL],
    "Created by #{user_name}",
    user_name
  )

  # commenting out as notification is done when event is created
  # notify_user(payroll_transaction_header_id: payroll_transaction_header_id, user_name: user_name)
  ReferenceEvent.create(
    slug: ReferenceEvent::Slugs::UNREVIEWED_PAYROLL_TRANSACTION,
    reference: payroll_transaction_header,
    level: ReferenceEvent::Levels::WARN
  )
end

.step_1_data(company:) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'app/models/payroll_run.rb', line 3

def step_1_data(company:)
  result = ActiveRecord::Base.execute_procedure(
    'pr_run_and_schedule_payroll_step_1',
    company.company_id
  )[0]
  open_period_id = result['CurrentOpenPayrollPeriodId']
  next_period_id = result['Next_Payroll_Period_Id']

  period_id = [open_period_id, next_period_id, company.current_payroll_period_id].find { |id| id != 0 }
  period_option = open_period_id.zero? ? 'next_period' : 'open_period'
  period_info = PayrollPeriod
                .find_by(payroll_period_id: period_id)
                &.wizard_info(option: period_option)

  periods_with_timesheets = company.payroll_periods_data(must_have_timesheet: true, no_future: true)
  grouped_payroll_periods = Company.group_payroll_periods_by_year(periods_with_timesheets)
  default_payroll_period = periods_with_timesheets.first

  result.merge(
    grouped_payroll_periods: grouped_payroll_periods,
    default_payroll_period: default_payroll_period,
    company_name: company.company_name_e,
    default_hours_per_week: company.default_hours_per_week,

    period_option => period_info
  )
end

.step_4_data(transaction_header:, user_name:) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'app/models/payroll_run.rb', line 96

def step_4_data(transaction_header:, user_name:)
  ActiveRecord::Base.execute_procedure(
    'pr_generate_payroll_invoice',
    transaction_header.payroll_transaction_header_id,
    user_name
  )
  transaction_total = ActiveRecord::Base.execute_procedure(
    'pr_get_employee_payroll_transaction_total',
    transaction_header.payroll_transaction_header_id
  )[0] || {}
  net_salary = transaction_total.dig('net_salary')&.to_f&.abs
  [
    {
      name: 'company_name',
      label: I18n.t('payroll.payroll_run.review.company_name'),
      value: transaction_header.company.company_name_e
    },
    {
      name: 'employees_count',
      label: I18n.t('payroll.payroll_run.review.employees_count'),
      value: transaction_header.employees.count
    },
    {
      name: 'payroll_period',
      label: I18n.t('payroll.payroll_run.review.payroll_period'),
      value: transaction_header.payroll_period
    },
    {
      name: 'net_salary',
      label: I18n.t('payroll.transactions.headers.net_salaries'),
      value: net_salary
    },
    {
      name: 'remit_to_cra',
      label: I18n.t('payroll.transactions.headers.remit_to_cra'),
      value: transaction_total.dig('remit_to_cra')&.to_f&.abs
    },
    {
      name: 'remit_to_mrq',
      label: I18n.t('payroll.transactions.headers.remit_to_mrq'),
      value: transaction_total.dig('remit_to_mrq')&.to_f&.abs
    },
    {
      name: 'total_fees',
      label: I18n.t('payroll.payroll_run.review.platform_fees'),
      value: transaction_total.dig('total_fees')&.to_f&.abs
    },
    {
      name: 'total_to_be_debited_from_bank_account',
      label: I18n.t('payroll.payroll_run.review.total_to_be_debited'),
      value: calculate_total_debit(transaction_total)
    }
  ]
end