Class: NuvemfiscalSdkRuby::NfeSefazISSQNtot

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

Overview

Totais referentes ao ISSQN.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazISSQNtot

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 116

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#c_reg_tribObject

Código do regime especial de tributação.



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

def c_reg_trib
  @c_reg_trib
end

#d_competObject

Data da prestação do serviço (AAAA-MM-DD).



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

def d_compet
  @d_compet
end

#v_bcObject

Base de Cálculo do ISS.



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

def v_bc
  @v_bc
end

#v_cofinsObject

Valor do COFINS sobre serviços.



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

def v_cofins
  @v_cofins
end

#v_deducaoObject

Valor dedução para redução da base de cálculo.



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

def v_deducao
  @v_deducao
end

#v_desc_condObject

Valor desconto condicionado.



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

def v_desc_cond
  @v_desc_cond
end

#v_desc_incondObject

Valor desconto incondicionado.



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

def v_desc_incond
  @v_desc_incond
end

#v_issObject

Valor Total do ISS.



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

def v_iss
  @v_iss
end

#v_iss_retObject

Valor Total Retenção ISS.



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

def v_iss_ret
  @v_iss_ret
end

#v_outroObject

Valor outras retenções.



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

def v_outro
  @v_outro
end

#v_pisObject

Valor do PIS sobre serviços.



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

def v_pis
  @v_pis
end

#v_servObject

Valor Total dos Serviços sob não-incidência ou não tributados pelo ICMS.



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

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



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 403

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_attributesObject

Returns all the JSON keys this model knows about



74
75
76
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 56

def self.attribute_map
  {
    :'v_serv' => :'vServ',
    :'v_bc' => :'vBC',
    :'v_iss' => :'vISS',
    :'v_pis' => :'vPIS',
    :'v_cofins' => :'vCOFINS',
    :'d_compet' => :'dCompet',
    :'v_deducao' => :'vDeducao',
    :'v_outro' => :'vOutro',
    :'v_desc_incond' => :'vDescIncond',
    :'v_desc_cond' => :'vDescCond',
    :'v_iss_ret' => :'vISSRet',
    :'c_reg_trib' => :'cRegTrib'
  }
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



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 379

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_nullableObject

List of attributes with nullable: true



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 97

def self.openapi_nullable
  Set.new([
    :'v_serv',
    :'v_bc',
    :'v_iss',
    :'v_pis',
    :'v_cofins',
    :'d_compet',
    :'v_deducao',
    :'v_outro',
    :'v_desc_incond',
    :'v_desc_cond',
    :'v_iss_ret',
    :'c_reg_trib'
  ])
end

.openapi_typesObject

Attribute type mapping.



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

def self.openapi_types
  {
    :'v_serv' => :'Float',
    :'v_bc' => :'Float',
    :'v_iss' => :'Float',
    :'v_pis' => :'Float',
    :'v_cofins' => :'Float',
    :'d_compet' => :'Date',
    :'v_deducao' => :'Float',
    :'v_outro' => :'Float',
    :'v_desc_incond' => :'Float',
    :'v_desc_cond' => :'Float',
    :'v_iss_ret' => :'Float',
    :'c_reg_trib' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 347

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      v_serv == o.v_serv &&
      v_bc == o.v_bc &&
      v_iss == o.v_iss &&
      v_pis == o.v_pis &&
      v_cofins == o.v_cofins &&
      d_compet == o.d_compet &&
      v_deducao == o.v_deducao &&
      v_outro == o.v_outro &&
      v_desc_incond == o.v_desc_incond &&
      v_desc_cond == o.v_desc_cond &&
      v_iss_ret == o.v_iss_ret &&
      c_reg_trib == o.c_reg_trib
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



474
475
476
477
478
479
480
481
482
483
484
485
486
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 474

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


366
367
368
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 366

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



372
373
374
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 372

def hash
  [v_serv, v_bc, v_iss, v_pis, v_cofins, d_compet, v_deducao, v_outro, v_desc_incond, v_desc_cond, v_iss_ret, c_reg_trib].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



450
451
452
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 450

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



456
457
458
459
460
461
462
463
464
465
466
467
468
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 456

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



444
445
446
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 444

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issq_ntot.rb', line 230

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@v_serv.nil? && @v_serv <= 0
  return false if !@v_bc.nil? && @v_bc <= 0
  return false if !@v_iss.nil? && @v_iss <= 0
  return false if !@v_pis.nil? && @v_pis <= 0
  return false if !@v_cofins.nil? && @v_cofins <= 0
  return false if !@v_deducao.nil? && @v_deducao <= 0
  return false if !@v_outro.nil? && @v_outro <= 0
  return false if !@v_desc_incond.nil? && @v_desc_incond <= 0
  return false if !@v_desc_cond.nil? && @v_desc_cond <= 0
  return false if !@v_iss_ret.nil? && @v_iss_ret <= 0
  true
end