Class: XeroRuby::PayrollNz::EarningsRate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

ALLOWANCE =
"Allowance".freeze
BACKPAY =
"Backpay".freeze
BONUS =
"Bonus".freeze
COMMISSION =
"Commission".freeze
DISCRETIONARY_PAYMENTS =
"DiscretionaryPayments".freeze
HOLIDAY_PAY =
"HolidayPay".freeze
LUMP_SUM =
"LumpSum".freeze
OTHER_EARNINGS =
"OtherEarnings".freeze
OTHER_GROSS_EARNINGS =
"OtherGrossEarnings".freeze
OVERTIME_EARNINGS =
"OvertimeEarnings".freeze
REGULAR_EARNINGS =
"RegularEarnings".freeze
SALARY_SACRIFICE_FOR_KIWI_SAVER =
"SalarySacrificeForKiwiSaver".freeze
TIPS_DIRECT =
"Tips(Direct)".freeze
TIPS_NON_DIRECT =
"Tips(Non-Direct)".freeze
WITHHOLDING_INCOME =
"WithholdingIncome".freeze
RATE_PER_UNIT =
"RatePerUnit".freeze
MULTIPLE_OF_ORDINARY_EARNINGS_RATE =
"MultipleOfOrdinaryEarningsRate".freeze
FIXED_AMOUNT =
"FixedAmount".freeze

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


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
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 123

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#current_recordObject

Indicates whether an earning type is active


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

def current_record
  @current_record
end

#earnings_rate_idObject

Xero unique identifier for an earning rate


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

def earnings_rate_id
  @earnings_rate_id
end

#earnings_typeObject

Indicates how an employee will be paid when taking this type of earning


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

def earnings_type
  @earnings_type
end

#expense_account_idObject

The account that will be used for the earnings rate


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

def 
  @expense_account_id
end

#fixed_amountObject

Optional Fixed Rate Amount. Applicable for FixedAmount Rate


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

def fixed_amount
  @fixed_amount
end

#multiple_of_ordinary_earnings_rateObject

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 MultipleOfOrdinaryEarningsRate


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

def multiple_of_ordinary_earnings_rate
  @multiple_of_ordinary_earnings_rate
end

#nameObject

Name of the earning rate


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

def name
  @name
end

#rate_per_unitObject

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


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

def rate_per_unit
  @rate_per_unit
end

#rate_typeObject

Indicates the type of the earning rate


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

def rate_type
  @rate_type
end

#type_of_unitsObject

The type of units used to record earnings


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

def type_of_units
  @type_of_units
end

Class Method Details

.attribute_mapObject

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


90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 90

def self.attribute_map
  {
    :'earnings_rate_id' => :'earningsRateID',
    :'name' => :'name',
    :'earnings_type' => :'earningsType',
    :'rate_type' => :'rateType',
    :'type_of_units' => :'typeOfUnits',
    :'current_record' => :'currentRecord',
    :'expense_account_id' => :'expenseAccountID',
    :'rate_per_unit' => :'ratePerUnit',
    :'multiple_of_ordinary_earnings_rate' => :'multipleOfOrdinaryEarningsRate',
    :'fixed_amount' => :'fixedAmount'
  }
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


271
272
273
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 271

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

.openapi_typesObject

Attribute type mapping.


106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 106

def self.openapi_types
  {
    :'earnings_rate_id' => :'String',
    :'name' => :'String',
    :'earnings_type' => :'String',
    :'rate_type' => :'String',
    :'type_of_units' => :'String',
    :'current_record' => :'Boolean',
    :'expense_account_id' => :'String',
    :'rate_per_unit' => :'BigDecimal',
    :'multiple_of_ordinary_earnings_rate' => :'BigDecimal',
    :'fixed_amount' => :'BigDecimal'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 241

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      earnings_rate_id == o.earnings_rate_id &&
      name == o.name &&
      earnings_type == o.earnings_type &&
      rate_type == o.rate_type &&
      type_of_units == o.type_of_units &&
      current_record == o.current_record &&
       == o. &&
      rate_per_unit == o.rate_per_unit &&
      multiple_of_ordinary_earnings_rate == o.multiple_of_ordinary_earnings_rate &&
      fixed_amount == o.fixed_amount
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


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
335
336
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 299

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::PayrollNz.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


372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 372

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


278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 278

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

258
259
260
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 258

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


264
265
266
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 264

def hash
  [earnings_rate_id, name, earnings_type, rate_type, type_of_units, current_record, , rate_per_unit, multiple_of_ordinary_earnings_rate, fixed_amount].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 179

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

  if @earnings_type.nil?
    invalid_properties.push('invalid value for "earnings_type", earnings_type cannot be nil.')
  end

  if @rate_type.nil?
    invalid_properties.push('invalid value for "rate_type", rate_type cannot be nil.')
  end

  if @type_of_units.nil?
    invalid_properties.push('invalid value for "type_of_units", type_of_units cannot be nil.')
  end

  if @expense_account_id.nil?
    invalid_properties.push('invalid value for "expense_account_id", expense_account_id cannot be nil.')
  end

  invalid_properties
end

#parse_date(datestring) ⇒ Object


388
389
390
391
392
393
394
395
396
397
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 388

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


364
365
366
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 364

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


346
347
348
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 346

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


352
353
354
355
356
357
358
359
360
361
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 352

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


340
341
342
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 340

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


206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/xero-ruby/models/payroll_nz/earnings_rate.rb', line 206

def valid?
  return false if @name.nil?
  return false if @earnings_type.nil?
  earnings_type_validator = EnumAttributeValidator.new('String', ["Allowance", "Backpay", "Bonus", "Commission", "DiscretionaryPayments", "HolidayPay", "LumpSum", "OtherEarnings", "OtherGrossEarnings", "OvertimeEarnings", "RegularEarnings", "SalarySacrificeForKiwiSaver", "Tips(Direct)", "Tips(Non-Direct)", "WithholdingIncome"])
  return false unless earnings_type_validator.valid?(@earnings_type)
  return false if @rate_type.nil?
  rate_type_validator = EnumAttributeValidator.new('String', ["RatePerUnit", "MultipleOfOrdinaryEarningsRate", "FixedAmount"])
  return false unless rate_type_validator.valid?(@rate_type)
  return false if @type_of_units.nil?
  return false if @expense_account_id.nil?
  true
end