Class: NuvemfiscalSdkRuby::NfeSefazICMS51

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

Overview

Tributção pelo ICMS 51 - Diferimento. A exigência do preenchimento das informações do ICMS diferido fica à critério de cada UF.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazICMS51

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
201
202
203
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 146

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

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

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

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

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

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

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

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

  if attributes.key?(:'v_icms')
    self.v_icms = attributes[:'v_icms']
  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?(:'p_fcp_dif')
    self.p_fcp_dif = attributes[:'p_fcp_dif']
  end

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

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

Instance Attribute Details

#c_benef_rbc ⇒ Object

Código de Benefício Fiscal na UF aplicado ao item quando houver RBC.



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

def c_benef_rbc
  @c_benef_rbc
end

#cst ⇒ Object

Tributação pelo ICMS 51 - Tributação com Diferimento.



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

def cst
  @cst
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_icms51.rb', line 26

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

def orig
  @orig
end

#p_dif ⇒ Object

Percentual do diferemento.



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

def p_dif
  @p_dif
end

#p_fcp ⇒ Object

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



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

def p_fcp
  @p_fcp
end

#p_fcp_dif ⇒ Object

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



62
63
64
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 62

def p_fcp_dif
  @p_fcp_dif
end

#p_icms ⇒ Object

Alíquota do imposto.



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

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_icms51.rb', line 29

def p_red_bc
  @p_red_bc
end

#v_bc ⇒ Object

Valor da BC do ICMS.



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

def v_bc
  @v_bc
end

#v_bcfcp ⇒ Object

Valor da Base de cálculo do FCP.



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

def v_bcfcp
  @v_bcfcp
end

#v_fcp ⇒ Object

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



59
60
61
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 59

def v_fcp
  @v_fcp
end

#v_fcp_dif ⇒ Object

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



65
66
67
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 65

def v_fcp_dif
  @v_fcp_dif
end

#v_fcp_efet ⇒ Object

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



68
69
70
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 68

def v_fcp_efet
  @v_fcp_efet
end

#v_icms ⇒ Object

Valor do ICMS.



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

def v_icms
  @v_icms
end

#v_icms_dif ⇒ Object

Valor do ICMS da diferido.



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

def v_icms_dif
  @v_icms_dif
end

#v_icmsop ⇒ Object

Valor do ICMS da Operação.



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

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



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 514

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



94
95
96
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 71

def self.attribute_map
  {
    :'orig' => :'orig',
    :'cst' => :'CST',
    :'mod_bc' => :'modBC',
    :'p_red_bc' => :'pRedBC',
    :'c_benef_rbc' => :'cBenefRBC',
    :'v_bc' => :'vBC',
    :'p_icms' => :'pICMS',
    :'v_icmsop' => :'vICMSOp',
    :'p_dif' => :'pDif',
    :'v_icms_dif' => :'vICMSDif',
    :'v_icms' => :'vICMS',
    :'v_bcfcp' => :'vBCFCP',
    :'p_fcp' => :'pFCP',
    :'v_fcp' => :'vFCP',
    :'p_fcp_dif' => :'pFCPDif',
    :'v_fcp_dif' => :'vFCPDif',
    :'v_fcp_efet' => :'vFCPEfet'
  }
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



490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 490

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 122

def self.openapi_nullable
  Set.new([
    :'orig',
    :'cst',
    :'mod_bc',
    :'p_red_bc',
    :'c_benef_rbc',
    :'v_bc',
    :'p_icms',
    :'v_icmsop',
    :'p_dif',
    :'v_icms_dif',
    :'v_icms',
    :'v_bcfcp',
    :'p_fcp',
    :'v_fcp',
    :'p_fcp_dif',
    :'v_fcp_dif',
    :'v_fcp_efet'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'orig' => :'Integer',
    :'cst' => :'String',
    :'mod_bc' => :'Integer',
    :'p_red_bc' => :'Float',
    :'c_benef_rbc' => :'String',
    :'v_bc' => :'Float',
    :'p_icms' => :'Float',
    :'v_icmsop' => :'Float',
    :'p_dif' => :'Float',
    :'v_icms_dif' => :'Float',
    :'v_icms' => :'Float',
    :'v_bcfcp' => :'Float',
    :'p_fcp' => :'Float',
    :'v_fcp' => :'Float',
    :'p_fcp_dif' => :'Float',
    :'v_fcp_dif' => :'Float',
    :'v_fcp_efet' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 453

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 &&
      c_benef_rbc == o.c_benef_rbc &&
      v_bc == o.v_bc &&
      p_icms == o.p_icms &&
      v_icmsop == o.v_icmsop &&
      p_dif == o.p_dif &&
      v_icms_dif == o.v_icms_dif &&
      v_icms == o.v_icms &&
      v_bcfcp == o.v_bcfcp &&
      p_fcp == o.p_fcp &&
      v_fcp == o.v_fcp &&
      p_fcp_dif == o.p_fcp_dif &&
      v_fcp_dif == o.v_fcp_dif &&
      v_fcp_efet == o.v_fcp_efet
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



585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 585

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


477
478
479
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 477

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



483
484
485
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 483

def hash
  [orig, cst, mod_bc, p_red_bc, c_benef_rbc, v_bc, p_icms, v_icmsop, p_dif, v_icms_dif, v_icms, v_bcfcp, p_fcp, v_fcp, p_fcp_dif, v_fcp_dif, v_fcp_efet].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



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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 234

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

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

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

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

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

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

  if !@v_icms.nil? && @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 !@p_fcp_dif.nil? && @p_fcp_dif < 0
    invalid_properties.push('invalid value for "p_fcp_dif", must be greater than or equal to 0.')
  end

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

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



561
562
563
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 561

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



567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 567

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



555
556
557
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms51.rb', line 555

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@p_red_bc.nil? && @p_red_bc < 0
  return false if !@v_bc.nil? && @v_bc < 0
  return false if !@p_icms.nil? && @p_icms < 0
  return false if !@v_icmsop.nil? && @v_icmsop < 0
  return false if !@p_dif.nil? && @p_dif > 1E+2
  return false if !@p_dif.nil? && @p_dif < 0
  return false if !@v_icms_dif.nil? && @v_icms_dif < 0
  return false if !@v_icms.nil? && @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 !@p_fcp_dif.nil? && @p_fcp_dif < 0
  return false if !@v_fcp_dif.nil? && @v_fcp_dif < 0
  return false if !@v_fcp_efet.nil? && @v_fcp_efet < 0
  true
end