br_nfe 2.1.1 → 2.2.0

data/lib/br_nfe/product/nf_xml_value.rb

@@ -0,0 +1,278 @@
+module BrNfe
+	module Product
+		module NfXmlValue
+			def nf_xml_value_codigo_nf value
+				only_numbers(value, {min_size: 8, max_size: 8})
+			end
+			def nf_xml_value_tipo_ambiente value, xml_version=:v3_10
+				value == :production ? '1' : '2'
+			end
+			def nf_xml_value_cpf value, xml_version=:v3_10
+				only_numbers value, {min_size: 11, max_size: 11}
+			end
+			def nf_xml_value_cnpj value, xml_version=:v3_10
+				only_numbers value, {min_size: 14, max_size: 14}
+			end
+			def nf_xml_value_indicador_sincrono value
+				value ? '1' : '0'
+			end
+
+			def nf_xml_value_id_estrangeiro value, xml_version=:v3_10
+				"#{value}".max_size(20)
+			end
+
+			def nf_xml_value_fone value, xml_version=:v3_10
+				only_numbers value, {min_size: 6, max_size: 14}
+			end
+
+			def nf_xml_value_text value, max=60, xml_version=:v3_10
+				"#{value}".strip.max_size(max).br_nfe_escape_html.remove_accents.gsub(/\r\n/,' ').gsub(/\n/,' ')
+			end
+
+			def nf_xml_value_codigo_ibge_municipio value, xml_version=:v3_10
+				only_numbers value, {min_size: 7, max_size: 7}
+			end
+
+			def nf_xml_value_UF value, xml_version=:v3_10
+				"#{value}".max_size(2)
+			end
+
+			def nf_xml_value_CEP value, xml_version=:v3_10
+				only_numbers value, {min_size: 8, max_size: 8}
+			end
+
+			def nf_xml_value_codigo_pais value, xml_version=:v3_10
+				only_numbers value, {min_size: 4, max_size: 4}
+			end
+
+			def nf_xml_value_IE value, xml_version=:v3_10
+				if value.blank?
+					'ISENTO'
+				else
+					"#{value}".gsub(/[^\w]/,'').rjust(2, '0').max_size(14)
+				end
+			end
+
+			def nf_xml_value_IM value, xml_version=:v3_10
+				"#{value}".max_size(15)
+			end
+
+			def nf_xml_value_CNAE value, xml_version=:v3_10
+				only_numbers value, {min_size: 7, max_size: 7}
+			end
+
+			def nf_xml_value_CRT value, xml_version=:v3_10
+				"#{value}".max_size(1)
+			end
+
+			# E16a - Indicador da IE do Destinatário
+			# 1 = Contribuinte ICMS (informar a IE do destinatário);
+			# 2 = Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS;
+			# 9 = Não Contribuinte, que pode ou não possuir Inscrição Estadual no Cadastro de
+			#     Contribuintes do ICMS.
+			#
+			# Nota 1: No caso de NFC-e informar indIEDest=9 e não informar
+			#         a tag IE do destinatário;
+			# Nota 2: No caso de operação com o Exterior informar indIEDest=9 e 
+			#         não informar a tag IE do destinatário;
+			# Nota 3: No caso de Contribuinte Isento de Inscrição (indIEDest=2), 
+			#         não informar a tag IE do destinatário.
+			#
+			def nf_xml_value_indicador_IE indicador_ie, nfe, xml_version=:v3_10
+				if nfe.nfce? # 65 NFC-e
+					'9'
+				else
+					indicador_ie
+				end
+			end
+
+			# Obrigatório, nas operações que se beneficiam de incentivos
+			# fiscais existentes nas áreas sob controle da SUFRAMA. A
+			# omissão desta informação impede o processamento da
+			# operação pelo Sistema de Mercadoria Nacional da SUFRAMA e
+			# a liberação da Declaração de Ingresso, prejudicando a
+			# comprovação do ingresso / internamento da mercadoria nestas
+			# áreas.
+			# Min: 8 Max: 9
+			def nf_xml_value_inscricao_suframa v_suframa, xml_version=:v3_10
+				only_numbers v_suframa, {min_size: 8, max_size: 9}
+			end
+
+			def nf_xml_value_email v_email, xml_version=:v3_10
+				nf_xml_value_text(v_email, 60)
+			end
+
+			# 1=Operação interna;
+			# 2=Operação interestadual;
+			# 3=Operação com exterior.
+			def nf_xml_value_id_local_destino v_endereco_destino, xml_version=:v3_10
+				if v_endereco_destino.exterior?
+					3
+				elsif emitente.endereco.codigo_ibge_uf == v_endereco_destino.codigo_ibge_uf
+					1
+				else
+					2
+				end
+			end
+
+			# Indica operação com Consumidor final
+			# 0=Normal;
+			# 1=Consumidor final;
+			def nf_xml_value_consumidor_final value, xml_version=:v3_10
+				value ? '1' : 	'0'
+			end
+
+			def nf_xml_value_date_time time, xml_version=:v3_10
+				if time.is_a?(Time) || time.is_a?(DateTime)
+					time.to_s(:iso8601)
+				elsif time.is_a?(Date)
+					time.to_time.to_s(:iso8601)
+				end
+			end
+
+			def nf_xml_value_time time, xml_version=:v3_10
+				if time.is_a?(Time) || time.is_a?(DateTime)
+					time.strftime('%H:%M:%S')
+				end
+			end
+
+			def nf_xml_value_date value, xml_version=:v3_10
+				if value.is_a?(Date)
+					value.to_s(:iso8601)
+				elsif value.is_a?(Time) || value.is_a?(DateTime)
+					value.to_date.to_s(:iso8601)
+				end
+			end
+
+			def nf_xml_value_monetary value, xml_version=:v3_10
+				"%.2f" % value.to_f.round(2)
+			end
+
+			def nf_xml_value_percent value, xml_version=:v3_10
+				"%.4f" % value.to_f.round(4)
+			end
+
+			def nf_xml_value_quantidade value, xml_version=:v3_10
+				"%.4f" % value.to_f.round(4)
+			end
+
+			def nf_xml_value_peso value, xml_version=:v3_10
+				"%.3f" % value.to_f.round(3)
+			end
+
+			def nf_xml_value_float value, precision, xml_version=:v3_10
+				"%.#{precision}f" % value.to_f.round(precision)
+			end
+
+			def nf_xml_value_CFOP value, xml_version=:v3_10
+				only_numbers value, {min_size: 4, max_size: 4}
+			end
+
+			def nf_xml_value_placa placa, xml_version=:v3_10
+				"#{placa}".gsub(/[^\w]/,'').rjust(7, '0').max_size(7)
+			end
+
+			# Registro Nacional de Transportador de Carga (ANTT)
+			#
+			def nf_xml_value_RNTC rntc, xml_version=:v3_10
+				nf_xml_value_text rntc, 20
+			end
+
+			def nf_xml_fixed_code code, options={}, xml_version=:v3_10
+				options = {size: 2}.merge(options)
+				"#{code.to_i}".rjust(options[:size], '0')
+			end
+
+			def nf_xml_value_CEST cest, xml_version=:v3_10
+				"#{cest.to_i}".rjust(7, '0') if cest.present?
+			end
+
+			def nf_xml_value_EAN ean, xml_version=:v3_10
+				if ean.to_i > 0
+					if "#{ean}".strip.size > 8
+						"#{ean}".strip.rjust(12, '0') 
+					else
+						"#{ean}".strip.rjust(8, '0') 
+					end
+				end
+			end
+
+			def nf_xml_value_NCM ncm, xml_version=:v3_10
+				ncm = ncm.to_i
+				if ncm > 0
+					"#{ncm}".rjust(8, '0') 
+				else
+					"#{ncm}".rjust(2, '0') 
+				end
+			end
+
+			def nf_xml_value_EXTIPI value, xml_version=:v3_10
+				"#{value}".rjust(2, '0')
+			end
+
+			def nf_xml_value_boolean value, xml_version=:v3_10
+				value ? '1' : '0'
+			end
+
+			def nf_xml_value_NVE value, xml_version=:v3_10
+				"#{value}".max_size(6)
+			end
+
+			def nf_xml_value_number value, max_size, xml_version=:v3_10
+				only_numbers value, {max_size: max_size}
+			end
+
+			def nf_xml_value_drawback value, xml_version=:v3_10
+				if "#{value}".strip.size <= 9 
+					only_numbers value, min_size: 9, max_size: 9
+				else
+					only_numbers value, min_size: 11, max_size: 11
+				end
+			end
+
+			def nf_xml_value_chave_nfe value, xml_version=:v3_10
+				only_numbers value, {min_size: 44, max_size: 44}
+			end
+
+			def nf_xml_value_number_fixed_size value, size, xml_version=:v3_10
+				only_numbers value, {min_size: size, max_size: size}
+			end
+
+			def nf_xml_value_codigo_enquadramento_IPI value
+				if value.blank?
+					'999'
+				else
+					nf_xml_value_text value, 3
+				end
+			end
+
+			def nf_xml_value_ISSQN_incentivo_fiscal value
+				value ? 1 : 2
+			end
+
+			def nf_xml_value_numero_recibo value
+				only_numbers "#{value}".strip, max_size: 15
+			end
+
+			def nf_xml_value_orgao_emissor evento
+				if evento.codigo_orgao.present?
+					evento.codigo_orgao
+				else
+					if gateway.is_a?(BrNfe::Product::Gateway::WebServiceSVAN) && evento.is_a?(BrNfe.cancelamento_product_class)
+						91
+					else
+						"#{evento.chave_nfe}"[0..1]
+					end
+				end
+			end
+
+		private
+
+			def only_numbers value, options={}
+				options[:min_size] ||= 0
+				options[:max_size] ||= 1
+				"#{value}".gsub(/[^\d]/,'').rjust(options[:min_size], '0').max_size(options[:max_size])
+			end
+		end
+	end
+end

data/lib/br_nfe/product/nfe/adicao_importacao.rb

@@ -0,0 +1,76 @@
+module BrNfe
+	module Product
+		module Nfe
+			class AdicaoImportacao < BrNfe::ActiveModelBase
+				# Numero da Adição
+				# 
+				# <b>Type:     </b> _Number_
+				# <b>Required: </b> _Yes_
+				# <b>Example:  </b> _123_
+				# <b>Length:   </b> _max: 3_
+				# <b>tag:      </b> nAdicao
+				#
+				attr_accessor :numero_adicao
+				alias_attribute :nAdicao, :numero_adicao
+
+				# Numero sequencial do item dentro da Adição
+				# 
+				# <b>Type:     </b> _Number_
+				# <b>Required: </b> _Yes_
+				# <b>Example:  </b> _2_
+				# <b>Length:   </b> _max: 3_
+				# <b>tag:      </b> nSeqAdic
+				#
+				attr_accessor :sequencial
+				alias_attribute :nSeqAdic, :sequencial
+
+				# Código do fabricante estrangeiro
+				# Código do fabricante estrangeiro, usado nos sistemas internos
+				# de informação do emitente da NF-e
+				# 
+				# <b>Type:     </b> _String_
+				# <b>Required: </b> _Yes_
+				# <b>Example:  </b> _XINGLING_
+				# <b>Length:   </b> _max: 60_
+				# <b>tag:      </b> cFabricante
+				#
+				attr_accessor :codigo_fabricante
+				alias_attribute :cFabricante, :codigo_fabricante
+
+				# Valor do desconto do item da DI – Adição
+				# 
+				# <b>Type:     </b> _Float_
+				# <b>Required: </b> _No_
+				# <b>Example:  </b> _35.50_
+				# <b>Length:   </b> _precision: 2_
+				# <b>tag:      </b> vDescDI
+				#
+				attr_accessor :valor_desconto
+				alias_attribute :vDescDI, :valor_desconto
+
+				# Número do ato concessório de Drawback
+				# O número do Ato Concessório de Suspensão deve ser
+				# preenchido com 11 dígitos (AAAANNNNNND) e o número do
+				# Ato Concessório de Drawback Isenção deve ser preenchido
+				# com 9 dígitos (AANNNNNND). (Observação incluída na NT
+				# 2013/005 v. 1.10)
+				# 
+				# <b>Type:     </b> _Float_
+				# <b>Required: </b> _No_
+				# <b>Example:  </b> _20160000012_
+				# <b>Length:   </b> _min: 9, max: 11_
+				# <b>tag:      </b> nDraw
+				#
+				attr_accessor :numero_drawback
+				alias_attribute :nDraw, :numero_drawback
+
+				validates :numero_adicao,     presence: true
+				validates :sequencial,        presence: true
+				validates :codigo_fabricante, presence: true
+				validates :numero_drawback,   length: {in: 9..11 },  allow_blank: true
+				validates :codigo_fabricante, length: {maximum: 60}, allow_blank: true
+
+			end
+		end
+	end
+end

data/lib/br_nfe/product/nfe/cobranca/duplicata.rb

@@ -0,0 +1,44 @@
+module BrNfe
+	module Product
+		module Nfe
+			module Cobranca
+				class Duplicata < BrNfe::ActiveModelBase
+					# Número da duplicata
+					# 
+					# <b>Type:     </b> _String_
+					# <b>Required: </b> _No_
+					# <b>Length:   </b> _Max: 60_
+					# <b>Exemplo:  </b> _DUP646498_
+					# <b>tag:      </b> nDup
+					#
+					attr_accessor :numero_duplicata
+					alias_attribute :nDup, :numero_duplicata
+
+					# Valor da duplicata
+					# 
+					# <b>Type:     </b> _Float_
+					# <b>Required: </b> _No_
+					# <b>Exemplo:  </b> _1500.50_
+					# <b>tag:      </b> vDup
+					#
+					attr_accessor :total
+					alias_attribute :vDup, :total
+
+					# Data do vencimento da duplicata
+					# 
+					# <b>Type:     </b> _Date_
+					# <b>Required: </b> _Yes_
+					# <b>Exemplo:  </b> _Date.tomorrow_
+					# <b>tag:      </b> dVenc
+					#
+					attr_accessor :vencimento
+					alias_attribute :dVenc, :vencimento
+
+					validates :total, presence: true
+					validates :total, numericality: {greater_than_or_equal_to: 0.0}
+					validates :numero_duplicata, length: {maximum: 60}
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/product/nfe/cobranca/fatura.rb

@@ -0,0 +1,64 @@
+module BrNfe
+	module Product
+		module Nfe
+			module Cobranca
+				class Fatura < BrNfe::ActiveModelBase
+					# Número da fatura
+					# 
+					# <b>Type:     </b> _String_
+					# <b>Required: </b> _No_
+					# <b>Length:   </b> _Max: 60_
+					# <b>Exemplo:  </b> _FAT646498_
+					# <b>tag:      </b> nFat
+					#
+					attr_accessor :numero_fatura
+					alias_attribute :nFat, :numero_fatura
+
+					# Valor original da fatura
+					# 
+					# <b>Type:     </b> _Float_
+					# <b>Required: </b> _No_
+					# <b>Exemplo:  </b> _1500.50_
+					# <b>tag:      </b> vOrig
+					#
+					attr_accessor :valor_original
+					alias_attribute :vOrig, :valor_original
+
+					# Valor do desconto da fatura
+					# 
+					# <b>Type:     </b> _Float_
+					# <b>Required: </b> _No_
+					# <b>Exemplo:  </b> _100.25_
+					# <b>tag:      </b> vDesc
+					#
+					attr_accessor :valor_desconto
+					alias_attribute :vDesc, :valor_desconto
+
+					# Valor do liquido da fatura
+					# 
+					# <b>Type:     </b> _Float_
+					# <b>Required: </b> _No_
+					# <b>Default:  </b> _Auto_
+					# <b>Exemplo:  </b> _1400.25_
+					# <b>tag:      </b> vLiq
+					#
+					attr_accessor :valor_liquido
+					def valor_liquido
+						@valor_liquido || calculate_valor_liquido
+					end
+					alias_attribute :vLiq, :valor_liquido
+
+					has_many :duplicatas, 'BrNfe.duplicata_product_class'
+
+					validate_has_many :duplicatas, message: :invalid_duplicata
+					validates :duplicatas,         length: {maximum: 120}
+
+				private
+					def calculate_valor_liquido
+						valor_original.to_f - valor_desconto.to_f
+					end
+				end
+			end
+		end
+	end
+end

data/lib/br_nfe/product/nfe/cobranca/pagamento.rb

@@ -0,0 +1,99 @@
+module BrNfe
+	module Product
+		module Nfe
+			module Cobranca
+				class Pagamento < BrNfe::ActiveModelBase
+					# Forma de pagamento
+					# 01=Dinheiro
+					# 02=Cheque
+					# 03=Cartão de Crédito
+					# 04=Cartão de Débito
+					# 05=Crédito Loja
+					# 10=Vale Alimentação
+					# 11=Vale Refeição
+					# 12=Vale Presente
+					# 13=Vale Combustível
+					# 99=Outros
+					# 
+					# <b>Type:     </b> _Number_
+					# <b>Required: </b> _Yes_
+					# <b>Exemplo:  </b> _1_ ou _'01'_
+					# <b>Length:   </b> _2_
+					# <b>tag:      </b> tPag
+					#
+					attr_accessor :forma_pagamento
+					alias_attribute :tPag, :forma_pagamento
+
+					# Valor do pagamento
+					# 
+					# <b>Type:     </b> _Float_
+					# <b>Required: </b> _Yes_
+					# <b>Exemplo:  </b> _1500.50_
+					# <b>tag:      </b> vPag
+					#
+					attr_accessor :total
+					alias_attribute :vPag, :total
+
+					# CNPJ da Credenciadora de cartão de crédito e/ou débito
+					# Informar o CNPJ da Credenciadora de cartão de crédito / débito
+					# 
+					# <b>Type:     </b> _String_
+					# <b>Required: </b> _Yes_ (if forma_pagamento IN [3, 4] )
+					# <b>Exemplo:  </b> _12.123.456/0001-88_ ou _12345678901234_
+					# <b>tag:      </b> CNPJ
+					#
+					attr_accessor :cartao_cnpj
+					def cartao_cnpj
+						return unless @cartao_cnpj.present?
+						BrNfe::Helper::CpfCnpj.new(@cartao_cnpj).sem_formatacao
+					end
+					alias_attribute :CNPJ, :cartao_cnpj
+
+					# Bandeira da operadora de cartão de crédito e/ou débito
+					# 01=Visa
+					# 02=Mastercard
+					# 03=American Express
+					# 04=Sorocred
+					# 99=Outros
+					# 
+					# <b>Type:     </b> _Number_
+					# <b>Required: </b> _Yes_ (if forma_pagamento IN [3, 4] )
+					# <b>Exemplo:  </b> _1_ ou _'02'_
+					# <b>tag:      </b> tBand
+					#
+					attr_accessor :cartao_bandeira
+					alias_attribute :tBand, :cartao_bandeira
+
+					# Número de autorização da operação cartão de crédito e/ou débito.
+					# Identifica o número da autorização da transação da operação com 
+					# cartão de crédito e/ou débito
+					#
+					# <b>Type:     </b> _String_
+					# <b>Required: </b> _Yes_ (if forma_pagamento IN [3, 4] )
+					# <b>Exemplo:  </b> _'9799844646'_
+					# <b>tag:      </b> cAut
+					#
+					attr_accessor :cartao_autorizacao
+					alias_attribute :cAut, :cartao_autorizacao
+
+					validates :forma_pagamento, :total, presence: true
+					validates :forma_pagamento, inclusion: {in: BrNfe::Constants::FORMAS_PAGAMENTO}
+					validates :total, numericality: {greater_than_or_equal_to: 0.0}
+					
+					with_options if: :cartao? do |record|
+						record.validates :cartao_cnpj, :cartao_bandeira, :cartao_autorizacao, presence: true
+						record.validates :cartao_cnpj, length: {maximum: 14}
+						record.validates :cartao_autorizacao, length: {maximum: 20}
+						record.validates :cartao_bandeira,    inclusion: {in: [1, 2, 3, 4, 99, '1', '2', '3', '4', '01', '02', '03', '04', '99']}
+					end
+
+
+					def cartao?
+						forma_pagamento.to_i.in?([3, 4])
+					end
+				
+				end
+			end
+		end
+	end
+end