brcobranca 8.0.0 → 9.0.0

data/lib/brcobranca/retorno/cnab240/santander.rb

@@ -1,11 +1,6 @@
-# -*- encoding: utf-8 -*-
-#
-
 module Brcobranca
   module Retorno
     module Cnab240
-      # Formato de Retorno CNAB 240
-      # Baseado em: http://www.wmcsistemas.com/instalar/Layouts%20-%20Boletos_Cheques_Integracoes/Layout%20Santander/Santander%20-%20CNAB%20240.pdf
       class Santander < Brcobranca::Retorno::Cnab240::Base
         # Regex para remoção de headers e trailers além de registros diferentes de T ou U
         REGEX_DE_EXCLUSAO_DE_REGISTROS_NAO_T_OU_U = /^((?!^.{7}3.{5}[T|U].*$).)*$/
@@ -35,25 +30,31 @@ module Brcobranca
           retorno
         end
 
+        # Linha de mapeamento do retorno do arquivo CNAB 240
+        # O registro CNAB 240 possui 2 tipos de registros que juntos geram um registro de retorno bancário
+        # O primeiro é do tipo T que retorna dados gerais sobre a transação
+        # O segundo é do tipo U que retorna os valores da transação
         class Line < Base
           extend ParseLine::FixedWidth # Extendendo parseline
 
-          REGISTRO_T_FIELDS = %w(agencia_com_dv cedente_com_dv nosso_numero nosso_numero_com_dv carteira data_vencimento valor_titulo banco_recebedor agencia_recebedora_com_dv sequencial valor_tarifa).freeze
-          REGISTRO_U_FIELDS = %w(desconto_concedito valor_abatimento iof_desconto juros_mora valor_recebido outras_despesas outros_recebimento data_credito data_ocorrencia).freeze
+          REGISTRO_T_FIELDS = %w(codigo_registro codigo_ocorrencia agencia_com_dv cedente_com_dv nosso_numero carteira data_vencimento valor_titulo banco_recebedor agencia_recebedora_com_dv sequencial valor_tarifa motivo_ocorrencia)
+          REGISTRO_U_FIELDS = %w(desconto_concedito data_ocorrencia valor_abatimento iof_desconto juros_mora valor_recebido outras_despesas outros_recebimento data_credito)
 
           attr_accessor :tipo_registro
 
           fixed_width_layout do |parse|
-            parse.field :tipo_registro, 13..13
+            parse.field :codigo_registro, 7..7
             parse.field :sequencial, 8..12
-            parse.field :agencia_com_dv, 17..22
-            parse.field :nosso_numero, 40..51
-            parse.field :nosso_numero_com_dv, 40..52
+            parse.field :tipo_registro, 13..13
+            parse.field :codigo_ocorrencia, 15..16
+            parse.field :agencia_com_dv, 17..21
+            parse.field :cedente_com_dv, 22..31
+            parse.field :nosso_numero, 40..52
             parse.field :carteira, 53..53
             parse.field :data_vencimento, 69..76
             parse.field :valor_titulo, 77..91
             parse.field :banco_recebedor, 92..94
-            parse.field :agencia_recebedora_com_dv, 95..98
+            parse.field :agencia_recebedora_com_dv, 95..99
             parse.field :data_ocorrencia, 137..144
             parse.field :data_credito, 145..152
             parse.field :outras_despesas, 107..121
@@ -64,6 +65,28 @@ module Brcobranca
             parse.field :juros_mora, 17..31
             parse.field :outros_recebimento, 122..136
             parse.field :valor_tarifa, 193..207
+            parse.field :motivo_ocorrencia, 208..117, ->(motivos) do
+              motivos.scan(/.{2}/).reject(&:blank?).reject{|motivo| motivo == '00'}
+            end
+
+            # Dados que não consegui extrair dos registros T e U
+            # parse.field :convenio,31..37
+            # parse.field :tipo_cobranca,80..80
+            # parse.field :tipo_cobranca_anterior,81..81
+            # parse.field :natureza_recebimento,86..87
+            # parse.field :carteira_variacao,91..93
+            # parse.field :desconto,95..99
+            # parse.field :iof,100..104
+            # parse.field :comando,108..109
+            # parse.field :data_liquidacao,110..115
+            # parse.field :especie_documento,173..174
+            # parse.field :valor_tarifa,181..187
+            # parse.field :juros_desconto,201..213
+            # parse.field :abatimento_nao_aproveitado,292..304
+            # parse.field :valor_lancamento,305..317
+            # parse.field :indicativo_lancamento,318..318
+            # parse.field :indicador_valor,319..319
+            # parse.field :valor_ajuste,320..331
           end
         end
       end

data/lib/brcobranca/retorno/cnab240/sicoob.rb

@@ -1,5 +1,4 @@
 # -*- encoding: utf-8 -*-
-#
 
 require 'parseline'
 
@@ -42,14 +41,16 @@ module Brcobranca
         class Line < Base
           extend ParseLine::FixedWidth # Extendendo parseline
 
-          REGISTRO_T_FIELDS = %w(agencia_com_dv cedente_com_dv nosso_numero carteira data_vencimento valor_titulo banco_recebedor agencia_recebedora_com_dv sequencial valor_tarifa).freeze
-          REGISTRO_U_FIELDS = %w(desconto_concedito valor_abatimento iof_desconto juros_mora valor_recebido outras_despesas outros_recebimento data_credito).freeze
+          REGISTRO_T_FIELDS = %w(codigo_registro codigo_ocorrencia agencia_com_dv cedente_com_dv nosso_numero carteira data_vencimento valor_titulo banco_recebedor agencia_recebedora_com_dv sequencial valor_tarifa motivo_ocorrencia)
+          REGISTRO_U_FIELDS = %w(desconto_concedito valor_abatimento iof_desconto juros_mora valor_recebido outras_despesas outros_recebimento data_credito data_ocorrencia)
 
           attr_accessor :tipo_registro
 
           fixed_width_layout do |parse|
+            parse.field :codigo_registro, 7..7
             parse.field :tipo_registro, 13..13
             parse.field :sequencial, 8..12
+            parse.field :codigo_ocorrencia, 15..16
             parse.field :agencia_com_dv, 17..22
             parse.field :cedente_com_dv, 23..35
             parse.field :nosso_numero, 37..46
@@ -58,7 +59,7 @@ module Brcobranca
             parse.field :valor_titulo, 81..95
             parse.field :banco_recebedor, 96..98
             parse.field :agencia_recebedora_com_dv, 99..104
-            # parse.field :data_ocorrencia, 137..144
+            parse.field :data_ocorrencia, 137..144
             parse.field :data_credito, 145..152
             parse.field :outras_despesas, 107..121
             parse.field :iof_desconto, 62..76
@@ -68,6 +69,9 @@ module Brcobranca
             parse.field :juros_mora, 17..31
             parse.field :outros_recebimento, 122..136
             parse.field :valor_tarifa, 198..212
+            parse.field :motivo_ocorrencia, 213..222, ->(motivos) do
+              motivos.scan(/.{2}/).reject(&:blank?).reject{|motivo| motivo == '00'}
+            end
 
             # Dados que não consegui extrair dos registros T e U
             # parse.field :convenio,31..37

data/lib/brcobranca/retorno/cnab240/sicredi.rb

@@ -0,0 +1,79 @@
+# -*- encoding: utf-8 -*-
+require 'parseline'
+
+module Brcobranca
+  module Retorno
+    module Cnab240
+      class Sicredi < Brcobranca::Retorno::Cnab240::Base
+        # Regex para remoção de headers e trailers além de registros diferentes de T ou U
+        REGEX_DE_EXCLUSAO_DE_REGISTROS_NAO_T_OU_U = /^((?!^.{7}3.{5}[T|U].*$).)*$/
+
+        def self.load_lines(file, options = {})
+          default_options = { except: REGEX_DE_EXCLUSAO_DE_REGISTROS_NAO_T_OU_U }
+          options = default_options.merge!(options)
+
+          Line.load_lines(file, options).each_slice(2).reduce([]) do |retornos, cnab_lines|
+            retornos << generate_retorno_based_on_cnab_lines(cnab_lines)
+          end
+        end
+
+        def self.generate_retorno_based_on_cnab_lines(cnab_lines)
+          retorno = new
+          cnab_lines.each do |line|
+            if line.tipo_registro == 'T'
+              Line::REGISTRO_T_FIELDS.each do |attr|
+                retorno.send(attr + '=', line.send(attr))
+              end
+            else
+              Line::REGISTRO_U_FIELDS.each do |attr|
+                retorno.send(attr + '=', line.send(attr))
+              end
+            end
+          end
+          retorno
+        end
+
+        # Linha de mapeamento do retorno do arquivo CNAB 240
+        # O registro CNAB 240 possui 2 tipos de registros que juntos geram um registro de retorno bancário
+        # O primeiro é do tipo T que retorna dados gerais sobre a transação
+        # O segundo é do tipo U que retorna os valores da transação
+        class Line < Base
+          extend ParseLine::FixedWidth # Extendendo parseline
+
+          REGISTRO_T_FIELDS = %w(codigo_registro codigo_ocorrencia agencia_com_dv cedente_com_dv nosso_numero carteira data_vencimento valor_titulo banco_recebedor agencia_recebedora_com_dv sequencial valor_tarifa motivo_ocorrencia)
+          REGISTRO_U_FIELDS = %w(desconto_concedito valor_abatimento iof_desconto juros_mora valor_recebido outras_despesas outros_recebimento data_ocorrencia data_credito)
+
+          attr_accessor :tipo_registro
+
+          fixed_width_layout do |parse|
+            parse.field :codigo_registro, 7..7
+            parse.field :tipo_registro, 13..13
+            parse.field :sequencial, 8..12
+            parse.field :codigo_ocorrencia, 15..16
+            parse.field :agencia_com_dv, 17..22
+            parse.field :cedente_com_dv, 23..35
+            parse.field :nosso_numero, 37..56
+            parse.field :carteira, 57..57
+            parse.field :data_vencimento, 73..80
+            parse.field :valor_titulo, 81..95
+            parse.field :banco_recebedor, 96..98
+            parse.field :agencia_recebedora_com_dv, 99..104
+            parse.field :data_ocorrencia, 137..144
+            parse.field :data_credito, 145..152
+            parse.field :outras_despesas, 107..121
+            parse.field :iof_desconto, 62..76
+            parse.field :valor_abatimento, 47..61
+            parse.field :desconto_concedito, 32..46
+            parse.field :valor_recebido, 77..91
+            parse.field :juros_mora, 17..31
+            parse.field :outros_recebimento, 122..136
+            parse.field :valor_tarifa, 198..212
+            parse.field :motivo_ocorrencia, 213..222, ->(motivos) do
+              motivos.scan(/.{2}/).reject(&:blank?).reject{|motivo| motivo == '00'}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/brcobranca/retorno/cnab400/banco_brasil.rb

@@ -0,0 +1,127 @@
+# -*- encoding: utf-8 -*-
+#
+require 'parseline'
+
+module Brcobranca
+  module Retorno
+    module Cnab400
+      # Formato de Retorno CNAB 400
+      # Baseado em: http://www.bb.com.br/docs/pub/emp/empl/dwn/Doc2628CBR643Pos7.pdf
+      class BancoBrasil < Brcobranca::Retorno::Cnab400::Base
+        extend ParseLine::FixedWidth # Extendendo parseline
+
+        # Load lines
+        def self.load_lines(file, options = {})
+          default_options = { except: [1] } # por padrao ignora a primeira linha que é header
+          options = default_options.merge!(options)
+          super file, options
+        end
+
+        fixed_width_layout do |parse|
+          # Todos os campos descritos no documento em ordem
+          # :tipo_de_registro, 0..0 # identificacao do registro transacao
+          # :zeros, 1..2 # zeros
+          # :zeros, 3..16 #zeros
+
+          # :agencia, 17..21 #agencia mantenedora da conta com digito
+          parse.field :agencia_com_dv, 17..21
+
+          # :conta, 22..30 #numero da conta corrente da empresa com digito
+          parse.field :cedente_com_dv, 22..30
+
+          # :convenio, 31..37 #convenio da empresa
+          # :uso_da_empresa, 38..62 #identificacao do titulo na empresa
+
+          # :nosso_numero,63..79 # identificacao do titulo no banco
+          parse.field :nosso_numero, 63..79
+
+          # :tipo_cobranca, 80..80 #tipo de cobranca
+          # :tipo_cobranca_anterior, 81..81 #tipo de cobranca
+
+          # :dias, 82..85 #dias para calculo
+
+          # :natureza_recebimento, 86..87 #natureza do recebimento
+          parse.field :motivos_de_ocorrencia, 86..87, ->(motivos) { motivos.scan(/../).reject { |n| n.to_i.zero? } }
+
+          # :prefixo_titulo, 88..90 #prefixo do titulo
+          parse.field :carteira_variacao, 91..93
+
+          # :conta_caucao, 94..94 #conta caução
+          # :taxa_desconto, 95..99 #taxa para desconto
+          # :taxa_iof, 100..104 #taxa para iof
+
+          # :brancos, 105..105 #brancos
+          parse.field :carteira, 106..107
+
+          # :cod_de_ocorrencia, 108..109 # cod de ocorrencia no banco
+          parse.field :codigo_ocorrencia, 108..109
+
+          # :data_de_ocorrencia, 110..115 # data de ocorrencia no banco (ddmmaa)
+          parse.field :data_ocorrencia, 110..115
+
+          # :n_do_documento, 116..125 # n umero do documento de cobranca (dupl, np etc)
+          # :brancos, 126..145 #complemento de registro
+
+          # :vencimento, 146..151 #data de vencimento do titulo (ddmmaa)
+          parse.field :data_vencimento, 146..151
+
+          # :valor_do_titulo, 152..164 #valor nominal do titulo (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :valor_titulo, 152..164
+
+          # :codigo_do_banco, 165..167 # numero do banco na camara de compensacao
+          parse.field :banco_recebedor, 165..167
+
+          # :agencia_cobradora, 168..171 # agencia cobradora, ag de liquidacao ou baixa
+          # :dac_ag_cobradora, 172..172 # dac da agencia cobradora
+          parse.field :agencia_recebedora_com_dv, 168..172
+
+          # :especie, 173..174 # especie do titulo
+          parse.field :especie_documento, 173..174
+
+          # :data_credito, 295..300 #data de credito desta liquidacao
+          parse.field :data_credito, 175..180
+
+          # :tarifa_de_cobranca, 175..187 #valor da despesa de cobranca (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :valor_tarifa, 181..187
+
+          # parse.field :outras_despesas, 188..200
+          # parse.field :juros_desconto, 201..213
+          # parse.field :iof_desconto, 214..226
+
+          # :valor_do_iof, 214..226 #valor do iof a ser recolhido (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :iof, 214..226
+
+          # :valor_abatimento, 227..239 #valor do abatimento concedido (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :valor_abatimento, 227..239
+
+          # :descontos, 240..252 #valor do desconto concedido (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :desconto, 240..252
+
+          # :valor_principal, 253..265 #valor lancado em conta corrente (ultimos 2 digitos, virgula decimal assumida)
+
+          parse.field :valor_recebido, 253..265
+
+          # :juros_mora_multa, 266..278 #valor de mora e multa pagos pelo sacado (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :juros_mora, 266..278
+
+          # :outros_creditos, 279..291 #valor de outros creditos (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :outros_recebimento, 279..291
+
+          # parse.field :abatimento_nao_aproveitado, 292..304
+          # parse.field :valor_lancamento, 305..317
+          # parse.field :indicativo_lancamento, 318..318
+          # parse.field :indicador_valor, 319..319
+          # parse.field :valor_ajuste, 320..331
+          # :brancos, 332..341 #complemento de registro
+          # :zeros, 342..389 #complemento de registro
+          # :indicativo_liquidacao_parcial, 390..390 #Indicativo de Autorização de Liquidação Parcial
+          # :brancos, 391..391 #complemento de registro
+          # :cod_de_liquidacao, 392..393 #meio pelo qual o título foi liquidado
+
+          # :numero_sequencial, 394..399 #numero sequencial no arquivo
+          parse.field :sequencial, 394..399
+        end
+      end
+    end
+  end
+end

data/lib/brcobranca/retorno/cnab400/banco_brasilia.rb

@@ -0,0 +1,89 @@
+# -*- encoding: utf-8 -*-
+require 'parseline'
+
+module Brcobranca
+  module Retorno
+    module Cnab400
+      # Formato de Retorno CNAB 400
+      class BancoBrasilia < Brcobranca::Retorno::Base
+        extend ParseLine::FixedWidth
+
+        def self.load_lines(file, options = {})
+          default_options = { except: [1] } # por padrao ignora a primeira linha que é header
+          options = default_options.merge!(options)
+
+          super file, options
+        end
+
+        fixed_width_layout do |parse|
+          # Todos os campos descritos no documento em ordem
+          # :tipo_de_registro, 0..0 # identificacao do registro transacao
+          parse.field :codigo_registro, 0..0
+
+          # :codigo_de_inscricao, 1..2 # identificacao do tipo de inscricao/empresa
+          # :numero_de_inscricao, 3..16 # numero de inscricao da empresa (cpf/cnpj)
+          # :zeros, 17..19
+
+          # Identificacao da empresa no banco
+          # :zeros, 20..20
+          parse.field :cedente_com_dv, 20..36
+
+          # :numero_controle_empresa, 37..61, # numero de controle da empresa
+          # :zeros, 62..69
+
+          # :nosso_numero, 62..69 # identificacao do titulo no banco
+          parse.field :nosso_numero, 70..81
+
+          # :zeros, 82..91 # uso do banco
+          # :zeros, 92..103 # uso do banco
+          # :indicador_de_rateio, 104..104 # indicador de rateio de credito
+          # :zeros, 105..106
+          # :carteira, 107..107 # de novo?
+          parse.field :codigo_ocorrencia, 108..109
+          parse.field :data_ocorrencia, 110..117
+          # :nosso_numero, 128..133 # confirmacao do numero do titulo no banco
+          # :brancos, 134..145 # complemento de registro
+
+          parse.field :data_vencimento, 148..155
+          parse.field :valor_titulo, 156..168
+          parse.field :banco_recebedor, 169..171
+
+          # :agencia_cobradora, 168..171 # agencia cobradora, ag de liquidacao ou baixa
+          # :dac_ag_cobradora, 172..172 # dac da agencia cobradora
+          # :agencia_recebedora_com_dv, 168..172
+
+          parse.field :especie_documento, 177..178
+          parse.field :valor_tarifa, 179..191
+
+          # :outras_despesas 188..200, # valor de outras despesas ou custos do protesto
+          # :juros_operacao_em_atraso, 201..213 # zeros?
+
+          parse.field :iof, 218..230
+          parse.field :valor_abatimento, 231..243
+          parse.field :desconto, 244..256
+          parse.field :valor_recebido, 257..269
+          parse.field :outros_recebimento, 283..295
+
+          # :brancos, 292..293
+          # :motivo_do_codigo_de_ocorrencia, 294..294
+
+          # :data_credito, 295..300 # data de credito desta liquidacao
+          parse.field :data_credito, 299..306
+
+          # :origem_pagamento, 301..303
+          # :brancos, 304..313
+          # :cheque_bradesco, 314..317
+          # :motivo_rejeicao, 318..327
+          # :brancos, 328..367
+          # :numero_do_cartorio, 368..369
+          # :numero_do_protocolo, 370..379
+          # :brancos, 380..393
+
+          parse.field :motivo_ocorrencia, 364..393
+
+          parse.field :sequencial, 394..399
+        end
+      end
+    end
+  end
+end

data/lib/brcobranca/retorno/cnab400/banco_nordeste.rb

@@ -0,0 +1,112 @@
+# -*- encoding: utf-8 -*-
+require 'parseline'
+
+module Brcobranca
+  module Retorno
+    module Cnab400
+      # Formato de Retorno CNAB 400
+      class BancoNordeste < Brcobranca::Retorno::Base
+        extend ParseLine::FixedWidth
+
+        def self.load_lines(file, options = {})
+          default_options = { except: [1] } # por padrao ignora a primeira linha que é header
+          options = default_options.merge!(options)
+
+          super file, options
+        end
+
+        fixed_width_layout do |parse|
+          # Todos os campos descritos no documento em ordem
+          parse.field :codigo_registro, 0..0
+
+          # :codigo_de_inscricao, 1..2 # identificacao do tipo de inscricao/empresa
+          # :numero_de_inscricao, 3..16 # numero de inscricao da empresa (cpf/cnpj)
+          # :zeros, 17..19
+
+          # Identificacao da empresa no banco
+          # :zeros, 20..20
+          parse.field :agencia_sem_dv, 17..20
+          parse.field :cedente_com_dv, 23..30
+
+          # :numero_controle_empresa, 37..61, # numero de controle da empresa
+          # :zeros, 62..69
+
+          parse.field :nosso_numero, 62..69
+
+          # :zeros, 82..91 # uso do banco
+          # :zeros, 92..103 # uso do banco
+          # :indicador_de_rateio, 104..104 # indicador de rateio de credito
+          # :zeros, 105..106
+          # :carteira, 107..107 # de novo?
+          parse.field :carteira, 107..107
+          parse.field :codigo_ocorrencia, 108..109
+          parse.field :data_ocorrencia, 110..115
+
+          # :n_do_documento, 116..125 # n umero do documento de cobranca (dupl, np etc)
+          # :nosso_numero, 126..133 # confirmacao do numero do titulo no banco
+          # :brancos, 134..145 # complemento de registro
+
+          # :vencimento, 146..151 # data de vencimento do titulo (ddmmaa)
+          parse.field :data_vencimento, 146..151
+
+          # :valor_do_titulo, 152..164 # valor nominal do titulo (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :valor_titulo, 152..164
+
+          # :codigo_do_banco, 165..167 # numero do banco na camara de compensacao
+          parse.field :banco_recebedor, 165..167
+
+          # :agencia_cobradora, 168..171 # agencia cobradora, ag de liquidacao ou baixa
+          # :dac_ag_cobradora, 172..172 # dac da agencia cobradora
+          # :agencia_recebedora_com_dv, 168..172
+
+          # :especie, 173..174 # especie do titulo
+          parse.field :especie_documento, 173..174
+
+          # :tarifa_de_cobranca, 175..187 # valor da despesa de cobranca (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :valor_tarifa, 175..187
+
+          # :outras_despesas 188..200, # valor de outras despesas ou custos do protesto
+          # :juros_operacao_em_atraso, 201..213 # zeros?
+
+          # :valor_do_iof, 214..226 # valor do iof a ser recolhido (ultimos 2 digitos, virgula decimal assumida)
+          # :iof, 214..226
+
+          # :valor_abatimento, 227..239 # valor do abatimento concedido (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :valor_abatimento, 227..239
+
+          # :descontos, 240..252 # valor do desconto concedido (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :desconto, 240..252
+
+          # :valor_recebido, 253..265 # valor lancado em conta corrente (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :valor_recebido, 253..265
+
+          # :juros_mora, 266..278 # valor de mora e multa pagos pelo sacado (ultimos 2 digitos, virgula decimal assumida)
+          parse.field :juros_mora, 266..278
+
+          # :outros_creditos, 279..291 # valor de outros creditos (ultimos 2 digitos, virgula decimal assumida)
+          # :outros_recebimento, 279..291
+
+          # :brancos, 292..293
+          # :motivo_do_codigo_de_ocorrencia, 294..294
+
+          # :data_credito, 295..300 # data de credito desta liquidacao
+          parse.field :data_credito, 146..151
+
+          # :origem_pagamento, 301..303
+          # :brancos, 304..313
+          # :cheque_bradesco, 314..317
+          # :motivo_rejeicao, 318..327
+          # :brancos, 328..367
+          # :numero_do_cartorio, 368..369
+          # :numero_do_protocolo, 370..379
+          # :brancos, 380..393
+
+          parse.field :motivo_ocorrencia, 279..393
+
+          # :numero_sequencial, 394..399 # numero sequencial no arquivo
+          parse.field :sequencial, 394..399
+        end
+      end
+    end
+  end
+end