Class: XeroRuby::PayrollAu::PayRun

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/payroll_au/pay_run.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayRun

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 113

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::PayrollAu::PayRun` 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 `XeroRuby::PayrollAu::PayRun`. 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?(:'payroll_calendar_id')
    self.payroll_calendar_id = attributes[:'payroll_calendar_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_superObject

The total Super for the Payrun


56
57
58
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 56

def _super
  @_super
end

#deductionsObject

The total Deductions for the Payrun


50
51
52
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 50

def deductions
  @deductions
end

#net_payObject

The total NetPay for the Payrun


62
63
64
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 62

def net_pay
  @net_pay
end

#pay_run_idObject

Xero identifier for pay run


23
24
25
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 23

def pay_run_id
  @pay_run_id
end

#pay_run_period_end_dateObject

Period End Date for the PayRun (YYYY-MM-DD)


29
30
31
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 29

def pay_run_period_end_date
  @pay_run_period_end_date
end

#pay_run_period_start_dateObject

Period Start Date for the PayRun (YYYY-MM-DD)


26
27
28
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 26

def pay_run_period_start_date
  @pay_run_period_start_date
end

#pay_run_statusObject

Returns the value of attribute pay_run_status


32
33
34
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 32

def pay_run_status
  @pay_run_status
end

#payment_dateObject

Payment Date for the PayRun (YYYY-MM-DD)


35
36
37
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 35

def payment_date
  @payment_date
end

#payroll_calendar_idObject

Xero identifier for pay run


20
21
22
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 20

def payroll_calendar_id
  @payroll_calendar_id
end

#payslip_messageObject

Payslip message for the PayRun


38
39
40
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 38

def payslip_message
  @payslip_message
end

#payslipsObject

The payslips in the payrun


44
45
46
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 44

def payslips
  @payslips
end

#reimbursementObject

The total Reimbursements for the Payrun


59
60
61
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 59

def reimbursement
  @reimbursement
end

#taxObject

The total Tax for the Payrun


53
54
55
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 53

def tax
  @tax
end

#updated_date_utcObject

Last modified timestamp


41
42
43
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 41

def updated_date_utc
  @updated_date_utc
end

#validation_errorsObject

Displays array of validation error messages from the API


65
66
67
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 65

def validation_errors
  @validation_errors
end

#wagesObject

The total Wages for the Payrun


47
48
49
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 47

def wages
  @wages
end

Class Method Details

.attribute_mapObject

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


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 68

def self.attribute_map
  {
    :'payroll_calendar_id' => :'PayrollCalendarID',
    :'pay_run_id' => :'PayRunID',
    :'pay_run_period_start_date' => :'PayRunPeriodStartDate',
    :'pay_run_period_end_date' => :'PayRunPeriodEndDate',
    :'pay_run_status' => :'PayRunStatus',
    :'payment_date' => :'PaymentDate',
    :'payslip_message' => :'PayslipMessage',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'payslips' => :'Payslips',
    :'wages' => :'Wages',
    :'deductions' => :'Deductions',
    :'tax' => :'Tax',
    :'_super' => :'Super',
    :'reimbursement' => :'Reimbursement',
    :'net_pay' => :'NetPay',
    :'validation_errors' => :'ValidationErrors'
  }
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


251
252
253
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 251

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

.openapi_typesObject

Attribute type mapping.


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 90

def self.openapi_types
  {
    :'payroll_calendar_id' => :'String',
    :'pay_run_id' => :'String',
    :'pay_run_period_start_date' => :'Date',
    :'pay_run_period_end_date' => :'Date',
    :'pay_run_status' => :'PayRunStatus',
    :'payment_date' => :'Date',
    :'payslip_message' => :'String',
    :'updated_date_utc' => :'DateTime',
    :'payslips' => :'Array<PayslipSummary>',
    :'wages' => :'BigDecimal',
    :'deductions' => :'BigDecimal',
    :'tax' => :'BigDecimal',
    :'_super' => :'BigDecimal',
    :'reimbursement' => :'BigDecimal',
    :'net_pay' => :'BigDecimal',
    :'validation_errors' => :'Array<ValidationError>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 215

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payroll_calendar_id == o.payroll_calendar_id &&
      pay_run_id == o.pay_run_id &&
      pay_run_period_start_date == o.pay_run_period_start_date &&
      pay_run_period_end_date == o.pay_run_period_end_date &&
      pay_run_status == o.pay_run_status &&
      payment_date == o.payment_date &&
      payslip_message == o.payslip_message &&
      updated_date_utc == o.updated_date_utc &&
      payslips == o.payslips &&
      wages == o.wages &&
      deductions == o.deductions &&
      tax == o.tax &&
      _super == o._super &&
      reimbursement == o.reimbursement &&
      net_pay == o.net_pay &&
      validation_errors == o.validation_errors
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


279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 279

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::PayrollAu.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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


352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 352

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 258

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

238
239
240
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 238

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


244
245
246
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 244

def hash
  [payroll_calendar_id, pay_run_id, pay_run_period_start_date, pay_run_period_end_date, pay_run_status, payment_date, payslip_message, updated_date_utc, payslips, wages, deductions, tax, _super, reimbursement, net_pay, validation_errors].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


197
198
199
200
201
202
203
204
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 197

def list_invalid_properties
  invalid_properties = Array.new
  if @payroll_calendar_id.nil?
    invalid_properties.push('invalid value for "payroll_calendar_id", payroll_calendar_id cannot be nil.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object


368
369
370
371
372
373
374
375
376
377
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 368

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributesObject

Returns the object in the form of hash with snake_case


344
345
346
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 344

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


326
327
328
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 326

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


332
333
334
335
336
337
338
339
340
341
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 332

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


320
321
322
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 320

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


208
209
210
211
# File 'lib/xero-ruby/models/payroll_au/pay_run.rb', line 208

def valid?
  return false if @payroll_calendar_id.nil?
  true
end