class XeroRuby::PayrollUk::EmployeeTax

Attributes

directorship_start_date[RW]

The directorship start date

has_post_graduate_loans[RW]

Describes whether the employee has post graduate loans

is_director[RW]

Describes whether the employee is director

nic_calculation_method[RW]

NICs calculation method

previous_tax_paid[RW]

The tax amount previously paid

previous_taxable_pay[RW]

The previous taxable pay

starter_declaration[RW]

Starter declaration.

starter_type[RW]

The Starter type.

student_loan_deduction[RW]

The employee's student loan deduction type

tax_code[RW]

The Tax code.

w1_m1[RW]

Describes whether the tax settings is W1M1

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_uk/employee_tax.rb, line 53
def self.attribute_map
  {
    :'starter_type' => :'starterType',
    :'starter_declaration' => :'starterDeclaration',
    :'tax_code' => :'taxCode',
    :'w1_m1' => :'w1M1',
    :'previous_taxable_pay' => :'previousTaxablePay',
    :'previous_tax_paid' => :'previousTaxPaid',
    :'student_loan_deduction' => :'studentLoanDeduction',
    :'has_post_graduate_loans' => :'hasPostGraduateLoans',
    :'is_director' => :'isDirector',
    :'directorship_start_date' => :'directorshipStartDate',
    :'nic_calculation_method' => :'nicCalculationMethod'
  }
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_uk/employee_tax.rb, line 192
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_uk/employee_tax.rb, line 88
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::PayrollUk::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::PayrollUk::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?(:'starter_type')
    self.starter_type = attributes[:'starter_type']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'nic_calculation_method')
    self.nic_calculation_method = attributes[:'nic_calculation_method']
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/xero-ruby/models/payroll_uk/employee_tax.rb, line 70
def self.openapi_types
  {
    :'starter_type' => :'String',
    :'starter_declaration' => :'String',
    :'tax_code' => :'String',
    :'w1_m1' => :'Boolean',
    :'previous_taxable_pay' => :'BigDecimal',
    :'previous_tax_paid' => :'BigDecimal',
    :'student_loan_deduction' => :'String',
    :'has_post_graduate_loans' => :'Boolean',
    :'is_director' => :'Boolean',
    :'directorship_start_date' => :'Date',
    :'nic_calculation_method' => :'String'
  }
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_uk/employee_tax.rb, line 161
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      starter_type == o.starter_type &&
      starter_declaration == o.starter_declaration &&
      tax_code == o.tax_code &&
      w1_m1 == o.w1_m1 &&
      previous_taxable_pay == o.previous_taxable_pay &&
      previous_tax_paid == o.previous_tax_paid &&
      student_loan_deduction == o.student_loan_deduction &&
      has_post_graduate_loans == o.has_post_graduate_loans &&
      is_director == o.is_director &&
      directorship_start_date == o.directorship_start_date &&
      nic_calculation_method == o.nic_calculation_method
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_uk/employee_tax.rb, line 220
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::PayrollUk.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_uk/employee_tax.rb, line 293
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_uk/employee_tax.rb, line 199
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_uk/employee_tax.rb, line 179
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_uk/employee_tax.rb, line 185
def hash
  [starter_type, starter_declaration, tax_code, w1_m1, previous_taxable_pay, previous_tax_paid, student_loan_deduction, has_post_graduate_loans, is_director, directorship_start_date, nic_calculation_method].hash
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_uk/employee_tax.rb, line 148
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
parse_date(datestring) click to toggle source
# File lib/xero-ruby/models/payroll_uk/employee_tax.rb, line 309
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_uk/employee_tax.rb, line 285
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_uk/employee_tax.rb, line 267
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_uk/employee_tax.rb, line 273
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_uk/employee_tax.rb, line 261
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_uk/employee_tax.rb, line 155
def valid?
  true
end