class XeroRuby::PayrollNz::EmployeeTax

Constants

MAKE_CONTRIBUTIONS
NOT_CURRENTLY_A_KIWI_SAVER_MEMBER
ON_A_CONTRIBUTIONS_HOLIDAY
ON_A_SAVINGS_SUSPENSION
OPT_OUT

Attributes

esct_rate_percentage[RW]

Employer superannuation contribution tax rate.

has_special_student_loan_rate[RW]

Does the employee has a special student loan rate?

has_student_loan_balance[RW]

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

ird_number[RW]

The IRD Number.

is_eligible_for_kiwi_saver[RW]

The employee eligibility for KiwiSaver.

kiwi_saver_contribution_holiday_end_date[RW]

Contribution holiday expiry date or end date.

kiwi_saver_contributions[RW]

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

kiwi_saver_employee_contribution_rate_percentage[RW]

Employee Contribution percentage.

kiwi_saver_employer_contribution_rate_percentage[RW]

Employer Contribution percentage.

kiwi_saver_employer_salary_sacrifice_contribution_rate_percentage[RW]

Employer Contribution through Salary Sacrifice percentage.

kiwi_saver_opt_out_date[RW]

Opt Out Date.

special_student_loan_rate_percentage[RW]

The employee student loan rate percentage.

special_tax_rate_percentage[RW]

Special tax rate percentage.

student_loan_as_at[RW]

The date of the letter from IR.

student_loan_balance[RW]

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

tax_code[RW]

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/xero-ruby/models/payroll_nz/employee_tax.rb, line 281
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/xero-ruby/models/payroll_nz/employee_tax.rb, line 268
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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
kiwi_saver_contributions=(kiwi_saver_contributions) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] kiwi_saver_contributions Object to be assigned

# File lib/xero-ruby/models/payroll_nz/employee_tax.rb, line 235
def kiwi_saver_contributions=(kiwi_saver_contributions)
  validator = EnumAttributeValidator.new('String', ["MakeContributions", "OptOut", "OnAContributionsHoliday", "OnASavingsSuspension", "NotCurrentlyAKiwiSaverMember"])
  unless validator.valid?(kiwi_saver_contributions)
    fail ArgumentError, "invalid value for \"kiwi_saver_contributions\", must be one of #{validator.allowable_values}."
  end
  @kiwi_saver_contributions = kiwi_saver_contributions
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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) click to toggle source
# 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
  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() click to toggle source

Returns the object in the form of hash with snake_case

# File lib/xero-ruby/models/payroll_nz/employee_tax.rb, line 374
def to_attributes
  to_hash(downcase: true)
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/xero-ruby/models/payroll_nz/employee_tax.rb, line 356
def to_body
  to_hash
end
to_hash(downcase: false) click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/xero-ruby/models/payroll_nz/employee_tax.rb, line 350
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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