Class: Merge::Hris::EmployeePayrollRun

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/hris/types/employee_payroll_run.rb

Overview

# The EmployeePayrollRun Object

### Description
The `EmployeePayrollRun` object is used to represent an employee's pay statement
for a specific payroll run.
### Usage Example
Fetch from the `LIST EmployeePayrollRun` endpoint and filter by `ID` to show all
employee payroll runs.

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee: OMIT, payroll_run: OMIT, gross_pay: OMIT, net_pay: OMIT, start_date: OMIT, end_date: OMIT, check_date: OMIT, earnings: OMIT, deductions: OMIT, taxes: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil) ⇒ Merge::Hris::EmployeePayrollRun

Parameters:

  • id (String) (defaults to: OMIT)
  • remote_id (String) (defaults to: OMIT) —

    The third-party API ID of the matching object.

  • created_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was created by Merge.

  • modified_at (DateTime) (defaults to: OMIT) —

    The datetime that this object was modified by Merge.

  • employee (Merge::Hris::EmployeePayrollRunEmployee) (defaults to: OMIT) —

    The employee whose payroll is being run.

  • payroll_run (Merge::Hris::EmployeePayrollRunPayrollRun) (defaults to: OMIT) —

    The payroll being run.

  • gross_pay (Float) (defaults to: OMIT) —

    The total earnings throughout a given period for an employee before any deductions are made.

  • net_pay (Float) (defaults to: OMIT) —

    The take-home pay throughout a given period for an employee after deductions are made.

  • start_date (DateTime) (defaults to: OMIT) —

    The day and time the payroll run started.

  • end_date (DateTime) (defaults to: OMIT) —

    The day and time the payroll run ended.

  • check_date (DateTime) (defaults to: OMIT) —

    The day and time the payroll run was checked.

  • earnings (Array<Merge::Hris::Earning>) (defaults to: OMIT)
  • deductions (Array<Merge::Hris::Deduction>) (defaults to: OMIT)
  • taxes (Array<Merge::Hris::Tax>) (defaults to: OMIT)
  • remote_was_deleted (Boolean) (defaults to: OMIT) —

    Indicates whether or not this object has been deleted in the third party platform.

  • field_mappings (Hash{String => Object}) (defaults to: OMIT)
  • remote_data (Array<Merge::Hris::RemoteData>) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



90
91
92
93
94
95
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
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 90

def initialize(id: OMIT, remote_id: OMIT, created_at: OMIT, modified_at: OMIT, employee: OMIT, payroll_run: OMIT,
               gross_pay: OMIT, net_pay: OMIT, start_date: OMIT, end_date: OMIT, check_date: OMIT, earnings: OMIT, deductions: OMIT, taxes: OMIT, remote_was_deleted: OMIT, field_mappings: OMIT, remote_data: OMIT, additional_properties: nil)
  @id = id if id != OMIT
  @remote_id = remote_id if remote_id != OMIT
  @created_at = created_at if created_at != OMIT
  @modified_at = modified_at if modified_at != OMIT
  @employee = employee if employee != OMIT
  @payroll_run = payroll_run if payroll_run != OMIT
  @gross_pay = gross_pay if gross_pay != OMIT
  @net_pay = net_pay if net_pay != OMIT
  @start_date = start_date if start_date != OMIT
  @end_date = end_date if end_date != OMIT
  @check_date = check_date if check_date != OMIT
  @earnings = earnings if earnings != OMIT
  @deductions = deductions if deductions != OMIT
  @taxes = taxes if taxes != OMIT
  @remote_was_deleted = remote_was_deleted if remote_was_deleted != OMIT
  @field_mappings = field_mappings if field_mappings != OMIT
  @remote_data = remote_data if remote_data != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "id": id,
    "remote_id": remote_id,
    "created_at": created_at,
    "modified_at": modified_at,
    "employee": employee,
    "payroll_run": payroll_run,
    "gross_pay": gross_pay,
    "net_pay": net_pay,
    "start_date": start_date,
    "end_date": end_date,
    "check_date": check_date,
    "earnings": earnings,
    "deductions": deductions,
    "taxes": taxes,
    "remote_was_deleted": remote_was_deleted,
    "field_mappings": field_mappings,
    "remote_data": remote_data
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



61
62
63
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 61

def additional_properties
  @additional_properties
end

#check_date ⇒ DateTime (readonly)

Returns The day and time the payroll run was checked.

Returns:

  • (DateTime) —

    The day and time the payroll run was checked.



46
47
48
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 46

def check_date
  @check_date
end

#created_at ⇒ DateTime (readonly)

Returns The datetime that this object was created by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was created by Merge.



28
29
30
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 28

def created_at
  @created_at
end

#deductions ⇒ Array<Merge::Hris::Deduction> (readonly)

Returns:



50
51
52
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 50

def deductions
  @deductions
end

#earnings ⇒ Array<Merge::Hris::Earning> (readonly)

Returns:



48
49
50
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 48

def earnings
  @earnings
end

#employee ⇒ Merge::Hris::EmployeePayrollRunEmployee (readonly)

Returns The employee whose payroll is being run.

Returns:



32
33
34
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 32

def employee
  @employee
end

#end_date ⇒ DateTime (readonly)

Returns The day and time the payroll run ended.

Returns:

  • (DateTime) —

    The day and time the payroll run ended.



44
45
46
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 44

def end_date
  @end_date
end

#field_mappings ⇒ Hash{String => Object} (readonly)

Returns:

  • (Hash{String => Object}) 


57
58
59
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 57

def field_mappings
  @field_mappings
end

#gross_pay ⇒ Float (readonly)

Returns The total earnings throughout a given period for an employee before any deductions are made.

Returns:

  • (Float) —

    The total earnings throughout a given period for an employee before any deductions are made.



37
38
39
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 37

def gross_pay
  @gross_pay
end

#id ⇒ String (readonly)

Returns:

  • (String) 


24
25
26
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 24

def id
  @id
end

#modified_at ⇒ DateTime (readonly)

Returns The datetime that this object was modified by Merge.

Returns:

  • (DateTime) —

    The datetime that this object was modified by Merge.



30
31
32
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 30

def modified_at
  @modified_at
end

#net_pay ⇒ Float (readonly)

Returns The take-home pay throughout a given period for an employee after deductions are made.

Returns:

  • (Float) —

    The take-home pay throughout a given period for an employee after deductions are made.



40
41
42
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 40

def net_pay
  @net_pay
end

#payroll_run ⇒ Merge::Hris::EmployeePayrollRunPayrollRun (readonly)

Returns The payroll being run.

Returns:



34
35
36
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 34

def payroll_run
  @payroll_run
end

#remote_data ⇒ Array<Merge::Hris::RemoteData> (readonly)

Returns:



59
60
61
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 59

def remote_data
  @remote_data
end

#remote_id ⇒ String (readonly)

Returns The third-party API ID of the matching object.

Returns:

  • (String) —

    The third-party API ID of the matching object.



26
27
28
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 26

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Boolean (readonly)

Returns Indicates whether or not this object has been deleted in the third party platform.

Returns:

  • (Boolean) —

    Indicates whether or not this object has been deleted in the third party platform.



55
56
57
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 55

def remote_was_deleted
  @remote_was_deleted
end

#start_date ⇒ DateTime (readonly)

Returns The day and time the payroll run started.

Returns:

  • (DateTime) —

    The day and time the payroll run started.



42
43
44
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 42

def start_date
  @start_date
end

#taxes ⇒ Array<Merge::Hris::Tax> (readonly)

Returns:



52
53
54
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 52

def taxes
  @taxes
end

Class Method Details

.from_json(json_object:) ⇒ Merge::Hris::EmployeePayrollRun

Deserialize a JSON object to an instance of EmployeePayrollRun

Parameters:

  • json_object (String)

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 137

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  id = parsed_json["id"]
  remote_id = parsed_json["remote_id"]
  created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
  modified_at = (DateTime.parse(parsed_json["modified_at"]) unless parsed_json["modified_at"].nil?)
  if parsed_json["employee"].nil?
    employee = nil
  else
    employee = parsed_json["employee"].to_json
    employee = Merge::Hris::EmployeePayrollRunEmployee.from_json(json_object: employee)
  end
  if parsed_json["payroll_run"].nil?
    payroll_run = nil
  else
    payroll_run = parsed_json["payroll_run"].to_json
    payroll_run = Merge::Hris::EmployeePayrollRunPayrollRun.from_json(json_object: payroll_run)
  end
  gross_pay = parsed_json["gross_pay"]
  net_pay = parsed_json["net_pay"]
  start_date = (DateTime.parse(parsed_json["start_date"]) unless parsed_json["start_date"].nil?)
  end_date = (DateTime.parse(parsed_json["end_date"]) unless parsed_json["end_date"].nil?)
  check_date = (DateTime.parse(parsed_json["check_date"]) unless parsed_json["check_date"].nil?)
  earnings = parsed_json["earnings"]&.map do |item|
    item = item.to_json
    Merge::Hris::Earning.from_json(json_object: item)
  end
  deductions = parsed_json["deductions"]&.map do |item|
    item = item.to_json
    Merge::Hris::Deduction.from_json(json_object: item)
  end
  taxes = parsed_json["taxes"]&.map do |item|
    item = item.to_json
    Merge::Hris::Tax.from_json(json_object: item)
  end
  remote_was_deleted = parsed_json["remote_was_deleted"]
  field_mappings = parsed_json["field_mappings"]
  remote_data = parsed_json["remote_data"]&.map do |item|
    item = item.to_json
    Merge::Hris::RemoteData.from_json(json_object: item)
  end
  new(
    id: id,
    remote_id: remote_id,
    created_at: created_at,
    modified_at: modified_at,
    employee: employee,
    payroll_run: payroll_run,
    gross_pay: gross_pay,
    net_pay: net_pay,
    start_date: start_date,
    end_date: end_date,
    check_date: check_date,
    earnings: earnings,
    deductions: deductions,
    taxes: taxes,
    remote_was_deleted: remote_was_deleted,
    field_mappings: field_mappings,
    remote_data: remote_data,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 214

def self.validate_raw(obj:)
  obj.id&.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.remote_id&.is_a?(String) != false || raise("Passed value for field obj.remote_id is not the expected type, validation failed.")
  obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.modified_at&.is_a?(DateTime) != false || raise("Passed value for field obj.modified_at is not the expected type, validation failed.")
  obj.employee.nil? || Merge::Hris::EmployeePayrollRunEmployee.validate_raw(obj: obj.employee)
  obj.payroll_run.nil? || Merge::Hris::EmployeePayrollRunPayrollRun.validate_raw(obj: obj.payroll_run)
  obj.gross_pay&.is_a?(Float) != false || raise("Passed value for field obj.gross_pay is not the expected type, validation failed.")
  obj.net_pay&.is_a?(Float) != false || raise("Passed value for field obj.net_pay is not the expected type, validation failed.")
  obj.start_date&.is_a?(DateTime) != false || raise("Passed value for field obj.start_date is not the expected type, validation failed.")
  obj.end_date&.is_a?(DateTime) != false || raise("Passed value for field obj.end_date is not the expected type, validation failed.")
  obj.check_date&.is_a?(DateTime) != false || raise("Passed value for field obj.check_date is not the expected type, validation failed.")
  obj.earnings&.is_a?(Array) != false || raise("Passed value for field obj.earnings is not the expected type, validation failed.")
  obj.deductions&.is_a?(Array) != false || raise("Passed value for field obj.deductions is not the expected type, validation failed.")
  obj.taxes&.is_a?(Array) != false || raise("Passed value for field obj.taxes is not the expected type, validation failed.")
  obj.remote_was_deleted&.is_a?(Boolean) != false || raise("Passed value for field obj.remote_was_deleted is not the expected type, validation failed.")
  obj.field_mappings&.is_a?(Hash) != false || raise("Passed value for field obj.field_mappings is not the expected type, validation failed.")
  obj.remote_data&.is_a?(Array) != false || raise("Passed value for field obj.remote_data is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of EmployeePayrollRun to a JSON object

Returns:

  • (String) 


204
205
206
 
# File 'lib/merge_ruby_client/hris/types/employee_payroll_run.rb', line 204

def to_json(*_args)
  @_field_set&.to_json
end