Class: XeroRuby::PayrollAu::EarningsRate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EarningsRate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 133

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_code ⇒ Object

See Accounts



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

def 
  @account_code
end

#accrue_leave ⇒ Object

Indicates that this earnings rate should accrue leave. Only applicable if RateType is MULTIPLE



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

def accrue_leave
  @accrue_leave
end

#allowance_category ⇒ Object

Returns the value of attribute allowance_category.



77
78
79
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 77

def allowance_category
  @allowance_category
end

#allowance_contributes_to_annual_leave_rate ⇒ Object

Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT



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

def allowance_contributes_to_annual_leave_rate
  @allowance_contributes_to_annual_leave_rate
end

#allowance_contributes_to_overtime_rate ⇒ Object

Boolean to determine if the allowance earnings rate contributes towards overtime allowance rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT



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

def allowance_contributes_to_overtime_rate
  @allowance_contributes_to_overtime_rate
end

#allowance_type ⇒ Object

Returns the value of attribute allowance_type.



74
75
76
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 74

def allowance_type
  @allowance_type
end

#amount ⇒ Object

Optional Amount for FIXEDAMOUNT RateType EarningsRate



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

def amount
  @amount
end

#current_record ⇒ Object

Is the current record



71
72
73
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 71

def current_record
  @current_record
end

#earnings_rate_id ⇒ Object

Xero identifier



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

def earnings_rate_id
  @earnings_rate_id
end

#earnings_type ⇒ Object

Returns the value of attribute earnings_type.



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

def earnings_type
  @earnings_type
end

#employment_termination_payment_type ⇒ Object

Returns the value of attribute employment_termination_payment_type.



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

def employment_termination_payment_type
  @employment_termination_payment_type
end

#is_exempt_from_super ⇒ Object

See the ATO website for details of which payments are exempt from SGC



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

def is_exempt_from_super
  @is_exempt_from_super
end

#is_exempt_from_tax ⇒ Object

Most payments are subject to tax, so you should only set this value if you are sure that a payment is exempt from PAYG withholding



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

def is_exempt_from_tax
  @is_exempt_from_tax
end

#is_reportable_as_w1 ⇒ Object

Boolean to determine if the earnings rate is reportable or exempt from W1



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

def is_reportable_as_w1
  @is_reportable_as_w1
end

#multiplier ⇒ Object

This is the multiplier used to calculate the rate per unit, based on the employee’s ordinary earnings rate. For example, for time and a half enter 1.5. Only applicable if RateType is MULTIPLE



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

def multiplier
  @multiplier
end

#name ⇒ Object

Name of the earnings rate (max length = 100)



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

def name
  @name
end

#rate_per_unit ⇒ Object

Default rate per unit (optional). Only applicable if RateType is RATEPERUNIT.



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

def rate_per_unit
  @rate_per_unit
end

#rate_type ⇒ Object

Returns the value of attribute rate_type.



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

def rate_type
  @rate_type
end

#type_of_units ⇒ Object

Type of units used to record earnings (max length = 50). Only When RateType is RATEPERUNIT



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

def type_of_units
  @type_of_units
end

#updated_date_utc ⇒ Object

Last modified timestamp



68
69
70
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 68

def updated_date_utc
  @updated_date_utc
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 80

def self.attribute_map
  {
    :'name' => :'Name',
    :'account_code' => :'AccountCode',
    :'type_of_units' => :'TypeOfUnits',
    :'is_exempt_from_tax' => :'IsExemptFromTax',
    :'is_exempt_from_super' => :'IsExemptFromSuper',
    :'is_reportable_as_w1' => :'IsReportableAsW1',
    :'allowance_contributes_to_annual_leave_rate' => :'AllowanceContributesToAnnualLeaveRate',
    :'allowance_contributes_to_overtime_rate' => :'AllowanceContributesToOvertimeRate',
    :'earnings_type' => :'EarningsType',
    :'earnings_rate_id' => :'EarningsRateID',
    :'rate_type' => :'RateType',
    :'rate_per_unit' => :'RatePerUnit',
    :'multiplier' => :'Multiplier',
    :'accrue_leave' => :'AccrueLeave',
    :'amount' => :'Amount',
    :'employment_termination_payment_type' => :'EmploymentTerminationPaymentType',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'current_record' => :'CurrentRecord',
    :'allowance_type' => :'AllowanceType',
    :'allowance_category' => :'AllowanceCategory'
  }
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



312
313
314
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 312

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

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 106

def self.openapi_types
  {
    :'name' => :'String',
    :'account_code' => :'String',
    :'type_of_units' => :'String',
    :'is_exempt_from_tax' => :'Boolean',
    :'is_exempt_from_super' => :'Boolean',
    :'is_reportable_as_w1' => :'Boolean',
    :'allowance_contributes_to_annual_leave_rate' => :'Boolean',
    :'allowance_contributes_to_overtime_rate' => :'Boolean',
    :'earnings_type' => :'EarningsType',
    :'earnings_rate_id' => :'String',
    :'rate_type' => :'RateType',
    :'rate_per_unit' => :'String',
    :'multiplier' => :'BigDecimal',
    :'accrue_leave' => :'Boolean',
    :'amount' => :'BigDecimal',
    :'employment_termination_payment_type' => :'EmploymentTerminationPaymentType',
    :'updated_date_utc' => :'DateTime',
    :'current_record' => :'Boolean',
    :'allowance_type' => :'AllowanceType',
    :'allowance_category' => :'AllowanceCategory'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
       == o. &&
      type_of_units == o.type_of_units &&
      is_exempt_from_tax == o.is_exempt_from_tax &&
      is_exempt_from_super == o.is_exempt_from_super &&
      is_reportable_as_w1 == o.is_reportable_as_w1 &&
      allowance_contributes_to_annual_leave_rate == o.allowance_contributes_to_annual_leave_rate &&
      allowance_contributes_to_overtime_rate == o.allowance_contributes_to_overtime_rate &&
      earnings_type == o.earnings_type &&
      earnings_rate_id == o.earnings_rate_id &&
      rate_type == o.rate_type &&
      rate_per_unit == o.rate_per_unit &&
      multiplier == o.multiplier &&
      accrue_leave == o.accrue_leave &&
      amount == o.amount &&
      employment_termination_payment_type == o.employment_termination_payment_type &&
      updated_date_utc == o.updated_date_utc &&
      current_record == o.current_record &&
      allowance_type == o.allowance_type &&
      allowance_category == o.allowance_category
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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 340

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



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 413

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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 319

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


299
300
301
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 299

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



305
306
307
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 305

def hash
  [name, , type_of_units, is_exempt_from_tax, is_exempt_from_super, is_reportable_as_w1, allowance_contributes_to_annual_leave_rate, allowance_contributes_to_overtime_rate, earnings_type, earnings_rate_id, rate_type, rate_per_unit, multiplier, accrue_leave, amount, employment_termination_payment_type, updated_date_utc, current_record, allowance_type, allowance_category].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



229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 229

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
  end

  if !@type_of_units.nil? && @type_of_units.to_s.length > 50
    invalid_properties.push('invalid value for "type_of_units", the character length must be smaller than or equal to 50.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object 



429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 429

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
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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_attributes ⇒ Object

Returns the object in the form of hash with snake_case



405
406
407
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 405

def to_attributes
  to_hash(downcase: true)
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



387
388
389
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 387

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



393
394
395
396
397
398
399
400
401
402
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 393

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



381
382
383
 
# File 'lib/xero-ruby/models/payroll_au/earnings_rate.rb', line 381

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



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

def valid?
  return false if !@name.nil? && @name.to_s.length > 100
  return false if !@type_of_units.nil? && @type_of_units.to_s.length > 50
  true
end