class XeroRuby::PayrollUk::Benefit
Constants
- FIXED_AMOUNT
- OTHER
- PERCENTAGE_OF_GROSS
- STAKEHOLDER_PENSION
Attributes
Calculation Type of the employer pension (FixedAmount or PercentageOfGross).
Category type of the employer pension
Identifier of a record is active or not.
Xero identifier for Expense Account
unique identifier in Xero
Identifier of calculating on qualifying earnings
Xero identifier for Liability Account
Name of the employer pension
Percentage of gross of the employer pension
display the balance to employee
Standard amount of the employer pension
Identifier of subject To NIC
Identifier of subject To pension
Identifier of subject To Tax
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 88 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'category' => :'category', :'liability_account_id' => :'liabilityAccountId', :'expense_account_id' => :'expenseAccountId', :'standard_amount' => :'standardAmount', :'percentage' => :'percentage', :'calculation_type' => :'calculationType', :'current_record' => :'currentRecord', :'subject_to_nic' => :'subjectToNIC', :'subject_to_pension' => :'subjectToPension', :'subject_to_tax' => :'subjectToTax', :'is_calculating_on_qualifying_earnings' => :'isCalculatingOnQualifyingEarnings', :'show_balance_to_employee' => :'showBalanceToEmployee' } end
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/benefit.rb, line 302 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 129 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::PayrollUk::Benefit` 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::Benefit`. 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?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'category') self.category = attributes[:'category'] end if attributes.key?(:'liability_account_id') self.liability_account_id = attributes[:'liability_account_id'] end if attributes.key?(:'expense_account_id') self.expense_account_id = attributes[:'expense_account_id'] end if attributes.key?(:'standard_amount') self.standard_amount = attributes[:'standard_amount'] end if attributes.key?(:'percentage') self.percentage = attributes[:'percentage'] end if attributes.key?(:'calculation_type') self.calculation_type = attributes[:'calculation_type'] end if attributes.key?(:'current_record') self.current_record = attributes[:'current_record'] end if attributes.key?(:'subject_to_nic') self.subject_to_nic = attributes[:'subject_to_nic'] end if attributes.key?(:'subject_to_pension') self.subject_to_pension = attributes[:'subject_to_pension'] end if attributes.key?(:'subject_to_tax') self.subject_to_tax = attributes[:'subject_to_tax'] end if attributes.key?(:'is_calculating_on_qualifying_earnings') self.is_calculating_on_qualifying_earnings = attributes[:'is_calculating_on_qualifying_earnings'] end if attributes.key?(:'show_balance_to_employee') self.show_balance_to_employee = attributes[:'show_balance_to_employee'] end end
Attribute type mapping.
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 108 def self.openapi_types { :'id' => :'String', :'name' => :'String', :'category' => :'String', :'liability_account_id' => :'String', :'expense_account_id' => :'String', :'standard_amount' => :'BigDecimal', :'percentage' => :'BigDecimal', :'calculation_type' => :'String', :'current_record' => :'Boolean', :'subject_to_nic' => :'Boolean', :'subject_to_pension' => :'Boolean', :'subject_to_tax' => :'Boolean', :'is_calculating_on_qualifying_earnings' => :'Boolean', :'show_balance_to_employee' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 268 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && category == o.category && liability_account_id == o.liability_account_id && expense_account_id == o.expense_account_id && standard_amount == o.standard_amount && percentage == o.percentage && calculation_type == o.calculation_type && current_record == o.current_record && subject_to_nic == o.subject_to_nic && subject_to_pension == o.subject_to_pension && subject_to_tax == o.subject_to_tax && is_calculating_on_qualifying_earnings == o.is_calculating_on_qualifying_earnings && show_balance_to_employee == o.show_balance_to_employee end
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/benefit.rb, line 330 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
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/benefit.rb, line 403 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
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/benefit.rb, line 309 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
Custom attribute writer method checking allowed values (enum). @param [Object] calculation_type
Object to be assigned
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 258 def calculation_type=(calculation_type) validator = EnumAttributeValidator.new('String', ["FixedAmount", "PercentageOfGross"]) unless validator.valid?(calculation_type) fail ArgumentError, "invalid value for \"calculation_type\", must be one of #{validator.allowable_values}." end @calculation_type = calculation_type end
Custom attribute writer method checking allowed values (enum). @param [Object] category Object to be assigned
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 248 def category=(category) validator = EnumAttributeValidator.new('String', ["StakeholderPension", "Other"]) unless validator.valid?(category) fail ArgumentError, "invalid value for \"category\", must be one of #{validator.allowable_values}." end @category = category end
@see the `==` method @param [Object] Object to be compared
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 289 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 295 def hash [id, name, category, liability_account_id, expense_account_id, standard_amount, percentage, calculation_type, current_record, subject_to_nic, subject_to_pension, subject_to_tax, is_calculating_on_qualifying_earnings, show_balance_to_employee].hash end
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/benefit.rb, line 201 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @category.nil? invalid_properties.push('invalid value for "category", category cannot be nil.') end if @liability_account_id.nil? invalid_properties.push('invalid value for "liability_account_id", liability_account_id 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 if @percentage.nil? invalid_properties.push('invalid value for "percentage", percentage cannot be nil.') end if @calculation_type.nil? invalid_properties.push('invalid value for "calculation_type", calculation_type cannot be nil.') end invalid_properties end
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 419 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
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 395 def to_attributes to_hash(downcase: true) end
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/benefit.rb, line 383 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/xero-ruby/models/payroll_uk/benefit.rb, line 371 def to_s to_hash.to_s end
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/benefit.rb, line 232 def valid? return false if @name.nil? return false if @category.nil? category_validator = EnumAttributeValidator.new('String', ["StakeholderPension", "Other"]) return false unless category_validator.valid?(@category) return false if @liability_account_id.nil? return false if @expense_account_id.nil? return false if @percentage.nil? return false if @calculation_type.nil? calculation_type_validator = EnumAttributeValidator.new('String', ["FixedAmount", "PercentageOfGross"]) return false unless calculation_type_validator.valid?(@calculation_type) true end