cnab_rb 0.1.0

data/lib/cnab_rb/layouts/cnab240/generic/header_file.rb

@@ -0,0 +1,211 @@
+module CnabRb::Layouts::Cnab240::Generic
+  class HeaderFile < CnabRb::Layouts::Layout
+    def init_fields
+      field :bank_code,
+        pos: 1..3,
+        picture: '9(3)'
+
+      field :service_batch,
+        # Se registro for Header do Arquivo = '0000'
+        pos: 4..7,
+        picture: '9(4)',
+        default: 0
+
+      field :registry_type,
+        # Código adotado pela FEBRABAN para identificar o tipo de registro.
+        # '0' = Header de Arquivo
+        pos: 8..8,
+        picture: '9(1)',
+        default: '0'
+
+      field :exclusive_use_febraban_1,
+        pos: 9..17,
+        picture: 'X(9)',
+        default: ''
+
+      field :registration_code,
+        # '1' = CPF
+        # '2' = CGC / CNPJ
+        pos: 18..18,
+        picture: '9(1)'
+
+      field :registration_number,
+          # CNPJ ou CPF
+        pos: 19..32,
+        picture: '9(14)'
+
+      field :agreement_code,
+        # Código do Convênio no Banco (Código do Cedente)
+        # Código fornecido pela CAIXA, através da agência de relacionamento do cliente, específico para
+        # identificar determinados tipos de serviços / produtos.
+        # O campo CÓDIGO DO CEDENTE deverá ser preenchido da seguinte forma:
+        # AAAAOOOCCCCCCCCD, onde:
+        # AAAA = código da Agência CAIXA de relacionamento do cliente / cedente
+        # OOO = Operação
+        # CCCCCCCC = Número da Conta Corrente ou seqüencial
+        # D = Dígito Verificador
+        pos: 33..48,
+        picture: '9(16)'
+
+      field :exclusive_use_bank_1,
+        # Padrão: deixar em branco
+        pos: 49..52,
+        picture: 'X(4)',
+        default: ''
+
+      field :agency,
+        # Código da Agência mantenedora da conta, fornecido pela CAIXA.
+        pos: 53..57,
+        picture: '9(5)'
+
+      field :agency_cd,
+        # Dígito Verificador da Agência mantendedora da conta, fornecido pela CAIXA.
+        pos: 58..58,
+        picture: '9(1)'
+
+      field :transferor_code,
+        # Código do Cedente
+        # Remessa: Código do Convênio no Banco (sem operação), tamanho: 12 posições, no formato
+        # 0000CCCCCCCC.
+        # Retorno: Código do Convênio no Banco (com operação), tamanho: 12 posições, no formato
+        # 0OOOCCCCCCCC.
+        # Onde:
+        # 0 = zero
+        # OOO = Operação
+        # CCCCCCCC = Cedente
+        pos: 59..70,
+        picture: '9(12)'
+
+      field :transferor_code_cd,
+        # Dígito Verificador do Cedente
+        # Código adotado pela CAIXA, para verificação da autenticidade do Código do Cedente. Calculado
+        # através do módulo 11.
+        # Exemplo de como calcular o DV do Cedente:
+        # Agência/Código do Cedente: 0012.870.00000575-1
+        # Para Remessa – Cedente sem operação e sem DV: 00000575
+        # Para Retorno – Cedente com operação e sem DV: 87000000575
+        # 0 0 0 0 0 5 7 5
+        # 9 8 7 6 5 4 3 2
+        # 0 0 0 0 0 20 21 10
+        # 1ª linha – Código do Cedente
+        # 2ª linha – Índice multiplicação, preencher sequencialmente de 2 a 9 da direita para a esquerda
+        # 3ª linha – Multiplicação coluna por coluna (0x9, 0x8, 0x7, 0x6, 0x5, 0x4, 3x3, 3x2)
+        # Soma-se os valores da 3ª linha: 0+0+0+0+0+20+21+10 = 51
+        # Dividir o resultado da soma por onze: 51/11 = 4 (resto 7)
+        # Subtrair onze pelo resto da divisão: 11 – 7 = 4
+        # O Dígito Verificador calculado para o Código de Cedente acima é 4
+        # Obs.: se o resultado da subtração for maior que 9 (nove) o dígito será 0 (zero)
+        pos: 71..71,
+        picture: '9(1)'
+
+      field :agency_transferor_cd,
+        # Dígito Verificador da Agência / Código do Cedente
+        # Código adotado pela CAIXA para verificação da autenticidade do par Código da Agência / Código do
+        # Cedente. Calculado através do módulo 11.
+        # Obs: Para o Retorno é o mesmo DV do Código do Cedente, fornecido pela CAIXA.
+        # Exemplo de como calcular o DV da Agência/Código do Cedente (Remessa):
+        # Agência/Código do Cedente: 0012.870.00000575-1
+        # Agência (sem DV): 0012
+        # Cedente (sem operação e sem DV) – tamanho 8 posições: 00000575
+        # 0  0  1  2  0  0  0  0  0   5   7   5
+        # 5  4  3  2  9  8  7  6  5   4   3   2
+        # 0  0  3  4  0  0  0  0  0  20  21  10
+        # 1ª Linha – Agência/Código do Cedente
+        # 2ª Linha – Ìndice multiplicação, preencher sequencialmente de 2 a 9 da direita para a esquerda
+        # 3ª Linha – Multiplicação coluna por coluna
+        # Soma-se os valores da 3ª linha: 0+0+3+4+0+0+0+0+0+20+21+10 = 58
+        # Dividir o resultado da soma por onze: 58/11 = 5 (RESTO 3)
+        # Subtrair onze pelo resto da divisão: 11 – 3 = 8
+        # O Dígito Verificador calculado para o Código de Cedente acima é 8
+        # Obs.: se o resultado da subtração for maior que 9 (nove) o dígito será 0 (zero)
+        # No Banco do Brasil, é o Dígito verificador da Ag/Conta
+        pos: 72..72,
+        picture: '9(1)'
+
+      field :company_name,
+        # Nome que identifica a pessoa, física ou jurídica, a qual se quer fazer referência
+        pos: 73..102,
+        picture: 'X(30)'
+
+      field :bank_name,
+        # Nome que identifica o banco que está recebendo ou enviando o arquivo.
+        # Informar: CAIXA ECONÔMICA FEDERAL (se o banco for a caixa)
+        pos: 103..132,
+        picture: 'X(30)'
+
+      field :exclusive_use_febraban_2,
+        # Texto de observações destinado para uso exclusivo da FEBRABAN. Preencher com Brancos.
+        pos: 133..142,
+        picture: 'X(10)',
+        default: ''
+
+      field :remittance_return_code,
+        # Código Remessa / Retorno
+        # Código adotado pela febraban para qualificar o envio ou devolução de arquivo entre a empresa
+        # cliente e o banco prestador dos serviços. informar:
+        # '1' = remessa (cliente banco)
+        # '2' = retorno (banco cliente)
+        pos: 143..143,
+        picture: '9(1)'
+
+      field :generation_date,
+        # Data da criação do arquivo. utilizar o formato DDMMAAAA, onde : dd = dia, mm = mês, aa = ano
+        pos: 144..151,
+        picture: '9(8)',
+        date_format: '%d%m%Y'
+
+      field :generation_time,
+        # Hora da criação do arquivo. utilizar o formato hhmmss, onde : HH = hora, MM = minuto, SS = segundo
+        pos: 152..157,
+        picture: '9(6)',
+        date_format: '%H%M%S'
+
+      field :sequential_number_file,
+        # Número seqüencial adotado e controlado pelo responsável pela geração do arquivo para ordenar a
+        # disposição dos arquivos encaminhados.
+        # Evoluir um número seqüencial a cada header de arquivo.
+        pos: [158, 163],
+        picture: '9(6)'
+
+      file :layout_version,
+        # Código adotado pela FEBRABAN para identificar qual a versão de layout do arquivo encaminhado. O
+        # código é composto de:
+        # Versão = 2 dígitos
+        # Release = 1 dígito
+        # Padrão: 030
+        pos: 164..166,
+        picture: '9(3)',
+        default: '030'
+
+      file :density_file,
+        # Densidade de gravação (bpi), do arquivo encaminhado. Pode ser:
+        # 1600 BPI
+        # 6250 BPI
+        # Pode ser informado ‘0’. (Padrão)
+        pos: 167..171,
+        picture: '9(5)',
+        default: '0'
+
+      field :exclusive_use_bank,
+        # Para Uso Reservado do Banco
+        # Texto de observações destinado para uso exclusivo da caixa econômica federal.
+        # Durante a fase de testes (simulado) deverá conter a literal ‘RETORNO-TESTE’
+        pos: 172..191,
+        picture: 'X(20)',
+        default: ''
+
+      field :exclusive_use_company,
+        # Campo utilizado pelo cliente/cedente. Na fase de testes (simulado), deverá conter a literal
+        # ‘REMESSA-TESTE’ e na fase de produção deverá conter a literal ‘REMESSA-PRODUÇÃO’
+        pos: 192..211,
+        picture: 'X(20)',
+        default: 'REMESSA-PRODUCAO'
+
+      field :exclusive_use_febraban_2,
+        # Texto de observações destinado para uso exclusivo da FEBRABAN. Preencher com Brancos.
+        pos: 212..240,
+        picture: 'X(29)',
+        default: ''
+    end
+  end
+end

data/lib/cnab_rb/layouts/cnab240/generic/return/segment_a.rb

@@ -0,0 +1,163 @@
+module CnabRb::Layouts::Cnab240::Generic::Return
+  class SegmentA < CnabRb::Layouts::Layout
+    def init_fields
+      field :bank_code,
+        # codigo_banco
+        pos: 1..3,
+        picture: '9(3)'
+
+      field :service_batch,
+        # lote_servico
+        pos: 4..7,
+        picture: '9(4)'
+
+      field :registry_type,
+        # tipo_registro
+        pos: 8..8,
+        picture: '9(1)',
+        default: '3'
+
+      field :sequential_number_batch,
+        # numero_sequencial_lote
+        pos: 9..13,
+        picture: '9(5)'
+
+      field :segment_code,
+        # codigo_segmento
+        pos: 14..14,
+        picture: 'X(1)',
+        default: 'A'
+
+      field :movement_type,
+        # tipo_movimento
+        pos: 15..15,
+        picture: '9(1)',
+        default: ''
+
+      field :movement_instruction_code,
+        # codigo_instrucao_movimento
+        pos: 16..17,
+        picture: '9(2)'
+
+      field :centering_chamber,
+        # camara_centralizadora
+        pos: 18..20,
+        picture: '9(3)'
+
+      field :favored_bank,
+        # banco_favorecido
+        pos: 21..23,
+        picture: '9(3)'
+
+      field :favored_agency,
+        # agencia_favorecido
+        pos: 24..28,
+        picture: '9(5)'
+
+      field :favored_agency_cd,
+        # agencia_dv_favorecido
+        pos: 29..29,
+        picture: 'X(1)'
+
+      field :favored_account,
+        # conta_favorecido
+        pos: 30..41,
+        picture: '9(12)'
+
+      field :favored_account_cd,
+        # conta_dv_favorecido
+        pos: 42..42,
+        picture: 'X(1)'
+
+      field :favored_agency_account_cd,
+        # agencia_conta_dv_favorecido
+        pos: 43..43,
+        picture: 'X(1)'
+
+      field :favored_name,
+        # nome_favorecido
+        pos: 44..73,
+        picture: 'X(30)'
+
+      field :document_number,
+        # numero_documento
+        pos: 74..93,
+        picture: 'X(20)'
+
+      field :payment_date,
+        # data_pagamento
+        pos: 94..101,
+        picture: '9(8)',
+        date_format: '%d%m%Y'
+
+      field :currency_code,
+        # tipo_moeda
+        pos: 102..104,
+        picture: 'X(3)',
+        default: 'BRL'
+
+      field :coin_quantity,
+        # quantidade_moeda
+        pos: 105..119,
+        picture: '9(10)V9(5)'
+
+      field :payment_amount,
+        # valor_pagamento
+        pos: 120..134,
+        picture: '9(13)V9(2)'
+
+      field :our_number,
+        # nosso_numero
+        pos: 135..154,
+        picture: 'X(20)'
+
+      field :real_date,
+        # data_real
+        pos: 155..162,
+        picture: '9(8)',
+        date_format: '%d%m%Y'
+
+      field :real_amount,
+        # valor_real
+        pos: 163..177,
+        picture: '9(13)V9(2)'
+
+      field :information_2,
+        # informacao_2
+        pos: 178..217,
+        picture: 'X(40)'
+
+      field :document_finality,
+        # finalidade_doc
+        pos: 218..219,
+        picture: 'X(2)'
+
+      field :ted_finality,
+        # finalidade_ted
+        pos: 220..224,
+        picture: 'X(5)'
+
+      field :complementary_finality,
+        # finalidade_complementar
+        pos: 225..226,
+        picture: 'X(2)'
+
+      field :exclusive_use_febraban_1,
+        # uso_exclusivo_febraban
+        pos: 227..229,
+        picture: 'X(3)',
+        default: ''
+
+      field :notice,
+        # aviso
+        pos: 230..230,
+        picture: '9(1)'
+
+      field :ocurrences,
+        # ocorencias
+        pos: 231..240,
+        picture: 'X(10)',
+        default: ''
+    end
+  end
+end

data/lib/cnab_rb/layouts/cnab240/generic/return/segment_t.rb

@@ -0,0 +1,151 @@
+module CnabRb::Layouts::Cnab240::Generic::Return
+  class SegmentT < CnabRb::Layouts::Layout
+    def init_fields
+      field :bank_code,
+        # codigo_banco
+        pos: 1..3,
+        picture: '9(3)'
+
+      field :service_batch,
+        # lote_servico
+        pos: 4..7,
+        picture: '9(4)'
+
+      field :registry_type,
+        # tipo_registro
+        pos: 8..8,
+        picture: '9(1)'
+
+      field :sequential_number_batch,
+        # numero_sequencial_lote
+        pos: 9..13,
+        picture: '9(5)'
+
+      field :segment_code,
+        # codigo_segmento
+        pos: 14..14,
+        picture: 'X(1)'
+
+      field :exclusive_use_febraban_1,
+        # uso_exclusivo_febraban_01
+        pos: 15..15,
+        picture: 'X(1)'
+
+      field :movement_code,
+        # codigo_movimento
+        pos: 16..17,
+        picture: '9(2)'
+
+      field :mantainer_agency,
+        # agencia_mantenedora
+        pos: 18..22,
+        picture: '9(5)'
+
+      field :agency_cd,
+        # agencia_dv
+        pos: 23..23,
+        picture: '9(1)'
+
+      field :transferor_code,
+        # codigo_cedente
+        pos: 24..35,
+        picture: '9(12)'
+
+      field :transferor_code_cd,
+        # codigo_cedente_dv
+        pos: 36..36,
+        picture: '9(1)'
+
+      field :agency_transferor_cd,
+        # agencia_dv_mais_cedente_dv
+        pos: 37..37,
+        picture: '9(1)'
+
+      field :our_number,
+        # nosso_numero
+        pos: 38..57,
+        picture: '9(20)'
+
+      field :wallet_code,
+        # codigo_carteira
+        pos: 58..58,
+        picture: '9(1)'
+
+      field :document_number,
+        # numero_documento
+        pos: 59..73,
+        picture: 'X(15)'
+
+      field :due_date,
+        # data_vencimento
+        pos: 74..81,
+        picture: '9(8)',
+        date_format: '%d%m%Y'
+
+      field :title_amount,
+        # valor_titulo
+        pos: 82..96,
+        picture: '9(13)V9(2)'
+
+      field :bank_number,
+        # numero_banco
+        pos: 97..99,
+        picture: '9(3)'
+
+      field :collector_agency,
+        # agencia_cobradora
+        pos: 100..104,
+        picture: '9(5)'
+
+      field :collector_agency_cd,
+        # agencia_cobradora_dac
+        pos: 105..105,
+        picture: '9(1)'
+
+      field :company_use,
+        # uso_empresa
+        pos: 106..130,
+        picture: 'X(25)'
+
+      field :currency_code,
+        # codigo_moeda
+        pos: 131..132,
+        picture: '9(2)'
+
+      field :registration_type,
+        # tipo_inscricao
+        pos: 133..133,
+        picture: '9(1)'
+
+      field :registration_number,
+        # numero_inscricao
+        pos: 134..148,
+        picture: '9(15)'
+
+      field :draw_name,
+        # nome_sacado
+        pos: 149..188,
+        picture: 'X(40)'
+
+      field :exclusive_use_febraban_2,
+        # uso_exclusivo_febraban_02
+        pos: 189..198,
+        picture: 'X(10)'
+
+      field :tax_amount,
+        # valor_tarifa
+        pos: 199..213,
+        picture: '9(13)V9(2)'
+
+      field :rejection_indentification,
+        # identificacao_rejeicao
+        pos: 214..223,
+        picture: 'X(10)'
+
+      field :exclusive_use_febraban_3,
+        # uso_exclusivo_febraban
+        pos: 224..240,
+        picture: 'X(17)'
+    end
+  end
+end

data/lib/cnab_rb/layouts/cnab240/generic/return/segment_u.rb

@@ -0,0 +1,127 @@
+module CnabRb::Layouts::Cnab240::Generic::Return
+  class SegmentU < CnabRb::Layouts::Layout
+    def init_fields
+      field :bank_code,
+        # codigo_banco
+        pos: 1..3,
+        picture: '9(3)'
+
+      field :service_batch,
+        # lote_servico
+        pos: 4..7,
+        picture: '9(4)'
+
+      field :registry_type,
+        # tipo_registro
+        pos: 8..8,
+        picture: '9(1)'
+
+      field :sequential_number_register,
+        # numero_sequencial_registro
+        pos: 9..13,
+        picture: '9(5)'
+
+      field :segment_code,
+        # codigo_segmento
+        pos: 14..14,
+        picture: 'X(1)'
+
+      field :exclusive_use_febraban_1,
+        # uso_exclusivo_febraban_01
+        pos: 15..15,
+        picture: 'X(1)'
+
+      field :movement_code,
+        # codigo_movimento
+        pos: 16..17,
+        picture: '9(2)'
+
+      field :additions_amount,
+        # valor_acrescimos
+        pos: 18..32,
+        picture: '9(13)V9(2)'
+
+      field :discount_amount,
+        # valor_desconto
+        pos: 33..47,
+        picture: '9(13)V9(2)'
+
+      field :abatement_amount,
+        # valor_abatimento
+        pos: 48..62,
+        picture: '9(13)V9(2)'
+
+      field :iof_amount,
+        # valor_iof
+        pos: 63..77,
+        picture: '9(13)V9(2)'
+
+      field :paid_amount,
+        # valor_pago
+        pos: 78..92,
+        picture: '9(13)V9(2)'
+
+      field :net_amount,
+        # valor_liquido
+        pos: 93..107,
+        picture: '9(13)V9(2)'
+
+      field :other_expenses_amount,
+        # valor_outras_despesas
+        pos: 108..122,
+        picture: '9(13)V9(2)'
+
+      field :other_credits_amount,
+        # valor_outros_creditos
+        pos: 123..137,
+        picture: '9(13)V9(2)'
+
+      field :ocurrency_date,
+        # data_ocorrencia
+        pos: 138..145,
+        picture: '9(8)',
+        date_format: '%d%m%Y'
+
+      field :credit_date,
+        # data_credito
+        pos: 146..153,
+        picture: '9(8)',
+        date_format: '%d%m%Y'
+
+      field :ocurrency_drawn_code,
+        # ocorrencia_sacado_codigo
+        pos: 154..157,
+        picture: 'X(4)'
+
+      field :ocurrency_drawn_date,
+        # ocorrencia_sacado_data
+        pos: 158..165,
+        picture: 'X(8)'
+
+      field :ocurrency_drawn_amount,
+        # ocorrencia_sacado_valor
+        pos: 166..180,
+        picture: '9(13)V9(2)'
+
+      field :ocurrency_draw_complement,
+        # ocorrencia_sacado_complemento
+        pos: 181..210,
+        picture: 'X(30)'
+
+      field :ocurrency_draw_corresponding,
+        # codigo_banco_correspondente
+        pos: 211..213,
+        picture: '9(3)'
+
+      field :our_number_bank_corresponding,
+        # nosso_numero_banco_correspondente
+        pos: 214..233,
+        picture: '9(20)'
+
+      field :exclusive_use_febraban_2,
+        # uso_exclusivo_febraban_02
+        pos: 234..240,
+        picture: '9(7)'
+    end
+  end
+end

data/lib/cnab_rb/layouts/cnab240/generic/return/segment_w.rb

@@ -0,0 +1,65 @@
+module CnabRb::Layouts::Cnab240::Generic::Return
+  class SegmentW < CnabRb::Layouts::Layout
+    def init_fields
+      field :bank_code,
+        # codigo_banco
+        pos: 1..3,
+        picture: '9(3)'
+
+      field :service_batch,
+        # lote_servico
+        pos: 4..7,
+        picture: '9(4)'
+
+      field :registry_type,
+        # tipo_registro
+        pos: 8..8,
+        picture: '9(1)'
+
+      field :sequantial_number,
+        # numero_sequencial
+        pos: 9..13,
+        picture: '9(5)'
+
+      field :segment_code,
+        # codigo_segmento
+        pos: 14..14,
+        picture: 'X(1)'
+
+      field :exclusive_use_febraban_1,
+        # uso_exclusivo_febraban_01
+        pos: 15..15,
+        picture: 'X(1)'
+
+      field :movement_code,
+        # codigo_movimento
+        pos: 16..17,
+        picture: '9(2)'
+
+      field :relative_position,
+        # posicao_relativa
+        pos: 18..23,
+        picture: '9(6)'
+
+      field :exclusive_use_bank_1,
+        # uso_exclusivo_banco_01
+        pos: 24..24,
+        picture: 'X(1)'
+
+      field :field_01_code,
+        # codigo_campo_01
+        pos: 25..28,
+        picture: '9(4)'
+
+      field :error_01_code,
+        # codigo_erro_01
+        pos: 29..31,
+        picture: '9(3)'
+
+      field :todo_repeat_code_field_error_20,
+        # todo_repeat_codigo_campo_codigo_erro_20
+        pos: 32..157,
+        picture: 'X(126)'
+    end
+  end
+end