Class: NuvemfiscalSdkRuby::NfeSefazICMS15

Inherits:
Object
  • Object
show all
Defined in:
lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb

Overview

Tributação monofásica própria e com responsabilidade pela retenção sobre combustíveis.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazICMS15

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 104

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `NuvemfiscalSdkRuby::NfeSefazICMS15` 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 `NuvemfiscalSdkRuby::NfeSefazICMS15`. 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?(:'orig')
    self.orig = attributes[:'orig']
  else
    self.orig = nil
  end

  if attributes.key?(:'cst')
    self.cst = attributes[:'cst']
  else
    self.cst = nil
  end

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

  if attributes.key?(:'ad_rem_icms')
    self.ad_rem_icms = attributes[:'ad_rem_icms']
  else
    self.ad_rem_icms = nil
  end

  if attributes.key?(:'v_icms_mono')
    self.v_icms_mono = attributes[:'v_icms_mono']
  else
    self.v_icms_mono = nil
  end

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

  if attributes.key?(:'ad_rem_icms_reten')
    self.ad_rem_icms_reten = attributes[:'ad_rem_icms_reten']
  else
    self.ad_rem_icms_reten = nil
  end

  if attributes.key?(:'v_icms_mono_reten')
    self.v_icms_mono_reten = attributes[:'v_icms_mono_reten']
  else
    self.v_icms_mono_reten = nil
  end

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

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

Instance Attribute Details

#ad_rem_icms ⇒ Object

Alíquota ad rem do imposto.



29
30
31
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 29

def ad_rem_icms
  @ad_rem_icms
end

#ad_rem_icms_reten ⇒ Object

Alíquota ad rem do imposto com retenção.



38
39
40
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 38

def ad_rem_icms_reten
  @ad_rem_icms_reten
end

#cst ⇒ Object

Tributção pelo ICMS * 15 - Tributação monofásica própria e com responsabilidade pela retenção sobre combustíveis



23
24
25
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 23

def cst
  @cst
end

#mot_red_ad_rem ⇒ Object

Motivo da redução do adrem * 1 - Transporte coletivo de passageiros * 9 - Outros



47
48
49
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 47

def mot_red_ad_rem
  @mot_red_ad_rem
end

#orig ⇒ Object

Origem da mercadoria: * 0 - Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8; * 1 - Estrangeira - Importação direta, exceto a indicada no código 6; * 2 - Estrangeira - Adquirida no mercado interno, exceto a indicada no código 7; * 3 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40%% e inferior ou igual a 70%%; * 4 - Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam as legislações citadas nos Ajustes; * 5 - Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40%%; * 6 - Estrangeira - Importação direta, sem similar nacional, constante em lista da CAMEX e gás natural; * 7 - Estrangeira - Adquirida no mercado interno, sem similar nacional, constante lista CAMEX e gás natural; * 8 - Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70%%.



20
21
22
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 20

def orig
  @orig
end

#p_red_ad_rem ⇒ Object

Percentual de redução do valor da alíquota ad rem do ICMS.



44
45
46
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 44

def p_red_ad_rem
  @p_red_ad_rem
end

#q_bc_mono ⇒ Object

Quantidade tributada.



26
27
28
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 26

def q_bc_mono
  @q_bc_mono
end

#q_bc_mono_reten ⇒ Object

Quantidade tributada sujeita a retenção.



35
36
37
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 35

def q_bc_mono_reten
  @q_bc_mono_reten
end

#v_icms_mono ⇒ Object

Valor do ICMS próprio.



32
33
34
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 32

def v_icms_mono
  @v_icms_mono
end

#v_icms_mono_reten ⇒ Object

Valor do ICMS com retenção.



41
42
43
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 41

def v_icms_mono_reten
  @v_icms_mono_reten
end

Class Method Details

._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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 355

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(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
    # models (e.g. Pet) or oneOf
    klass = NuvemfiscalSdkRuby.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 50

def self.attribute_map
  {
    :'orig' => :'orig',
    :'cst' => :'CST',
    :'q_bc_mono' => :'qBCMono',
    :'ad_rem_icms' => :'adRemICMS',
    :'v_icms_mono' => :'vICMSMono',
    :'q_bc_mono_reten' => :'qBCMonoReten',
    :'ad_rem_icms_reten' => :'adRemICMSReten',
    :'v_icms_mono_reten' => :'vICMSMonoReten',
    :'p_red_ad_rem' => :'pRedAdRem',
    :'mot_red_ad_rem' => :'motRedAdRem'
  }
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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 331

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 87

def self.openapi_nullable
  Set.new([
    :'orig',
    :'cst',
    :'q_bc_mono',
    :'ad_rem_icms',
    :'v_icms_mono',
    :'q_bc_mono_reten',
    :'ad_rem_icms_reten',
    :'v_icms_mono_reten',
    :'p_red_ad_rem',
    :'mot_red_ad_rem'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 71

def self.openapi_types
  {
    :'orig' => :'Integer',
    :'cst' => :'String',
    :'q_bc_mono' => :'Float',
    :'ad_rem_icms' => :'Float',
    :'v_icms_mono' => :'Float',
    :'q_bc_mono_reten' => :'Float',
    :'ad_rem_icms_reten' => :'Float',
    :'v_icms_mono_reten' => :'Float',
    :'p_red_ad_rem' => :'Float',
    :'mot_red_ad_rem' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 301

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      orig == o.orig &&
      cst == o.cst &&
      q_bc_mono == o.q_bc_mono &&
      ad_rem_icms == o.ad_rem_icms &&
      v_icms_mono == o.v_icms_mono &&
      q_bc_mono_reten == o.q_bc_mono_reten &&
      ad_rem_icms_reten == o.ad_rem_icms_reten &&
      v_icms_mono_reten == o.v_icms_mono_reten &&
      p_red_ad_rem == o.p_red_ad_rem &&
      mot_red_ad_rem == o.mot_red_ad_rem
end

#_to_hash(value) ⇒ 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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 426

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


318
319
320
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 318

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



324
325
326
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 324

def hash
  [orig, cst, q_bc_mono, ad_rem_icms, v_icms_mono, q_bc_mono_reten, ad_rem_icms_reten, v_icms_mono_reten, p_red_ad_rem, mot_red_ad_rem].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 172

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@q_bc_mono.nil? && @q_bc_mono < 0
    invalid_properties.push('invalid value for "q_bc_mono", must be greater than or equal to 0.')
  end

  if @ad_rem_icms < 0
    invalid_properties.push('invalid value for "ad_rem_icms", must be greater than or equal to 0.')
  end

  if @v_icms_mono < 0
    invalid_properties.push('invalid value for "v_icms_mono", must be greater than or equal to 0.')
  end

  if !@q_bc_mono_reten.nil? && @q_bc_mono_reten < 0
    invalid_properties.push('invalid value for "q_bc_mono_reten", must be greater than or equal to 0.')
  end

  if @ad_rem_icms_reten < 0
    invalid_properties.push('invalid value for "ad_rem_icms_reten", must be greater than or equal to 0.')
  end

  if @v_icms_mono_reten < 0
    invalid_properties.push('invalid value for "v_icms_mono_reten", must be greater than or equal to 0.')
  end

  if !@p_red_ad_rem.nil? && @p_red_ad_rem > 1E+2
    invalid_properties.push('invalid value for "p_red_ad_rem", must be smaller than or equal to 1E+2.')
  end

  if !@p_red_ad_rem.nil? && @p_red_ad_rem < 0
    invalid_properties.push('invalid value for "p_red_ad_rem", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



402
403
404
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 402

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 408

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



396
397
398
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 396

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



212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms15.rb', line 212

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@q_bc_mono.nil? && @q_bc_mono < 0
  return false if @ad_rem_icms < 0
  return false if @v_icms_mono < 0
  return false if !@q_bc_mono_reten.nil? && @q_bc_mono_reten < 0
  return false if @ad_rem_icms_reten < 0
  return false if @v_icms_mono_reten < 0
  return false if !@p_red_ad_rem.nil? && @p_red_ad_rem > 1E+2
  return false if !@p_red_ad_rem.nil? && @p_red_ad_rem < 0
  true
end