Class: NuvemfiscalSdkRuby::NfcomSefazICMS20

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

Overview

Prestação sujeito à tributação com redução de BC do ICMS.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfcomSefazICMS20

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

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

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

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

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

Instance Attribute Details

#c_benef ⇒ Object

Código de Benefício Fiscal na UF aplicado ao item. Código de Benefício Fiscal utilizado pela UF, aplicado ao item.



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

def c_benef
  @c_benef
end

#cst ⇒ Object

Classificação Tributária do serviço. * 20 - tributação com BC reduzida do ICMS



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

def cst
  @cst
end

#p_fcp ⇒ Object

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



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

def p_fcp
  @p_fcp
end

#p_icms ⇒ Object

Alíquota do ICMS.



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

def p_icms
  @p_icms
end

#p_red_bc ⇒ Object

Percentual de redução da BC.



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

def p_red_bc
  @p_red_bc
end

#v_bc ⇒ Object

Valor da BC do ICMS.



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

def v_bc
  @v_bc
end

#v_fcp ⇒ Object

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



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

def v_fcp
  @v_fcp
end

#v_icms ⇒ Object

Valor do ICMS.



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

def v_icms
  @v_icms
end

#v_icms_deson ⇒ Object

Valor do ICMS de desoneração.



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

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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_icms20.rb', line 348

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/nfcom_sefaz_icms20.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/nfcom_sefaz_icms20.rb', line 47

def self.attribute_map
  {
    :'cst' => :'CST',
    :'p_red_bc' => :'pRedBC',
    :'v_bc' => :'vBC',
    :'p_icms' => :'pICMS',
    :'v_icms' => :'vICMS',
    :'v_icms_deson' => :'vICMSDeson',
    :'c_benef' => :'cBenef',
    :'p_fcp' => :'pFCP',
    :'v_fcp' => :'vFCP'
  }
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



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

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/nfcom_sefaz_icms20.rb', line 82

def self.openapi_nullable
  Set.new([
    :'cst',
    :'p_red_bc',
    :'v_bc',
    :'p_icms',
    :'v_icms',
    :'v_icms_deson',
    :'c_benef',
    :'p_fcp',
    :'v_fcp'
  ])
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/nfcom_sefaz_icms20.rb', line 67

def self.openapi_types
  {
    :'cst' => :'String',
    :'p_red_bc' => :'Float',
    :'v_bc' => :'Float',
    :'p_icms' => :'Float',
    :'v_icms' => :'Float',
    :'v_icms_deson' => :'Float',
    :'c_benef' => :'String',
    :'p_fcp' => :'Float',
    :'v_fcp' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_icms20.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cst == o.cst &&
      p_red_bc == o.p_red_bc &&
      v_bc == o.v_bc &&
      p_icms == o.p_icms &&
      v_icms == o.v_icms &&
      v_icms_deson == o.v_icms_deson &&
      c_benef == o.c_benef &&
      p_fcp == o.p_fcp &&
      v_fcp == o.v_fcp
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



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

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


311
312
313
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_icms20.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



317
318
319
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_icms20.rb', line 317

def hash
  [cst, p_red_bc, v_bc, p_icms, v_icms, v_icms_deson, c_benef, p_fcp, v_fcp].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



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

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

  if !@c_benef.nil? && @c_benef.to_s.length > 10
    invalid_properties.push('invalid value for "c_benef", the character length must be smaller than or equal to 10.')
  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

  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



395
396
397
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_icms20.rb', line 395

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



401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_icms20.rb', line 401

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



389
390
391
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_icms20.rb', line 389

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



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_icms20.rb', line 200

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @p_red_bc < 0
  return false if @v_bc < 0
  return false if @p_icms < 0
  return false if @v_icms < 0
  return false if !@v_icms_deson.nil? && @v_icms_deson < 0
  return false if !@c_benef.nil? && @c_benef.to_s.length > 10
  return false if !@p_fcp.nil? && @p_fcp < 0
  return false if !@v_fcp.nil? && @v_fcp < 0
  true
end