Class: XeroRuby::PayrollNz::EmployeeTax

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

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

MAKE_CONTRIBUTIONS =
"MakeContributions".freeze
OPT_OUT =
"OptOut".freeze
ON_A_CONTRIBUTIONS_HOLIDAY =
"OnAContributionsHoliday".freeze
ON_A_SAVINGS_SUSPENSION =
"OnASavingsSuspension".freeze
NOT_CURRENTLY_A_KIWI_SAVER_MEMBER =
"NotCurrentlyAKiwiSaverMember".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmployeeTax

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#esct_rate_percentageObject

Employer superannuation contribution tax rate.


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

def esct_rate_percentage
  @esct_rate_percentage
end

#has_special_student_loan_rateObject

Does the employee has a special student loan rate?


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

def has_special_student_loan_rate
  @has_special_student_loan_rate
end

#has_student_loan_balanceObject

Does the employee have a remaining student loan balance? Set a remaining balance if you have received a letter from IR.


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

def has_student_loan_balance
  @has_student_loan_balance
end

#ird_numberObject

The IRD Number.


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

def ird_number
  @ird_number
end

#is_eligible_for_kiwi_saverObject

The employee eligibility for KiwiSaver.


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

def is_eligible_for_kiwi_saver
  @is_eligible_for_kiwi_saver
end

#kiwi_saver_contribution_holiday_end_dateObject

Contribution holiday expiry date or end date.


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

def kiwi_saver_contribution_holiday_end_date
  @kiwi_saver_contribution_holiday_end_date
end

#kiwi_saver_contributionsObject

Contribution Option which can be 'MakeContributions' 'OptOut', 'OnAContributionsHoliday', 'OnASavingsSuspension', 'NotCurrentlyAKiwiSaverMember' for employees without a KiwiSaver membership


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

def kiwi_saver_contributions
  @kiwi_saver_contributions
end

#kiwi_saver_employee_contribution_rate_percentageObject

Employee Contribution percentage.


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

def kiwi_saver_employee_contribution_rate_percentage
  @kiwi_saver_employee_contribution_rate_percentage
end

#kiwi_saver_employer_contribution_rate_percentageObject

Employer Contribution percentage.


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

def kiwi_saver_employer_contribution_rate_percentage
  @kiwi_saver_employer_contribution_rate_percentage
end

#kiwi_saver_employer_salary_sacrifice_contribution_rate_percentageObject

Employer Contribution through Salary Sacrifice percentage.


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

def kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage
  @kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage
end

#kiwi_saver_opt_out_dateObject

Opt Out Date.


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

def kiwi_saver_opt_out_date
  @kiwi_saver_opt_out_date
end

#special_student_loan_rate_percentageObject

The employee student loan rate percentage.


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

def special_student_loan_rate_percentage
  @special_student_loan_rate_percentage
end

#special_tax_rate_percentageObject

Special tax rate percentage.


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

def special_tax_rate_percentage
  @special_tax_rate_percentage
end

#student_loan_as_atObject

The date of the letter from IR.


70
71
72
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 70

def student_loan_as_at
  @student_loan_as_at
end

#student_loan_balanceObject

The employee's student loan balance shown on the letter from IR.


67
68
69
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 67

def student_loan_balance
  @student_loan_balance
end

#tax_codeObject

Returns the value of attribute tax_code


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

def tax_code
  @tax_code
end

Class Method Details

.attribute_mapObject

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


95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 95

def self.attribute_map
  {
    :'ird_number' => :'irdNumber',
    :'tax_code' => :'taxCode',
    :'special_tax_rate_percentage' => :'specialTaxRatePercentage',
    :'has_special_student_loan_rate' => :'hasSpecialStudentLoanRate',
    :'special_student_loan_rate_percentage' => :'specialStudentLoanRatePercentage',
    :'is_eligible_for_kiwi_saver' => :'isEligibleForKiwiSaver',
    :'esct_rate_percentage' => :'esctRatePercentage',
    :'kiwi_saver_contributions' => :'kiwiSaverContributions',
    :'kiwi_saver_employee_contribution_rate_percentage' => :'kiwiSaverEmployeeContributionRatePercentage',
    :'kiwi_saver_employer_contribution_rate_percentage' => :'kiwiSaverEmployerContributionRatePercentage',
    :'kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage' => :'kiwiSaverEmployerSalarySacrificeContributionRatePercentage',
    :'kiwi_saver_opt_out_date' => :'kiwiSaverOptOutDate',
    :'kiwi_saver_contribution_holiday_end_date' => :'kiwiSaverContributionHolidayEndDate',
    :'has_student_loan_balance' => :'hasStudentLoanBalance',
    :'student_loan_balance' => :'studentLoanBalance',
    :'student_loan_as_at' => :'studentLoanAsAt'
  }
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


281
282
283
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 281

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

.openapi_typesObject

Attribute type mapping.


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 117

def self.openapi_types
  {
    :'ird_number' => :'String',
    :'tax_code' => :'TaxCode',
    :'special_tax_rate_percentage' => :'BigDecimal',
    :'has_special_student_loan_rate' => :'Boolean',
    :'special_student_loan_rate_percentage' => :'BigDecimal',
    :'is_eligible_for_kiwi_saver' => :'Boolean',
    :'esct_rate_percentage' => :'BigDecimal',
    :'kiwi_saver_contributions' => :'String',
    :'kiwi_saver_employee_contribution_rate_percentage' => :'BigDecimal',
    :'kiwi_saver_employer_contribution_rate_percentage' => :'BigDecimal',
    :'kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage' => :'BigDecimal',
    :'kiwi_saver_opt_out_date' => :'Date',
    :'kiwi_saver_contribution_holiday_end_date' => :'Date',
    :'has_student_loan_balance' => :'Boolean',
    :'student_loan_balance' => :'BigDecimal',
    :'student_loan_as_at' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 245

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ird_number == o.ird_number &&
      tax_code == o.tax_code &&
      special_tax_rate_percentage == o.special_tax_rate_percentage &&
      has_special_student_loan_rate == o.has_special_student_loan_rate &&
      special_student_loan_rate_percentage == o.special_student_loan_rate_percentage &&
      is_eligible_for_kiwi_saver == o.is_eligible_for_kiwi_saver &&
      esct_rate_percentage == o.esct_rate_percentage &&
      kiwi_saver_contributions == o.kiwi_saver_contributions &&
      kiwi_saver_employee_contribution_rate_percentage == o.kiwi_saver_employee_contribution_rate_percentage &&
      kiwi_saver_employer_contribution_rate_percentage == o.kiwi_saver_employer_contribution_rate_percentage &&
      kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage == o.kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage &&
      kiwi_saver_opt_out_date == o.kiwi_saver_opt_out_date &&
      kiwi_saver_contribution_holiday_end_date == o.kiwi_saver_contribution_holiday_end_date &&
      has_student_loan_balance == o.has_student_loan_balance &&
      student_loan_balance == o.student_loan_balance &&
      student_loan_as_at == o.student_loan_as_at
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


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
337
338
339
340
341
342
343
344
345
346
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 309

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


382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 382

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


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 288

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

268
269
270
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 268

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


274
275
276
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 274

def hash
  [ird_number, tax_code, special_tax_rate_percentage, has_special_student_loan_rate, special_student_loan_rate_percentage, is_eligible_for_kiwi_saver, esct_rate_percentage, kiwi_saver_contributions, kiwi_saver_employee_contribution_rate_percentage, kiwi_saver_employer_contribution_rate_percentage, kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage, kiwi_saver_opt_out_date, kiwi_saver_contribution_holiday_end_date, has_student_loan_balance, student_loan_balance, student_loan_as_at].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


220
221
222
223
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 220

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


398
399
400
401
402
403
404
405
406
407
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 398

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


374
375
376
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 374

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


356
357
358
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 356

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


362
363
364
365
366
367
368
369
370
371
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 362

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


350
351
352
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 350

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


227
228
229
230
231
# File 'lib/xero-ruby/models/payroll_nz/employee_tax.rb', line 227

def valid?
  kiwi_saver_contributions_validator = EnumAttributeValidator.new('String', ["MakeContributions", "OptOut", "OnAContributionsHoliday", "OnASavingsSuspension", "NotCurrentlyAKiwiSaverMember"])
  return false unless kiwi_saver_contributions_validator.valid?(@kiwi_saver_contributions)
  true
end