Class: XeroRuby::PayrollUk::EmployeeTax

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

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


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# 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

Instance Attribute Details

#directorship_start_dateObject

The directorship start date


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

def directorship_start_date
  @directorship_start_date
end

#has_post_graduate_loansObject

Describes whether the employee has post graduate loans


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

def has_post_graduate_loans
  @has_post_graduate_loans
end

#is_directorObject

Describes whether the employee is director


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

def is_director
  @is_director
end

#nic_calculation_methodObject

NICs calculation method


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

def nic_calculation_method
  @nic_calculation_method
end

#previous_tax_paidObject

The tax amount previously paid


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

def previous_tax_paid
  @previous_tax_paid
end

#previous_taxable_payObject

The previous taxable pay


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

def previous_taxable_pay
  @previous_taxable_pay
end

#starter_declarationObject

Starter declaration.


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

def starter_declaration
  @starter_declaration
end

#starter_typeObject

The Starter type.


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

def starter_type
  @starter_type
end

#student_loan_deductionObject

The employee's student loan deduction type


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

def student_loan_deduction
  @student_loan_deduction
end

#tax_codeObject

The Tax code.


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

def tax_code
  @tax_code
end

#w1_m1Object

Describes whether the tax settings is W1M1


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

def w1_m1
  @w1_m1
end

Class Method Details

.attribute_mapObject

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


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


192
193
194
# File 'lib/xero-ruby/models/payroll_uk/employee_tax.rb', line 192

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

.openapi_typesObject

Attribute type mapping.


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# 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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# 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) ⇒ 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


293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# 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) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

179
180
181
# File 'lib/xero-ruby/models/payroll_uk/employee_tax.rb', line 179

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


185
186
187
# 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_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


148
149
150
151
# 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) ⇒ Object


309
310
311
312
313
314
315
316
317
318
# 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
  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


285
286
287
# File 'lib/xero-ruby/models/payroll_uk/employee_tax.rb', line 285

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


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

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


273
274
275
276
277
278
279
280
281
282
# 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


261
262
263
# File 'lib/xero-ruby/models/payroll_uk/employee_tax.rb', line 261

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


155
156
157
# File 'lib/xero-ruby/models/payroll_uk/employee_tax.rb', line 155

def valid?
  true
end