Class: NuvemfiscalSdkRuby::NfeSefazICMSST

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

Overview

Grupo de informação do ICMSST devido para a UF de destino, nas operações interestaduais de produtos que tiveram retenção antecipada de ICMS por ST na UF do remetente. Repasse via Substituto Tributário.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazICMSST

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#cst ⇒ Object

Tributção pelo ICMS * 41 - Não Tributado * 60 - Cobrado anteriormente por substituição tributária



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

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

def orig
  @orig
end

#p_fcpst_ret ⇒ Object

Percentual relativo ao Fundo de Combate à Pobreza (FCP) retido por substituição tributária.



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

def p_fcpst_ret
  @p_fcpst_ret
end

#p_icms_efet ⇒ Object

Alíquota do ICMS efetivo.



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

def p_icms_efet
  @p_icms_efet
end

#p_red_bc_efet ⇒ Object

Percentual de redução da base de cálculo efetiva.



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

def p_red_bc_efet
  @p_red_bc_efet
end

#p_st ⇒ Object

Aliquota suportada pelo consumidor final.



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

def p_st
  @p_st
end

#v_bc_efet ⇒ Object

Valor da base de cálculo efetiva.



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

def v_bc_efet
  @v_bc_efet
end

#v_bcfcpst_ret ⇒ Object

Informar o valor da Base de Cálculo do FCP retido anteriormente por ST.



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

def v_bcfcpst_ret
  @v_bcfcpst_ret
end

#v_bcst_dest ⇒ Object

Informar o valor da BC do ICMS ST da UF destino.



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

def v_bcst_dest
  @v_bcst_dest
end

#v_bcst_ret ⇒ Object

Informar o valor da BC do ICMS ST retido na UF remetente.



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

def v_bcst_ret
  @v_bcst_ret
end

#v_fcpst_ret ⇒ Object

Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) retido por substituição tributária.



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

def v_fcpst_ret
  @v_fcpst_ret
end

#v_icms_efet ⇒ Object

Valor do ICMS efetivo.



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

def v_icms_efet
  @v_icms_efet
end

#v_icms_substituto ⇒ Object

Valor do ICMS Próprio do Substituto cobrado em operação anterior.



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

def v_icms_substituto
  @v_icms_substituto
end

#v_icmsst_dest ⇒ Object

Informar o valor da BC do ICMS ST da UF destino (v2.0).



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

def v_icmsst_dest
  @v_icmsst_dest
end

#v_icmsst_ret ⇒ Object

Informar o valor do ICMS ST retido na UF remetente (iv2.0)).



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

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



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 491

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



86
87
88
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 65

def self.attribute_map
  {
    :'orig' => :'orig',
    :'cst' => :'CST',
    :'v_bcst_ret' => :'vBCSTRet',
    :'p_st' => :'pST',
    :'v_icms_substituto' => :'vICMSSubstituto',
    :'v_icmsst_ret' => :'vICMSSTRet',
    :'v_bcfcpst_ret' => :'vBCFCPSTRet',
    :'p_fcpst_ret' => :'pFCPSTRet',
    :'v_fcpst_ret' => :'vFCPSTRet',
    :'v_bcst_dest' => :'vBCSTDest',
    :'v_icmsst_dest' => :'vICMSSTDest',
    :'p_red_bc_efet' => :'pRedBCEfet',
    :'v_bc_efet' => :'vBCEfet',
    :'p_icms_efet' => :'pICMSEfet',
    :'v_icms_efet' => :'vICMSEfet'
  }
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



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 467

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 112

def self.openapi_nullable
  Set.new([
    :'orig',
    :'cst',
    :'v_bcst_ret',
    :'p_st',
    :'v_icms_substituto',
    :'v_icmsst_ret',
    :'v_bcfcpst_ret',
    :'p_fcpst_ret',
    :'v_fcpst_ret',
    :'v_bcst_dest',
    :'v_icmsst_dest',
    :'p_red_bc_efet',
    :'v_bc_efet',
    :'p_icms_efet',
    :'v_icms_efet'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 91

def self.openapi_types
  {
    :'orig' => :'Integer',
    :'cst' => :'String',
    :'v_bcst_ret' => :'Float',
    :'p_st' => :'Float',
    :'v_icms_substituto' => :'Float',
    :'v_icmsst_ret' => :'Float',
    :'v_bcfcpst_ret' => :'Float',
    :'p_fcpst_ret' => :'Float',
    :'v_fcpst_ret' => :'Float',
    :'v_bcst_dest' => :'Float',
    :'v_icmsst_dest' => :'Float',
    :'p_red_bc_efet' => :'Float',
    :'v_bc_efet' => :'Float',
    :'p_icms_efet' => :'Float',
    :'v_icms_efet' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 432

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      orig == o.orig &&
      cst == o.cst &&
      v_bcst_ret == o.v_bcst_ret &&
      p_st == o.p_st &&
      v_icms_substituto == o.v_icms_substituto &&
      v_icmsst_ret == o.v_icmsst_ret &&
      v_bcfcpst_ret == o.v_bcfcpst_ret &&
      p_fcpst_ret == o.p_fcpst_ret &&
      v_fcpst_ret == o.v_fcpst_ret &&
      v_bcst_dest == o.v_bcst_dest &&
      v_icmsst_dest == o.v_icmsst_dest &&
      p_red_bc_efet == o.p_red_bc_efet &&
      v_bc_efet == o.v_bc_efet &&
      p_icms_efet == o.p_icms_efet &&
      v_icms_efet == o.v_icms_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



562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 562

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


454
455
456
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 454

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



460
461
462
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 460

def hash
  [orig, cst, v_bcst_ret, p_st, v_icms_substituto, v_icmsst_ret, v_bcfcpst_ret, p_fcpst_ret, v_fcpst_ret, v_bcst_dest, v_icmsst_dest, p_red_bc_efet, v_bc_efet, p_icms_efet, v_icms_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



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
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 222

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

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

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

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

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

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

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

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

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

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

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

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

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



538
539
540
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 538

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



544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 544

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



532
533
534
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 532

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsst.rb', line 282

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @v_bcst_ret < 0
  return false if !@p_st.nil? && @p_st < 0
  return false if !@v_icms_substituto.nil? && @v_icms_substituto < 0
  return false if @v_icmsst_ret < 0
  return false if !@v_bcfcpst_ret.nil? && @v_bcfcpst_ret < 0
  return false if !@p_fcpst_ret.nil? && @p_fcpst_ret < 0
  return false if !@v_fcpst_ret.nil? && @v_fcpst_ret < 0
  return false if @v_bcst_dest < 0
  return false if @v_icmsst_dest < 0
  return false if !@p_red_bc_efet.nil? && @p_red_bc_efet < 0
  return false if !@v_bc_efet.nil? && @v_bc_efet < 0
  return false if !@p_icms_efet.nil? && @p_icms_efet < 0
  return false if !@v_icms_efet.nil? && @v_icms_efet < 0
  true
end