Class: NuvemfiscalSdkRuby::NfeSefazISSQN

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

Overview

ISSQN.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfeSefazISSQN

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 140

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#c_list_serv ⇒ Object

Informar o Item da lista de serviços da LC 116/03 em que se classifica o serviço.



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

def c_list_serv
  @c_list_serv
end

#c_mun ⇒ Object

Código do Município de Incidência do Imposto.



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

def c_mun
  @c_mun
end

#c_mun_fg ⇒ Object

Informar o município de ocorrência do fato gerador do ISSQN. Utilizar a Tabela do IBGE (Anexo VII - Tabela de UF, Município e País). “Atenção, não vincular com os campos B12, C10 ou E10” v2.0.



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

def c_mun_fg
  @c_mun_fg
end

#c_pais ⇒ Object

Código de Pais.



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

def c_pais
  @c_pais
end

#c_servico ⇒ Object

Código do serviço prestado dentro do município.



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

def c_servico
  @c_servico
end

#ind_incentivo ⇒ Object

Indicador de Incentivo Fiscal. 1=Sim * 2 - Não



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

def ind_incentivo
  @ind_incentivo
end

#ind_iss ⇒ Object

Exibilidade do ISS:1-Exigível * 2 - Não incidente * 3 - Isenção * 4 - Exportação * 5 - Imunidade * 6 - Exig.Susp. Judicial * 7 - Exig.Susp. ADM



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

def ind_iss
  @ind_iss
end

#n_processo ⇒ Object

Número do Processo administrativo ou judicial de suspenção do processo.



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

def n_processo
  @n_processo
end

#v_aliq ⇒ Object

Alíquota do ISSQN.



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

def v_aliq
  @v_aliq
end

#v_bc ⇒ Object

Valor da BC do ISSQN.



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

def v_bc
  @v_bc
end

#v_deducao ⇒ Object

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



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

def v_deducao
  @v_deducao
end

#v_desc_cond ⇒ Object

Valor desconto condicionado.



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

def v_desc_cond
  @v_desc_cond
end

#v_desc_incond ⇒ Object

Valor desconto incondicionado.



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

def v_desc_incond
  @v_desc_incond
end

#v_iss_ret ⇒ Object

Valor Retenção ISS.



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

def v_iss_ret
  @v_iss_ret
end

#v_issqn ⇒ Object

Valor da do ISSQN.



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

def v_issqn
  @v_issqn
end

#v_outro ⇒ Object

Valor outras retenções.



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

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



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 477

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



90
91
92
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 68

def self.attribute_map
  {
    :'v_bc' => :'vBC',
    :'v_aliq' => :'vAliq',
    :'v_issqn' => :'vISSQN',
    :'c_mun_fg' => :'cMunFG',
    :'c_list_serv' => :'cListServ',
    :'v_deducao' => :'vDeducao',
    :'v_outro' => :'vOutro',
    :'v_desc_incond' => :'vDescIncond',
    :'v_desc_cond' => :'vDescCond',
    :'v_iss_ret' => :'vISSRet',
    :'ind_iss' => :'indISS',
    :'c_servico' => :'cServico',
    :'c_mun' => :'cMun',
    :'c_pais' => :'cPais',
    :'n_processo' => :'nProcesso',
    :'ind_incentivo' => :'indIncentivo'
  }
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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 453

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 117

def self.openapi_nullable
  Set.new([
    :'v_bc',
    :'v_aliq',
    :'v_issqn',
    :'c_mun_fg',
    :'c_list_serv',
    :'v_deducao',
    :'v_outro',
    :'v_desc_incond',
    :'v_desc_cond',
    :'v_iss_ret',
    :'ind_iss',
    :'c_servico',
    :'c_mun',
    :'c_pais',
    :'n_processo',
    :'ind_incentivo'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'v_bc' => :'Float',
    :'v_aliq' => :'Float',
    :'v_issqn' => :'Float',
    :'c_mun_fg' => :'String',
    :'c_list_serv' => :'String',
    :'v_deducao' => :'Float',
    :'v_outro' => :'Float',
    :'v_desc_incond' => :'Float',
    :'v_desc_cond' => :'Float',
    :'v_iss_ret' => :'Float',
    :'ind_iss' => :'Integer',
    :'c_servico' => :'String',
    :'c_mun' => :'String',
    :'c_pais' => :'String',
    :'n_processo' => :'String',
    :'ind_incentivo' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 417

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      v_bc == o.v_bc &&
      v_aliq == o.v_aliq &&
      v_issqn == o.v_issqn &&
      c_mun_fg == o.c_mun_fg &&
      c_list_serv == o.c_list_serv &&
      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 &&
      ind_iss == o.ind_iss &&
      c_servico == o.c_servico &&
      c_mun == o.c_mun &&
      c_pais == o.c_pais &&
      n_processo == o.n_processo &&
      ind_incentivo == o.ind_incentivo
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



548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 548

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


440
441
442
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 440

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



446
447
448
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 446

def hash
  [v_bc, v_aliq, v_issqn, c_mun_fg, c_list_serv, v_deducao, v_outro, v_desc_incond, v_desc_cond, v_iss_ret, ind_iss, c_servico, c_mun, c_pais, n_processo, ind_incentivo].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



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
279
280
281
282
283
284
285
286
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 234

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 @v_aliq < 0
    invalid_properties.push('invalid value for "v_aliq", must be greater than or equal to 0.')
  end

  if @v_issqn < 0
    invalid_properties.push('invalid value for "v_issqn", must be greater than or equal to 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

  if !@c_servico.nil? && @c_servico.to_s.length > 20
    invalid_properties.push('invalid value for "c_servico", the character length must be smaller than or equal to 20.')
  end

  if !@c_servico.nil? && @c_servico.to_s.length < 1
    invalid_properties.push('invalid value for "c_servico", the character length must be great than or equal to 1.')
  end

  if !@n_processo.nil? && @n_processo.to_s.length > 30
    invalid_properties.push('invalid value for "n_processo", the character length must be smaller than or equal to 30.')
  end

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



524
525
526
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 524

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



530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 530

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



518
519
520
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 518

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfe_sefaz_issqn.rb', line 290

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @v_bc < 0
  return false if @v_aliq < 0
  return false if @v_issqn < 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
  return false if !@c_servico.nil? && @c_servico.to_s.length > 20
  return false if !@c_servico.nil? && @c_servico.to_s.length < 1
  return false if !@n_processo.nil? && @n_processo.to_s.length > 30
  return false if !@n_processo.nil? && @n_processo.to_s.length < 1
  true
end