Project

cfonb

0.0
The project is in a healthy, maintained state
An easy to use CFONB format parser
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

CFONB Parser

This parser aim at simplifying the parsing of CFONB structured files. Which are files structured with either 120 or 240 characters lines containing mostly bank statements. We aimed here only at the 120 characters version.

What CFONB means ? Comité Français d’Organisation et de Normalisation Bancaire

Requirements

None.

Installation

gem install cfonb

Or, put it in your Gemfile:

gem 'cfonb'

Available Operation Details

OperationDetails are lines starting with 05. They aim at providing additional information about the operation.

Find bellow the list of additional details available for each operation. If you encouter new ones, please open an issue or a pull request with the appropriate implementation. We aimed at making it as easy as possible to add new details. You just need to do the following on initialization:

CFONB::OperationDetails.register('FEE', self)
Detail Code Attributes Description
FEE fee, fee_currency Represents operation fees the bank is applying
LCC unstructured_label Not structured label line 1 (first 70 characters)
LC2 unstructured_label_2 Not structured label line 2 (last 70 characters)
LCS structured_label Structured label
LIB free_label Free label
MMO original_currency, original_amount, scale, exchange_rate, exchange_rate_scale Amount and currency if it has been converted from a foreign currency
NBE creditor Name of the creditor or beneficiary
NPY debtor Name of the debtor or payer
RCN reference, purpose Client reference and Payment nature/purpose
REF operation_reference Bank operation reference
IPY debtor_identifier, debtor_identifier_type Debtor identifier and debtor identifier type
IBE creditor_identifier, creditor_identifier_type Creditor identifier and the type of identifier
NPO ultimate_debtor Name of the ultimate debtor or beneficiary
NBU ultimate_creditor Name of the ultimate creditor or payer

TODO:

Detail Code Attributes Description
IPY debtor_identifier Identifier of the debtor or payer
NPO ultimate_debtor Name of the ultimate debtor or beneficiary
NBU ultimate_creditor Name of the ultimate creditor or payer
RET unifi_code, sit_code, payback_label Payback informations
CBE creditor_account Account of the creditor or beneficiary
BDB creditor_bank Bank of the creditor or beneficiary
LEM issuer_label Issuer Label

Usage

require 'cfonb'

# Parse a file
text = File.open('spec/files/example.txt')
cfonb = CFONB.parse(text)

Contributing

Bug reports and pull requests are welcome on GitHub.