Class: NuvemfiscalSdkRuby::NfeSefazICMSUFDest

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

Overview

Grupo a ser informado nas vendas interestarduais para consumidor final, não contribuinte de ICMS.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazICMSUFDest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 98

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#p_fcpuf_dest ⇒ Object

Percentual adicional inserido na alíquota interna da UF de destino, relativo ao Fundo de Combate à Pobreza (FCP) naquela UF.



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

def p_fcpuf_dest
  @p_fcpuf_dest
end

#p_icms_inter ⇒ Object

Alíquota interestadual das UF envolvidas: * 4%% alíquota interestadual para produtos importados * 7%% para os Estados de origem do Sul e Sudeste (exceto ES), destinado para os Estados do Norte e Nordeste ou ES * 12%% para os demais casos.



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

def p_icms_inter
  @p_icms_inter
end

#p_icms_inter_part ⇒ Object

Percentual de partilha para a UF do destinatário: * 40%% em 2016 * 60%% em 2017 * 80%% em 2018 * 100%% a partir de 2019.



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

def p_icms_inter_part
  @p_icms_inter_part
end

#p_icmsuf_dest ⇒ Object

Alíquota adotada nas operações internas na UF do destinatário para o produto / mercadoria.



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

def p_icmsuf_dest
  @p_icmsuf_dest
end

#v_bcfcpuf_dest ⇒ Object

Valor da Base de Cálculo do FCP na UF do destinatário.



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

def v_bcfcpuf_dest
  @v_bcfcpuf_dest
end

#v_bcuf_dest ⇒ Object

Valor da Base de Cálculo do ICMS na UF do destinatário.



20
21
22
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 20

def v_bcuf_dest
  @v_bcuf_dest
end

#v_fcpuf_dest ⇒ Object

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



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

def v_fcpuf_dest
  @v_fcpuf_dest
end

#v_icmsuf_dest ⇒ Object

Valor do ICMS de partilha para a UF do destinatário.



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

def v_icmsuf_dest
  @v_icmsuf_dest
end

#v_icmsuf_remet ⇒ Object

Valor do ICMS de partilha para a UF do remetente. Nota: A partir de 2019, este valor será zero.



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

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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 365

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 47

def self.attribute_map
  {
    :'v_bcuf_dest' => :'vBCUFDest',
    :'v_bcfcpuf_dest' => :'vBCFCPUFDest',
    :'p_fcpuf_dest' => :'pFCPUFDest',
    :'p_icmsuf_dest' => :'pICMSUFDest',
    :'p_icms_inter' => :'pICMSInter',
    :'p_icms_inter_part' => :'pICMSInterPart',
    :'v_fcpuf_dest' => :'vFCPUFDest',
    :'v_icmsuf_dest' => :'vICMSUFDest',
    :'v_icmsuf_remet' => :'vICMSUFRemet'
  }
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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 341

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



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 82

def self.openapi_nullable
  Set.new([
    :'v_bcuf_dest',
    :'v_bcfcpuf_dest',
    :'p_fcpuf_dest',
    :'p_icmsuf_dest',
    :'p_icms_inter',
    :'p_icms_inter_part',
    :'v_fcpuf_dest',
    :'v_icmsuf_dest',
    :'v_icmsuf_remet'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 67

def self.openapi_types
  {
    :'v_bcuf_dest' => :'Float',
    :'v_bcfcpuf_dest' => :'Float',
    :'p_fcpuf_dest' => :'Float',
    :'p_icmsuf_dest' => :'Float',
    :'p_icms_inter' => :'Float',
    :'p_icms_inter_part' => :'Float',
    :'v_fcpuf_dest' => :'Float',
    :'v_icmsuf_dest' => :'Float',
    :'v_icmsuf_remet' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 312

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      v_bcuf_dest == o.v_bcuf_dest &&
      v_bcfcpuf_dest == o.v_bcfcpuf_dest &&
      p_fcpuf_dest == o.p_fcpuf_dest &&
      p_icmsuf_dest == o.p_icmsuf_dest &&
      p_icms_inter == o.p_icms_inter &&
      p_icms_inter_part == o.p_icms_inter_part &&
      v_fcpuf_dest == o.v_fcpuf_dest &&
      v_icmsuf_dest == o.v_icmsuf_dest &&
      v_icmsuf_remet == o.v_icmsuf_remet
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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 436

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


328
329
330
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 328

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



334
335
336
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 334

def hash
  [v_bcuf_dest, v_bcfcpuf_dest, p_fcpuf_dest, p_icmsuf_dest, p_icms_inter, p_icms_inter_part, v_fcpuf_dest, v_icmsuf_dest, v_icmsuf_remet].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



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_icmsuf_dest.rb', line 162

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

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

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

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

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

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

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

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

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



412
413
414
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 412

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 418

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



406
407
408
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 406

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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_icmsuf_dest.rb', line 206

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @v_bcuf_dest < 0
  return false if !@v_bcfcpuf_dest.nil? && @v_bcfcpuf_dest < 0
  return false if !@p_fcpuf_dest.nil? && @p_fcpuf_dest < 0
  return false if @p_icmsuf_dest < 0
  return false if @p_icms_inter < 0
  return false if @p_icms_inter_part < 0
  return false if !@v_fcpuf_dest.nil? && @v_fcpuf_dest < 0
  return false if @v_icmsuf_dest < 0
  return false if @v_icmsuf_remet < 0
  true
end