Class: NuvemfiscalSdkRuby::NfeSefazICMS20

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

Overview

Tributção pelo ICMS * 20 - Com redução de base de cálculo

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazICMS20

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 122

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cst ⇒ Object

Tributção pelo ICMS * 20 - Com redução de base de cálculo



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

def cst
  @cst
end

#ind_deduz_deson ⇒ Object

Indica se o valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd): * 0 - Valor do ICMS desonerado (vICMSDeson) não deduz do valor do item (vProd) / total da NF-e * 1 - Valor do ICMS desonerado (vICMSDeson) deduz do valor do item (vProd) / total da NF-e



56
57
58
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 56

def ind_deduz_deson
  @ind_deduz_deson
end

#mod_bc ⇒ Object

Modalidade de determinação da BC do ICMS: * 0 - Margem Valor Agregado (%%) * 1 - Pauta (valor) * 2 - Preço Tabelado Máximo (valor) * 3 - Valor da Operação



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

def mod_bc
  @mod_bc
end

#mot_des_icms ⇒ Object

Motivo da desoneração do ICMS:3-Uso na agropecuária * 9 - Outros * 12 - Fomento agropecuário



53
54
55
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 53

def mot_des_icms
  @mot_des_icms
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_icms20.rb', line 20

def orig
  @orig
end

#p_fcp ⇒ Object

Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).



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

def p_fcp
  @p_fcp
end

#p_icms ⇒ Object

Alíquota do ICMS.



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

def p_icms
  @p_icms
end

#p_red_bc ⇒ Object

Percentual de redução da BC.



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

def p_red_bc
  @p_red_bc
end

#v_bc ⇒ Object

Valor da BC do ICMS.



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

def v_bc
  @v_bc
end

#v_bcfcp ⇒ Object

Valor da Base de cálculo do FCP.



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

def v_bcfcp
  @v_bcfcp
end

#v_fcp ⇒ Object

Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).



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

def v_fcp
  @v_fcp
end

#v_icms ⇒ Object

Valor do ICMS.



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

def v_icms
  @v_icms
end

#v_icms_deson ⇒ Object

Valor do ICMS de desoneração.



50
51
52
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 50

def v_icms_deson
  @v_icms_deson
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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 396

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



78
79
80
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 59

def self.attribute_map
  {
    :'orig' => :'orig',
    :'cst' => :'CST',
    :'mod_bc' => :'modBC',
    :'p_red_bc' => :'pRedBC',
    :'v_bc' => :'vBC',
    :'p_icms' => :'pICMS',
    :'v_icms' => :'vICMS',
    :'v_bcfcp' => :'vBCFCP',
    :'p_fcp' => :'pFCP',
    :'v_fcp' => :'vFCP',
    :'v_icms_deson' => :'vICMSDeson',
    :'mot_des_icms' => :'motDesICMS',
    :'ind_deduz_deson' => :'indDeduzDeson'
  }
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



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 372

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 102

def self.openapi_nullable
  Set.new([
    :'orig',
    :'cst',
    :'mod_bc',
    :'p_red_bc',
    :'v_bc',
    :'p_icms',
    :'v_icms',
    :'v_bcfcp',
    :'p_fcp',
    :'v_fcp',
    :'v_icms_deson',
    :'mot_des_icms',
    :'ind_deduz_deson'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 83

def self.openapi_types
  {
    :'orig' => :'Integer',
    :'cst' => :'String',
    :'mod_bc' => :'Integer',
    :'p_red_bc' => :'Float',
    :'v_bc' => :'Float',
    :'p_icms' => :'Float',
    :'v_icms' => :'Float',
    :'v_bcfcp' => :'Float',
    :'p_fcp' => :'Float',
    :'v_fcp' => :'Float',
    :'v_icms_deson' => :'Float',
    :'mot_des_icms' => :'Integer',
    :'ind_deduz_deson' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 339

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      orig == o.orig &&
      cst == o.cst &&
      mod_bc == o.mod_bc &&
      p_red_bc == o.p_red_bc &&
      v_bc == o.v_bc &&
      p_icms == o.p_icms &&
      v_icms == o.v_icms &&
      v_bcfcp == o.v_bcfcp &&
      p_fcp == o.p_fcp &&
      v_fcp == o.v_fcp &&
      v_icms_deson == o.v_icms_deson &&
      mot_des_icms == o.mot_des_icms &&
      ind_deduz_deson == o.ind_deduz_deson
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



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 467

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


359
360
361
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 359

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



365
366
367
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 365

def hash
  [orig, cst, mod_bc, p_red_bc, v_bc, p_icms, v_icms, v_bcfcp, p_fcp, v_fcp, v_icms_deson, mot_des_icms, ind_deduz_deson].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



204
205
206
207
208
209
210
211
212
213
214
215
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 204

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

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

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

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

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

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

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

  if !@v_icms_deson.nil? && @v_icms_deson < 0
    invalid_properties.push('invalid value for "v_icms_deson", 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



443
444
445
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 443

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



449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 449

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



437
438
439
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 437

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



244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms20.rb', line 244

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @p_red_bc < 0
  return false if @v_bc < 0
  return false if @p_icms < 0
  return false if @v_icms < 0
  return false if !@v_bcfcp.nil? && @v_bcfcp < 0
  return false if !@p_fcp.nil? && @p_fcp < 0
  return false if !@v_fcp.nil? && @v_fcp < 0
  return false if !@v_icms_deson.nil? && @v_icms_deson < 0
  true
end