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) ⇒ 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
customized data_parser.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ 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
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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 114 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
34 35 36 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 34 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
37 38 39 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 37 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
40 41 42 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 40 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
43 44 45 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 43 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
46 47 48 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 46 def can_apply_to_revenue @can_apply_to_revenue end |
#display_tax_rate ⇒ Object
Tax Rate (decimal to 4dp) e.g 12.5000
49 50 51 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 49 def display_tax_rate @display_tax_rate end |
#effective_rate ⇒ Object
Effective Tax Rate (decimal to 4dp) e.g 12.5000
52 53 54 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 52 def effective_rate @effective_rate end |
#name ⇒ Object
Name of tax rate
19 20 21 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 19 def name @name end |
#report_tax_type ⇒ Object
See ReportTaxTypes
31 32 33 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 31 def report_tax_type @report_tax_type end |
#status ⇒ Object
See Status Codes
28 29 30 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 28 def status @status end |
#tax_components ⇒ Object
See TaxComponents
25 26 27 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 25 def tax_components @tax_components end |
#tax_type ⇒ Object
The tax type
22 23 24 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 22 def tax_type @tax_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 77 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
249 250 251 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 249 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 95 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' => :'Float', :'effective_rate' => :'Float' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 217 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
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 277 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 :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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
342 343 344 345 346 347 348 349 350 351 352 353 354 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 342 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 256 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
236 237 238 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 236 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
242 243 244 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 242 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?
180 181 182 183 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 180 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
357 358 359 360 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 357 def parse_date(datestring) seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0 return Time.at(seconds_since_epoch).to_s end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
322 323 324 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 322 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
328 329 330 331 332 333 334 335 336 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 328 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
316 317 318 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 316 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
187 188 189 190 191 192 193 |
# File 'lib/xero-ruby/models/accounting/tax_rate.rb', line 187 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"]) return false unless report_tax_type_validator.valid?(@report_tax_type) true end |