Class: NuvemfiscalSdkRuby::NfcomSefazIde

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

Overview

Identificação da NFCom.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NfcomSefazIde

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
261
262
263
264
265
266
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 158

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#c_dv ⇒ Object

Digito verificador da chave de acesso. Informar o dígito de controle da chave de acesso documento fiscal, que deve ser calculado com a aplicação do algoritmo módulo 11 (base 2,9) da chave de acesso. *Geramos automaticamente quando nenhum valor é informado.*



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

def c_dv
  @c_dv
end

#c_mun_fg ⇒ Object

Código do município de ocorrência do fato gerador.



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

def c_mun_fg
  @c_mun_fg
end

#c_nf ⇒ Object

Código numérico que compõe a Chave de Acesso. Código aleatório gerado pelo emitente, com o objetivo de evitar acessos indevidos ao documento. *Geramos automaticamente quando nenhum valor é informado.*



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

def c_nf
  @c_nf
end

#c_uf ⇒ Object

Código da UF de emissão e autorização da NFCom. Código da UF de emissão e autorização do Documento Fiscal. Utilizar a Tabela do IBGE de código de unidades da federação.



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

def c_uf
  @c_uf
end

#dh_cont ⇒ Object

Data e Hora da entrada em contingência. Informar a data e hora no formato AAAA-MM-DDTHH:MM:SS.



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

def dh_cont
  @dh_cont
end

#dh_emi ⇒ Object

Data e hora de emissão do documento fiscal. Formato AAAA-MM-DDTHH:MM:DD TZD.



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

def dh_emi
  @dh_emi
end

#fin_nf_com ⇒ Object

Finalidade de emissão da NFCom. * 0 - NFCom Normal * 3 - NFCom de Substituição * 4 - NFCom de Ajuste



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

def fin_nf_com
  @fin_nf_com
end

#ind_cessao_meios_rede ⇒ Object

Indicador de Sessão de Meios de Rede. Uma vez informado (valor = 1), essa tag dispensa geração do grupo Fatura. Apenas para notas dos tipos Normal e Substituição com tipo de faturamento normal.



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

def ind_cessao_meios_rede
  @ind_cessao_meios_rede
end

#ind_nota_entrada ⇒ Object

Indicador de nota de entrada. * 1 - Informar quando for nota de ajuste e possuir itens com CFOP de entrada



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

def ind_nota_entrada
  @ind_nota_entrada
end

#ind_pre_pago ⇒ Object

Indicador de serviço pré-pago. * 1 - Serviço pré-pago (informar a tag somente se a nota for referente a um serviço exclusivamente pré-pago)



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

def ind_pre_pago
  @ind_pre_pago
end

#mod ⇒ Object

Modelo da NFCom. Utilizar o código 62 para identificação da NFCom.



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

def mod
  @mod
end

#n_nf ⇒ Object

Número do documento fiscal. Número que identifica o documento fiscal 1 a 999999999.



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

def n_nf
  @n_nf
end

#n_site_autoriz ⇒ Object

Identificação do número do Site do Autorizador de recepção da NFCom. Se o autorizador da NFCom possuir apenas um site deverá ser informado com Zero (0), em caso de Autorizador trabalhar com múltiplos sites indicar o número do site para qual foi endereçada a NFCOM (1 a 9). Observação: o ambiente autorizador que trabalhar com mais de um Site deverá divulgar para cada endereço de site qual número correspondente de nSiteAutoriz o contribuinte pode usar.



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

def n_site_autoriz
  @n_site_autoriz
end

#serie ⇒ Object

Série do documento fiscal. Informar a série do documento fiscal (informar zero para série única).



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

def serie
  @serie
end

#tp_amb ⇒ Object

Tipo do Ambiente: * 1 - Produção * 2 - Homologação



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

def tp_amb
  @tp_amb
end

#tp_emis ⇒ Object

Forma de emissão do Documento Fiscal. * 1 - Normal * 2 - Contingência



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

def tp_emis
  @tp_emis
end

#tp_fat ⇒ Object

Tipo de Faturamento da NFCom. * 0 - Faturamento Normal * 1 - Faturamento centralizado * 2 - Cofaturamento



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

def tp_fat
  @tp_fat
end

#ver_proc ⇒ Object

Versão do processo de emissão. Informar a versão do aplicativo emissor de NFCom.



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

def ver_proc
  @ver_proc
end

#x_just ⇒ Object

Justificativa da entrada em contingência.



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

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



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 492

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



102
103
104
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 102

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 77

def self.attribute_map
  {
    :'c_uf' => :'cUF',
    :'tp_amb' => :'tpAmb',
    :'mod' => :'mod',
    :'serie' => :'serie',
    :'n_nf' => :'nNF',
    :'c_nf' => :'cNF',
    :'c_dv' => :'cDV',
    :'dh_emi' => :'dhEmi',
    :'tp_emis' => :'tpEmis',
    :'n_site_autoriz' => :'nSiteAutoriz',
    :'c_mun_fg' => :'cMunFG',
    :'fin_nf_com' => :'finNFCom',
    :'tp_fat' => :'tpFat',
    :'ver_proc' => :'verProc',
    :'ind_pre_pago' => :'indPrePago',
    :'ind_cessao_meios_rede' => :'indCessaoMeiosRede',
    :'ind_nota_entrada' => :'indNotaEntrada',
    :'dh_cont' => :'dhCont',
    :'x_just' => :'xJust'
  }
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



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 468

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 132

def self.openapi_nullable
  Set.new([
    :'c_uf',
    :'tp_amb',
    :'mod',
    :'serie',
    :'n_nf',
    :'c_nf',
    :'c_dv',
    :'dh_emi',
    :'tp_emis',
    :'n_site_autoriz',
    :'c_mun_fg',
    :'fin_nf_com',
    :'tp_fat',
    :'ver_proc',
    :'ind_pre_pago',
    :'ind_cessao_meios_rede',
    :'ind_nota_entrada',
    :'dh_cont',
    :'x_just'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 107

def self.openapi_types
  {
    :'c_uf' => :'Integer',
    :'tp_amb' => :'Integer',
    :'mod' => :'Integer',
    :'serie' => :'Integer',
    :'n_nf' => :'Integer',
    :'c_nf' => :'String',
    :'c_dv' => :'Integer',
    :'dh_emi' => :'Time',
    :'tp_emis' => :'Integer',
    :'n_site_autoriz' => :'Integer',
    :'c_mun_fg' => :'String',
    :'fin_nf_com' => :'Integer',
    :'tp_fat' => :'Integer',
    :'ver_proc' => :'String',
    :'ind_pre_pago' => :'Integer',
    :'ind_cessao_meios_rede' => :'Integer',
    :'ind_nota_entrada' => :'Integer',
    :'dh_cont' => :'Time',
    :'x_just' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 429

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      c_uf == o.c_uf &&
      tp_amb == o.tp_amb &&
      mod == o.mod &&
      serie == o.serie &&
      n_nf == o.n_nf &&
      c_nf == o.c_nf &&
      c_dv == o.c_dv &&
      dh_emi == o.dh_emi &&
      tp_emis == o.tp_emis &&
      n_site_autoriz == o.n_site_autoriz &&
      c_mun_fg == o.c_mun_fg &&
      fin_nf_com == o.fin_nf_com &&
      tp_fat == o.tp_fat &&
      ver_proc == o.ver_proc &&
      ind_pre_pago == o.ind_pre_pago &&
      ind_cessao_meios_rede == o.ind_cessao_meios_rede &&
      ind_nota_entrada == o.ind_nota_entrada &&
      dh_cont == o.dh_cont &&
      x_just == o.x_just
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



563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 563

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


455
456
457
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 455

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



461
462
463
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 461

def hash
  [c_uf, tp_amb, mod, serie, n_nf, c_nf, c_dv, dh_emi, tp_emis, n_site_autoriz, c_mun_fg, fin_nf_com, tp_fat, ver_proc, ind_pre_pago, ind_cessao_meios_rede, ind_nota_entrada, dh_cont, x_just].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



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
321
322
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 270

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

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

  if @n_nf > 999999999
    invalid_properties.push('invalid value for "n_nf", must be smaller than or equal to 999999999.')
  end

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

  if !@c_dv.nil? && @c_dv > 9
    invalid_properties.push('invalid value for "c_dv", must be smaller than or equal to 9.')
  end

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

  if @n_site_autoriz > 9
    invalid_properties.push('invalid value for "n_site_autoriz", must be smaller than or equal to 9.')
  end

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

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

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

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

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



539
540
541
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 539

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



545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 545

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



533
534
535
 
# File 'lib/nuvemfiscal_sdk_ruby/models/nfcom_sefaz_ide.rb', line 533

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @serie > 999
  return false if @serie < 0
  return false if @n_nf > 999999999
  return false if @n_nf < 1
  return false if !@c_dv.nil? && @c_dv > 9
  return false if !@c_dv.nil? && @c_dv < 0
  return false if @n_site_autoriz > 9
  return false if @n_site_autoriz < 0
  return false if @ver_proc.to_s.length > 20
  return false if @ver_proc.to_s.length < 1
  return false if !@x_just.nil? && @x_just.to_s.length > 256
  return false if !@x_just.nil? && @x_just.to_s.length < 15
  true
end