Class: Nfcom::Models::Item

Inherits:
Object
  • Object
show all
Includes:
Utils::Helpers
Defined in:
lib/nfcom/models/item.rb

Overview

Representa um item (serviço) da NF-COM

Cada item correspone a um serviço de comunicação/telecomunicação prestado ao cliente, como plano de internet, TV por assinatura, etc.

Códigos de Serviço (Telecomunicações):

  • ‘0303’ - Serviço de Internet

  • ‘0304’ - TV por Assinatura

  • ‘0305’ - Telefonia

Classes de Consumo (mesmos códigos):

  • ‘0303’ - Internet

  • ‘0304’ - TV

  • ‘0305’ - Telefonia

CFOPs comuns:

  • ‘5307’ - Prestação de serviço de comunicação (dentro do estado)

  • ‘6307’ - Prestação de serviço de comunicação (fora do estado)

Atributos obrigatórios:

  • codigo_servico (código do serviço de telecomunicação)

  • descricao (descrição do serviço/plano)

  • classe_consumo (classificação do consumo)

  • cfop (Código Fiscal de Operações)

  • valor_unitario (valor do serviço, maior que zero)

  • quantidade (quantidade de unidades, padrão: 1)

Atributos opcionais:

  • valor_desconto (desconto aplicado, padrão: 0.00)

  • valor_outras_despesas (outras despesas acessórias, padrão: 0.00)

  • unidade (unidade de medida, padrão: ‘UN’)

  • codigo_beneficio_fiscal (código de benefício fiscal, se aplicável)

Cálculo automático:

  • valor_total = (quantidade x valor_unitario) - valor_desconto + valor_outras_despesas

  • O número do item é atribuído automaticamente ao adicionar na nota

Validações automáticas:

  • Todos os campos obrigatórios devem estar presentes

  • Valor unitário deve ser maior que zero

  • Quantidade deve ser maior que zero

Examples:

Adicionar item de internet à nota

nota = Nfcom::Models::Nota.new

nota.add_item(
  codigo_servico: '0303',
  descricao: 'Plano Fibra 100MB',
  classe_consumo: '0303',
  cfop: '5307',
  unidade: 'UN',
  quantidade: 1,
  valor_unitario: 99.90
)

Item com desconto

nota.add_item(
  codigo_servico: '0303',
  descricao: 'Plano Fibra 200MB',
  classe_consumo: '0303',
  cfop: '5307',
  valor_unitario: 149.90,
  valor_desconto: 20.00  # Desconto promocional
)
# Valor total = 149.90 - 20.00 = 129.90

Múltiplos serviços na mesma nota

# Internet
nota.add_item(
  codigo_servico: '0303',
  descricao: 'Internet 100MB',
  classe_consumo: '0303',
  cfop: '5307',
  valor_unitario: 99.90
)

# TV por assinatura
nota.add_item(
  codigo_servico: '0304',
  descricao: 'TV Premium',
  classe_consumo: '0304',
  cfop: '5307',
  valor_unitario: 79.90
)

Constant Summary collapse

CODIGOS_SERVICO =

Códigos de serviço principais para provedor de internet

{
  internet: '0303',
  tv_assinatura: '0304',
  telefonia: '0305'
}.freeze
CLASSES_CONSUMO = 
{
  # Grupo 010 - Assinatura
  assinatura_telefonia: '0100101',
  assinatura_dados: '0100201',
  assinatura_tv: '0100301',
  assinatura_multimidia: '0100401',

  # Grupo 020 - Habilitação
  habilitacao_telefonia: '0200101',
  habilitacao_dados: '0200201',
  habilitacao_tv: '0200301',

  # Grupo 030 - Serviço Medido
  medido_chamadas_locais: '0300101',
  medido_longa_distancia_nacional: '0300102',
  medido_longa_distancia_internacional: '0300103',
  medido_roaming_originadas: '0300104',
  medido_roaming_recebidas: '0300105',
  medido_adicional_chamada: '0300106',
  medido_numeros_especiais: '0300107',
  medido_sms: '0300108',
  medido_mms: '0300109',
  medido_dados: '0300201',
  medido_pay_per_view: '0300301',
  medido_multimidia: '0300401',

  # Grupo 040 - Serviço Não Medido
  nao_medido_telefonia: '0400101',
  nao_medido_dados: '0400201',
  nao_medido_tv: '0400301',
  nao_medido_internet: '0400401',
  nao_medido_multimidia: '0400501',

  # Grupo 045 - Serviços Combinados
  combinados_voz_dados_mensagens: '0450101',

  # Grupo 050 - Serviço Pré-pago
  prepago_cartao_telefone_fixo: '0500101',
  prepago_recarga_fixo: '0500102',
  prepago_recarga_movel: '0500201',
  prepago_recarga_scm: '0500301',
  prepago_recarga_tv: '0500401',
  prepago_antecipacao: '0500501',
  prepago_repasse: '0500601',

  # Grupo 060 - Outros Serviços
  outros_facilidades: '0600101',
  outros_streaming: '0600201',
  outros_rastreamento: '0600301',
  outros_publicidade: '0600401',
  outros_publicidade_radio_tv: '0600402',
  outros_gerais: '0600501',
  outros_valor_adicionado: '0600601',

  # Grupo 070 - Cessão Meios de Rede
  cessao_interconexao: '0700101',
  cessao_roaming: '0700201',
  cessao_eild: '0700301',
  cessao_icms_proporcional: '0700401',
  cessao_icms_consumo_proprio: '0700501',
  cessao_icms_complementar: '0700601',

  # Grupo 080 - Disponibilização de Equipamentos
  equip_telefone: '0800101',
  equip_identificador: '0800201',
  equip_modem: '0800301',
  equip_rack: '0800401',
  equip_sala: '0800501',
  equip_roteador: '0800601',
  equip_servidor: '0800701',
  equip_multiplexador: '0800801',
  equip_decodificador: '0800901',
  equip_outros: '0801001',
  equip_fibra_apagada: '0801101',
  equip_capacidade_satelital: '0801201',
  equip_antenas: '0801301',
  equip_dutos_postes: '0801401',

  # Grupo 100 - Cobrança Própria
  cobranca_seguros: '1000101',
  cobranca_parcelamento: '1000201',
  cobranca_juros: '1000301',
  cobranca_multa_mora: '1000401',
  cobranca_multa_fidelizacao: '1000402',
  cobranca_meses_anteriores: '1000501',
  cobranca_correcao_monetaria: '1000601',
  cobranca_taxas: '1000701',
  cobranca_adiantamento_radiodifusao: '1000801',
  cobranca_venda_mercadorias: '1000901',

  # Grupo 110 - Cobrança de Terceiros
  terceiros_servicos: '1100101',
  terceiros_seguros: '1100201',
  terceiros_juros: '1100301',
  terceiros_multa: '1100401',
  terceiros_meses_anteriores: '1100501',
  terceiros_correcao: '1100601',
  terceiros_doacoes: '1100701',
  terceiros_equipamentos: '1100801',
  terceiros_venda_mercadorias: '1100901',

  # Grupo 120 - Cobrança Centralizada
  centralizada_item: '1200101',

  # Grupo 130 - Cofaturamento
  cofaturamento_item: '1300101',

  # Grupo 590 - Deduções
  deducao_impugnacao: '5900101',
  deducao_ajuste: '5900201',
  deducao_multa_interrupcao: '5900301',
  deducao_pagamento_duplicidade: '5900401',
  deducao_outras: '5900501'
}.freeze
UNIDADES_MEDIDA = 
{
  minuto: 1,  # Minuto
  mb: 2,      # Megabyte
  gb: 3,      # Gigabyte
  un: 4       # Unidade/Unit (padrão para assinaturas)
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::Helpers

apenas_numeros, cnpj_valido?, cpf_valido?, formatar_cep, formatar_cnpj, formatar_cpf, formatar_data, formatar_data_hora, formatar_decimal, gerar_id, limitar_texto, remover_acentos, safe_to_date, vazio?

Constructor Details

#initialize(attributes = {}) ⇒ Item

Returns a new instance of Item.



244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/nfcom/models/item.rb', line 244

def initialize(attributes = {})
  @unidade = 4 # Padrão: UN (Unidade)
  @quantidade = 1
  @valor_desconto = 0.0
  @valor_outras_despesas = 0.0

  attributes.each do |key, value|
    send("#{key}=", value) if respond_to?("#{key}=")
  end

  calcular_valor_total if @valor_total.nil?
end

Instance Attribute Details

#cfop ⇒ Object

Returns the value of attribute cfop.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def cfop
  @cfop
end

#classe_consumo ⇒ Object

Returns the value of attribute classe_consumo.



97
98
99
 
# File 'lib/nfcom/models/item.rb', line 97

def classe_consumo
  @classe_consumo
end

#codigo_beneficio_fiscal ⇒ Object

Returns the value of attribute codigo_beneficio_fiscal.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def codigo_beneficio_fiscal
  @codigo_beneficio_fiscal
end

#codigo_servico ⇒ Object

Returns the value of attribute codigo_servico.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def codigo_servico
  @codigo_servico
end

#descricao ⇒ Object

Returns the value of attribute descricao.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def descricao
  @descricao
end

#numero_item ⇒ Object

Returns the value of attribute numero_item.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def numero_item
  @numero_item
end

#quantidade ⇒ Object

Returns the value of attribute quantidade.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def quantidade
  @quantidade
end

#unidade ⇒ Object

Returns the value of attribute unidade.



97
98
99
 
# File 'lib/nfcom/models/item.rb', line 97

def unidade
  @unidade
end

#valor_desconto ⇒ Object

Returns the value of attribute valor_desconto.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def valor_desconto
  @valor_desconto
end

#valor_outras_despesas ⇒ Object

Returns the value of attribute valor_outras_despesas.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def valor_outras_despesas
  @valor_outras_despesas
end

#valor_total ⇒ Object

Returns the value of attribute valor_total.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def valor_total
  @valor_total
end

#valor_unitario ⇒ Object

Returns the value of attribute valor_unitario.



92
93
94
 
# File 'lib/nfcom/models/item.rb', line 92

def valor_unitario
  @valor_unitario
end

Instance Method Details

#calcular_valor_total ⇒ Object 



342
343
344
345
346
 
# File 'lib/nfcom/models/item.rb', line 342

def calcular_valor_total
  @valor_total = (quantidade.to_f * valor_unitario.to_f) -
                 valor_desconto.to_f +
                 valor_outras_despesas.to_f
end

#erros ⇒ Object

rubocop:disable Metrics/MethodLength



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
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/nfcom/models/item.rb', line 261

def erros # rubocop:disable Metrics/MethodLength
  errors = []

  # Validações de campos obrigatórios
  errors << 'Código de serviço é obrigatório' if codigo_servico.to_s.strip.empty?
  errors << 'Descrição é obrigatória' if descricao.to_s.strip.empty?
  errors << 'Classe de consumo é obrigatória' if classe_consumo.to_s.strip.empty?
  errors << 'CFOP é obrigatório' if cfop.to_s.strip.empty?

  # Validações de valores numéricos
  errors << 'Valor unitário é obrigatório' if valor_unitario.nil?
  errors << 'Quantidade é obrigatória' if quantidade.nil?

  # Validações lógicas
  errors << 'Valor unitário deve ser maior que zero' if valor_unitario && valor_unitario.to_f <= 0
  errors << 'Quantidade deve ser maior que zero' if quantidade && quantidade.to_f <= 0

  # Validações declarativas de formato/schema
  campos = {}

  # Campos obrigatórios - validar formato apenas se não estiverem vazios
  unless codigo_servico.to_s.strip.empty?
    campos[:codigo_servico] = { valor: codigo_servico, validador: :er47, nome: 'Código de serviço', max: 60 }
  end

  unless descricao.to_s.strip.empty?
    campos[:descricao] = { valor: descricao, validador: :er47, nome: 'Descrição', max: 120 }
  end

  unless classe_consumo.to_s.strip.empty?
    campos[:classe_consumo] = { valor: classe_consumo, validador: :er2, nome: 'Classe de consumo' }
  end

  campos[:cfop] = { valor: cfop, validador: :er73, nome: 'CFOP' } unless cfop.to_s.strip.empty?

  # Unidade (D8 - domain: 1, 2, 3, 4)
  if unidade && !unidade.to_s.strip.empty?
    campos[:unidade] = { valor: unidade.to_s, validador: :d8, nome: 'Unidade de medida' }
  end

  # Quantidade (ER31 - 11 posições, 0-4 decimais)
  if quantidade&.to_f&.positive?
    campos[:quantidade] = { valor: formatar_decimal(quantidade, 4), validador: :er31, nome: 'Quantidade' }
  end

  # Valor unitário (ER39 - 13 posições, 2-8 decimais)
  if valor_unitario&.to_f&.positive?
    campos[:valor_unitario] =
      { valor: formatar_decimal(valor_unitario, 8), validador: :er39, nome: 'Valor unitário' }
  end

  # Campos opcionais - validar formato apenas se informados
  if valor_desconto&.to_f&.positive?
    campos[:valor_desconto] =
      { valor: formatar_decimal(valor_desconto, 2), validador: :er37, nome: 'Valor de desconto' }
  end

  if valor_outras_despesas&.to_f&.positive?
    campos[:valor_outras_despesas] =
      { valor: formatar_decimal(valor_outras_despesas, 2), validador: :er37, nome: 'Valor de outras despesas' }
  end

  if valor_total&.to_f&.positive?
    campos[:valor_total] = { valor: formatar_decimal(valor_total, 8), validador: :er39, nome: 'Valor total' }
  end

  if classe_consumo.to_s.strip.empty?
    errors << 'Classe de consumo é obrigatória'
  elsif !CLASSES_CONSUMO.values.include?(classe_consumo.to_s)
    errors << "Classe de consumo inválida. Use um dos valores: #{CLASSES_CONSUMO.values.join(', ')}"
  end

  # Add unidade validation
  errors << 'Unidade de medida inválida. Use: 1=Minuto, 2=MB, 3=GB, 4=UN' unless [1, 2, 3,
                                                                                  4].include?(unidade.to_i)
  # Executar validações declarativas
  errors.concat(Validators::SchemaValidator.validar_campos(campos))

  errors
end

#valido? ⇒ Boolean

Returns:

  • (Boolean) 


257
258
259
 
# File 'lib/nfcom/models/item.rb', line 257

def valido?
  erros.empty?
end

#valor_liquido ⇒ Object 



348
349
350
 
# File 'lib/nfcom/models/item.rb', line 348

def valor_liquido
  valor_total.to_f
end