Class: XeroRuby::Accounting::TaxRate
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::TaxRate
- Defined in:
- lib/xero-ruby/models/accounting/tax_rate.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#can_apply_to_assets ⇒ Object
Boolean to describe if tax rate can be used for asset accounts i.e.
-
#can_apply_to_equity ⇒ Object
Boolean to describe if tax rate can be used for equity accounts i.e true,false.
-
#can_apply_to_expenses ⇒ Object
Boolean to describe if tax rate can be used for expense accounts i.e.
-
#can_apply_to_liabilities ⇒ Object
Boolean to describe if tax rate can be used for liability accounts i.e.
-
#can_apply_to_revenue ⇒ Object
Boolean to describe if tax rate can be used for revenue accounts i.e.
-
#display_tax_rate ⇒ Object
Tax Rate (decimal to 4dp) e.g 12.5000.
-
#effective_rate ⇒ Object
Effective Tax Rate (decimal to 4dp) e.g 12.5000.
-
#name ⇒ Object
Name of tax rate.
-
#report_tax_type ⇒ Object
See ReportTaxTypes.
-
#status ⇒ Object
See Status Codes.
-
#tax_components ⇒ Object
See TaxComponents.
-
#tax_type ⇒ Object
The tax type.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value, downcase: false) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ TaxRate
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
- #parse_date(datestring) ⇒ Object
-
#to_attributes ⇒ Object
Returns the object in the form of hash with snake_case.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash(downcase: false) ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ TaxRate
Initializes the object
216 217 218 219 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 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 216 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::TaxRate` 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::Accounting::TaxRate`. 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?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'tax_type') self.tax_type = attributes[:'tax_type'] end if attributes.key?(:'tax_components') if (value = attributes[:'tax_components']).is_a?(Array) self.tax_components = value end end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'report_tax_type') self.report_tax_type = attributes[:'report_tax_type'] end if attributes.key?(:'can_apply_to_assets') self.can_apply_to_assets = attributes[:'can_apply_to_assets'] end if attributes.key?(:'can_apply_to_equity') self.can_apply_to_equity = attributes[:'can_apply_to_equity'] end if attributes.key?(:'can_apply_to_expenses') self.can_apply_to_expenses = attributes[:'can_apply_to_expenses'] end if attributes.key?(:'can_apply_to_liabilities') self.can_apply_to_liabilities = attributes[:'can_apply_to_liabilities'] end if attributes.key?(:'can_apply_to_revenue') self.can_apply_to_revenue = attributes[:'can_apply_to_revenue'] end if attributes.key?(:'display_tax_rate') self.display_tax_rate = attributes[:'display_tax_rate'] end if attributes.key?(:'effective_rate') self.effective_rate = attributes[:'effective_rate'] end end |
Instance Attribute Details
#can_apply_to_assets ⇒ Object
Boolean to describe if tax rate can be used for asset accounts i.e. true,false
136 137 138 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 136 def can_apply_to_assets @can_apply_to_assets end |
#can_apply_to_equity ⇒ Object
Boolean to describe if tax rate can be used for equity accounts i.e true,false
139 140 141 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 139 def can_apply_to_equity @can_apply_to_equity end |
#can_apply_to_expenses ⇒ Object
Boolean to describe if tax rate can be used for expense accounts i.e. true,false
142 143 144 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 142 def can_apply_to_expenses @can_apply_to_expenses end |
#can_apply_to_liabilities ⇒ Object
Boolean to describe if tax rate can be used for liability accounts i.e. true,false
145 146 147 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 145 def can_apply_to_liabilities @can_apply_to_liabilities end |
#can_apply_to_revenue ⇒ Object
Boolean to describe if tax rate can be used for revenue accounts i.e. true,false
148 149 150 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 148 def can_apply_to_revenue @can_apply_to_revenue end |
#display_tax_rate ⇒ Object
Tax Rate (decimal to 4dp) e.g 12.5000
151 152 153 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 151 def display_tax_rate @display_tax_rate end |
#effective_rate ⇒ Object
Effective Tax Rate (decimal to 4dp) e.g 12.5000
154 155 156 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 154 def effective_rate @effective_rate end |
#name ⇒ Object
Name of tax rate
20 21 22 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 20 def name @name end |
#report_tax_type ⇒ Object
See ReportTaxTypes
36 37 38 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 36 def report_tax_type @report_tax_type end |
#status ⇒ Object
See Status Codes
29 30 31 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 29 def status @status end |
#tax_components ⇒ Object
See TaxComponents
26 27 28 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 26 def tax_components @tax_components end |
#tax_type ⇒ Object
The tax type
23 24 25 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 23 def tax_type @tax_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 179 def self.attribute_map { :'name' => :'Name', :'tax_type' => :'TaxType', :'tax_components' => :'TaxComponents', :'status' => :'Status', :'report_tax_type' => :'ReportTaxType', :'can_apply_to_assets' => :'CanApplyToAssets', :'can_apply_to_equity' => :'CanApplyToEquity', :'can_apply_to_expenses' => :'CanApplyToExpenses', :'can_apply_to_liabilities' => :'CanApplyToLiabilities', :'can_apply_to_revenue' => :'CanApplyToRevenue', :'display_tax_rate' => :'DisplayTaxRate', :'effective_rate' => :'EffectiveRate' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
351 352 353 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 351 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 197 def self.openapi_types { :'name' => :'String', :'tax_type' => :'String', :'tax_components' => :'Array<TaxComponent>', :'status' => :'String', :'report_tax_type' => :'String', :'can_apply_to_assets' => :'Boolean', :'can_apply_to_equity' => :'Boolean', :'can_apply_to_expenses' => :'Boolean', :'can_apply_to_liabilities' => :'Boolean', :'can_apply_to_revenue' => :'Boolean', :'display_tax_rate' => :'BigDecimal', :'effective_rate' => :'BigDecimal' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 319 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && tax_type == o.tax_type && tax_components == o.tax_components && status == o.status && report_tax_type == o.report_tax_type && can_apply_to_assets == o.can_apply_to_assets && can_apply_to_equity == o.can_apply_to_equity && can_apply_to_expenses == o.can_apply_to_expenses && can_apply_to_liabilities == o.can_apply_to_liabilities && can_apply_to_revenue == o.can_apply_to_revenue && display_tax_rate == o.display_tax_rate && effective_rate == o.effective_rate end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 379 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::Accounting.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
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 452 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
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 358 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
338 339 340 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 338 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
344 345 346 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 344 def hash [name, tax_type, tax_components, status, report_tax_type, can_apply_to_assets, can_apply_to_equity, can_apply_to_expenses, can_apply_to_liabilities, can_apply_to_revenue, display_tax_rate, effective_rate].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
282 283 284 285 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 282 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#parse_date(datestring) ⇒ Object
468 469 470 471 472 473 474 475 476 477 478 479 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 468 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 ⇒ Object
Returns the object in the form of hash with snake_case
444 445 446 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 444 def to_attributes to_hash(downcase: true) end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
426 427 428 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 426 def to_body to_hash end |
#to_hash(downcase: false) ⇒ Hash
Returns the object in the form of hash
432 433 434 435 436 437 438 439 440 441 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 432 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 ⇒ String
Returns the string representation of the object
420 421 422 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 420 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
289 290 291 292 293 294 295 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 289 def valid? status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "DELETED", "ARCHIVED", "PENDING"]) return false unless status_validator.valid?(@status) report_tax_type_validator = EnumAttributeValidator.new('String', ["AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33", "TXRCRE", "TXRCESS", "TXRCTS", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED", "SROVRRS", "SROVRLVG", "SRLVG", "IM", "IMESS", "IMN33", "IMRE", "BADDEBTRECOVERY"]) return false unless report_tax_type_validator.valid?(@report_tax_type) true end |