Class: NuvemfiscalSdkRuby::NfeSefazICMSPart

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

Overview

Partilha do ICMS entre a UF de origem e UF de destino ou a UF definida na legislação Operação interestadual para consumidor final com partilha do ICMS devido na operação entre a UF de origem e a UF do destinatário ou ou a UF definida na legislação. (Ex. UF da concessionária de entrega do veículos).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazICMSPart

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

  if attributes.key?(:'p_red_bc')
    self.p_red_bc = attributes[:'p_red_bc']
  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?(:'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_bcop')
    self.p_bcop = attributes[:'p_bcop']
  else
    self.p_bcop = nil
  end

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

Instance Attribute Details

#cst ⇒ Object

Tributação pelo ICMS * 10 - Tributada e com cobrança do ICMS por substituição tributária * 90 - Outros



23
24
25
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.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_icms_part.rb', line 26

def mod_bc
  @mod_bc
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) * 6 - Valor da Operação



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

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_icms_part.rb', line 20

def orig
  @orig
end

#p_bcop ⇒ Object

Percentual para determinação do valor da Base de Cálculo da operação própria.



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

def p_bcop
  @p_bcop
end

#p_fcpst ⇒ Object

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



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

def p_fcpst
  @p_fcpst
end

#p_icms ⇒ Object

Alíquota do ICMS.



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

def p_icms
  @p_icms
end

#p_icmsst ⇒ Object

Alíquota do ICMS ST.



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

def p_icmsst
  @p_icmsst
end

#p_mvast ⇒ Object

Percentual da Margem de Valor Adicionado ICMS ST.



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

def p_mvast
  @p_mvast
end

#p_red_bc ⇒ Object

Percentual de redução da BC.



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

def p_red_bc
  @p_red_bc
end

#p_red_bcst ⇒ Object

Percentual de redução da BC ICMS ST.



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

def p_red_bcst
  @p_red_bcst
end

#ufst ⇒ Object

Sigla da UF para qual é devido o ICMS ST da operação.



71
72
73
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 71

def ufst
  @ufst
end

#v_bc ⇒ Object

Valor da BC do ICMS.



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

def v_bc
  @v_bc
end

#v_bcfcpst ⇒ Object

Valor da Base de cálculo do FCP retido por substituicao tributaria.



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

def v_bcfcpst
  @v_bcfcpst
end

#v_bcst ⇒ Object

Valor da BC do ICMS ST.



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

def v_bcst
  @v_bcst
end

#v_fcpst ⇒ Object

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



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

def v_fcpst
  @v_fcpst
end

#v_icms ⇒ Object

Valor do ICMS.



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

def v_icms
  @v_icms
end

#v_icmsst ⇒ Object

Valor do ICMS ST.



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

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



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 536

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



98
99
100
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 74

def self.attribute_map
  {
    :'orig' => :'orig',
    :'cst' => :'CST',
    :'mod_bc' => :'modBC',
    :'v_bc' => :'vBC',
    :'p_red_bc' => :'pRedBC',
    :'p_icms' => :'pICMS',
    :'v_icms' => :'vICMS',
    :'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_bcop' => :'pBCOp',
    :'ufst' => :'UFST'
  }
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



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 512

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 127

def self.openapi_nullable
  Set.new([
    :'orig',
    :'cst',
    :'mod_bc',
    :'v_bc',
    :'p_red_bc',
    :'p_icms',
    :'v_icms',
    :'mod_bcst',
    :'p_mvast',
    :'p_red_bcst',
    :'v_bcst',
    :'p_icmsst',
    :'v_icmsst',
    :'v_bcfcpst',
    :'p_fcpst',
    :'v_fcpst',
    :'p_bcop',
    :'ufst'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 103

def self.openapi_types
  {
    :'orig' => :'Integer',
    :'cst' => :'String',
    :'mod_bc' => :'Integer',
    :'v_bc' => :'Float',
    :'p_red_bc' => :'Float',
    :'p_icms' => :'Float',
    :'v_icms' => :'Float',
    :'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_bcop' => :'Float',
    :'ufst' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 474

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      orig == o.orig &&
      cst == o.cst &&
      mod_bc == o.mod_bc &&
      v_bc == o.v_bc &&
      p_red_bc == o.p_red_bc &&
      p_icms == o.p_icms &&
      v_icms == o.v_icms &&
      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_bcop == o.p_bcop &&
      ufst == o.ufst
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



607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 607

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


499
500
501
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 499

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



505
506
507
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 505

def hash
  [orig, cst, mod_bc, v_bc, p_red_bc, p_icms, v_icms, mod_bcst, p_mvast, p_red_bcst, v_bcst, p_icmsst, v_icmsst, v_bcfcpst, p_fcpst, v_fcpst, p_bcop, ufst].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



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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 264

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

  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 @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 !@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_bcop < 0
    invalid_properties.push('invalid value for "p_bcop", 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



583
584
585
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 583

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



589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 589

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



577
578
579
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 577

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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icms_part.rb', line 324

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @v_bc < 0
  return false if !@p_red_bc.nil? && @p_red_bc < 0
  return false if @p_icms < 0
  return false if @v_icms < 0
  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_bcop < 0
  true
end