Class: NuvemfiscalSdkRuby::NfeSefazICMSSN201

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

Overview

Tributação do ICMS pelo SIMPLES NACIONAL e CSOSN=201 (v.2.0).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazICMSSN201

Initializes the object



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#csosn ⇒ Object

  • 201 - Tributada pelo Simples Nacional com permissão de crédito e com cobrança do ICMS por Substituição Tributária (v.2.0)



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

def csosn
  @csosn
end

#mod_bcst ⇒ Object

Modalidade de determinação da BC do ICMS ST: * 0 - Preço tabelado ou máximo sugerido * 1 - Lista Negativa (valor) * 2 - Lista Positiva (valor) * 3 - Lista Neutra (valor) * 4 - Margem Valor Agregado (%%) * 5 - Pauta (valor). (v2.0) * 6 - Valor da Operação



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

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

def orig
  @orig
end

#p_cred_sn ⇒ Object

Alíquota aplicável de cálculo do crédito (Simples Nacional). (v2.0).



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

def p_cred_sn
  @p_cred_sn
end

#p_fcpst ⇒ Object

Percentual de FCP retido por substituição tributária.



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

def p_fcpst
  @p_fcpst
end

#p_icmsst ⇒ Object

Alíquota do ICMS ST (v2.0).



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

def p_icmsst
  @p_icmsst
end

#p_mvast ⇒ Object

Percentual da Margem de Valor Adicionado ICMS ST (v2.0).



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

def p_mvast
  @p_mvast
end

#p_red_bcst ⇒ Object

Percentual de redução da BC ICMS ST (v2.0).



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

def p_red_bcst
  @p_red_bcst
end

#v_bcfcpst ⇒ Object

Valor da Base de cálculo do FCP.



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

def v_bcfcpst
  @v_bcfcpst
end

#v_bcst ⇒ Object

Valor da BC do ICMS ST (v2.0).



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

def v_bcst
  @v_bcst
end

#v_cred_icmssn ⇒ Object

Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123 (Simples Nacional) (v2.0).



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

def v_cred_icmssn
  @v_cred_icmssn
end

#v_fcpst ⇒ Object

Valor do FCP retido por substituição tributária.



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

def v_fcpst
  @v_fcpst
end

#v_icmsst ⇒ Object

Valor do ICMS ST (v2.0).



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

def v_icmsst
  @v_icmsst
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 428

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_icmssn201.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_icmssn201.rb', line 59

def self.attribute_map
  {
    :'orig' => :'orig',
    :'csosn' => :'CSOSN',
    :'mod_bcst' => :'modBCST',
    :'p_mvast' => :'pMVAST',
    :'p_red_bcst' => :'pRedBCST',
    :'v_bcst' => :'vBCST',
    :'p_icmsst' => :'pICMSST',
    :'v_icmsst' => :'vICMSST',
    :'v_bcfcpst' => :'vBCFCPST',
    :'p_fcpst' => :'pFCPST',
    :'v_fcpst' => :'vFCPST',
    :'p_cred_sn' => :'pCredSN',
    :'v_cred_icmssn' => :'vCredICMSSN'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 404

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_icmssn201.rb', line 102

def self.openapi_nullable
  Set.new([
    :'orig',
    :'csosn',
    :'mod_bcst',
    :'p_mvast',
    :'p_red_bcst',
    :'v_bcst',
    :'p_icmsst',
    :'v_icmsst',
    :'v_bcfcpst',
    :'p_fcpst',
    :'v_fcpst',
    :'p_cred_sn',
    :'v_cred_icmssn'
  ])
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_icmssn201.rb', line 83

def self.openapi_types
  {
    :'orig' => :'Integer',
    :'csosn' => :'String',
    :'mod_bcst' => :'Integer',
    :'p_mvast' => :'Float',
    :'p_red_bcst' => :'Float',
    :'v_bcst' => :'Float',
    :'p_icmsst' => :'Float',
    :'v_icmsst' => :'Float',
    :'v_bcfcpst' => :'Float',
    :'p_fcpst' => :'Float',
    :'v_fcpst' => :'Float',
    :'p_cred_sn' => :'Float',
    :'v_cred_icmssn' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      orig == o.orig &&
      csosn == o.csosn &&
      mod_bcst == o.mod_bcst &&
      p_mvast == o.p_mvast &&
      p_red_bcst == o.p_red_bcst &&
      v_bcst == o.v_bcst &&
      p_icmsst == o.p_icmsst &&
      v_icmsst == o.v_icmsst &&
      v_bcfcpst == o.v_bcfcpst &&
      p_fcpst == o.p_fcpst &&
      v_fcpst == o.v_fcpst &&
      p_cred_sn == o.p_cred_sn &&
      v_cred_icmssn == o.v_cred_icmssn
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 499

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

See Also:

  • `==` method


391
392
393
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 391

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



397
398
399
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 397

def hash
  [orig, csosn, mod_bcst, p_mvast, p_red_bcst, v_bcst, p_icmsst, v_icmsst, v_bcfcpst, p_fcpst, v_fcpst, p_cred_sn, v_cred_icmssn].hash
end

#list_invalid_properties ⇒ Object

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



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
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 206

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

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

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

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

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

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

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

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

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

  if @v_cred_icmssn < 0
    invalid_properties.push('invalid value for "v_cred_icmssn", 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)



475
476
477
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 475

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 481

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



469
470
471
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 469

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmssn201.rb', line 254

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@p_mvast.nil? && @p_mvast < 0
  return false if !@p_red_bcst.nil? && @p_red_bcst < 0
  return false if @v_bcst < 0
  return false if @p_icmsst < 0
  return false if @v_icmsst < 0
  return false if !@v_bcfcpst.nil? && @v_bcfcpst < 0
  return false if !@p_fcpst.nil? && @p_fcpst < 0
  return false if !@v_fcpst.nil? && @v_fcpst < 0
  return false if @p_cred_sn < 0
  return false if @v_cred_icmssn < 0
  true
end