Class: MergeHRISClient::EmployeePayrollRun

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_client/models/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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmployeePayrollRun

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



128
129
130
131
132
133
134
135
136
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 128

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MergeHRISClient::EmployeePayrollRun` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MergeHRISClient::EmployeePayrollRun`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'remote_id')
    self.remote_id = attributes[:'remote_id']
  end

  if attributes.key?(:'employee')
    self.employee = attributes[:'employee']
  end

  if attributes.key?(:'payroll_run')
    self.payroll_run = attributes[:'payroll_run']
  end

  if attributes.key?(:'gross_pay')
    self.gross_pay = attributes[:'gross_pay']
  end

  if attributes.key?(:'net_pay')
    self.net_pay = attributes[:'net_pay']
  end

  if attributes.key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.key?(:'end_date')
    self.end_date = attributes[:'end_date']
  end

  if attributes.key?(:'check_date')
    self.check_date = attributes[:'check_date']
  end

  if attributes.key?(:'earnings')
    if (value = attributes[:'earnings']).is_a?(Array)
      self.earnings = value
    end
  end

  if attributes.key?(:'deductions')
    if (value = attributes[:'deductions']).is_a?(Array)
      self.deductions = value
    end
  end

  if attributes.key?(:'taxes')
    if (value = attributes[:'taxes']).is_a?(Array)
      self.taxes = value
    end
  end

  if attributes.key?(:'remote_was_deleted')
    self.remote_was_deleted = attributes[:'remote_was_deleted']
  end

  if attributes.key?(:'modified_at')
    self.modified_at = attributes[:'modified_at']
  end

  if attributes.key?(:'field_mappings')
    if (value = attributes[:'field_mappings']).is_a?(Hash)
      self.field_mappings = value
    end
  end

  if attributes.key?(:'remote_data')
    if (value = attributes[:'remote_data']).is_a?(Array)
      self.remote_data = value
    end
  end
end

Instance Attribute Details

#check_date ⇒ Object

The day and time the payroll run was checked.



43
44
45
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 43

def check_date
  @check_date
end

#deductions ⇒ Object

Returns the value of attribute deductions.



47
48
49
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 47

def deductions
  @deductions
end

#earnings ⇒ Object

Returns the value of attribute earnings.



45
46
47
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 45

def earnings
  @earnings
end

#employee ⇒ Object

The employee whose payroll is being run.



25
26
27
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 25

def employee
  @employee
end

#end_date ⇒ Object

The day and time the payroll run ended.



40
41
42
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 40

def end_date
  @end_date
end

#field_mappings ⇒ Object

Returns the value of attribute field_mappings.



57
58
59
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 57

def field_mappings
  @field_mappings
end

#gross_pay ⇒ Object

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



31
32
33
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 31

def gross_pay
  @gross_pay
end

#id ⇒ Object

Returns the value of attribute id.



19
20
21
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 19

def id
  @id
end

#modified_at ⇒ Object

This is the datetime that this object was last updated by Merge



55
56
57
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 55

def modified_at
  @modified_at
end

#net_pay ⇒ Object

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



34
35
36
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 34

def net_pay
  @net_pay
end

#payroll_run ⇒ Object

The payroll being run.



28
29
30
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 28

def payroll_run
  @payroll_run
end

#remote_data ⇒ Object

Returns the value of attribute remote_data.



59
60
61
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 59

def remote_data
  @remote_data
end

#remote_id ⇒ Object

The third-party API ID of the matching object.



22
23
24
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 22

def remote_id
  @remote_id
end

#remote_was_deleted ⇒ Object

Indicates whether or not this object has been deleted by third party webhooks.



52
53
54
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 52

def remote_was_deleted
  @remote_was_deleted
end

#start_date ⇒ Object

The day and time the payroll run started.



37
38
39
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 37

def start_date
  @start_date
end

#taxes ⇒ Object

Returns the value of attribute taxes.



49
50
51
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 49

def taxes
  @taxes
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 62

def self.attribute_map
  {
    :'id' => :'id',
    :'remote_id' => :'remote_id',
    :'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',
    :'modified_at' => :'modified_at',
    :'field_mappings' => :'field_mappings',
    :'remote_data' => :'remote_data'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



267
268
269
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 267

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 111

def self.openapi_nullable
  Set.new([
    :'remote_id',
    :'employee',
    :'payroll_run',
    :'gross_pay',
    :'net_pay',
    :'start_date',
    :'end_date',
    :'check_date',
    :'field_mappings',
    :'remote_data'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 89

def self.openapi_types
  {
    :'id' => :'String',
    :'remote_id' => :'String',
    :'employee' => :'String',
    :'payroll_run' => :'String',
    :'gross_pay' => :'Float',
    :'net_pay' => :'Float',
    :'start_date' => :'Time',
    :'end_date' => :'Time',
    :'check_date' => :'Time',
    :'earnings' => :'Array<Earning>',
    :'deductions' => :'Array<Deduction>',
    :'taxes' => :'Array<Tax>',
    :'remote_was_deleted' => :'Boolean',
    :'modified_at' => :'Time',
    :'field_mappings' => :'Hash<String, Object>',
    :'remote_data' => :'Array<RemoteData>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      remote_id == o.remote_id &&
      employee == o.employee &&
      payroll_run == o.payroll_run &&
      gross_pay == o.gross_pay &&
      net_pay == o.net_pay &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      check_date == o.check_date &&
      earnings == o.earnings &&
      deductions == o.deductions &&
      taxes == o.taxes &&
      remote_was_deleted == o.remote_was_deleted &&
      modified_at == o.modified_at &&
      field_mappings == o.field_mappings &&
      remote_data == o.remote_data
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 297

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = MergeHRISClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 368

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 274

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


254
255
256
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 254

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



260
261
262
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 260

def hash
  [id, remote_id, employee, payroll_run, gross_pay, net_pay, start_date, end_date, check_date, earnings, deductions, taxes, remote_was_deleted, modified_at, field_mappings, remote_data].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



218
219
220
221
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 218

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



344
345
346
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 344

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 350

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



338
339
340
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 338

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



225
226
227
 
# File 'lib/merge_hris_client/models/employee_payroll_run.rb', line 225

def valid?
  true
end