codelicious/php-belgianbankstatement-parser

Unified parser for several bank statement formats from Belgian banks

v2.4.0 2022-08-11 14:37 UTC

Requires

• php: >=7.0
• codelicious/php-coda-parser: ^2.1
• kingsquare/php-mt940: ^1.1

Requires (Dev)

• phpunit/phpunit: ^9.0

GPL-2.0-only

• Wim Verstuyf

• parsing
• mt940
• Bank
• Belgium
• coda

README

Unified parser for several bank statement formats from Belgian banks. Supports CODA, MT940 and CSV (BNP Paribas / Belfius / KBC / ING)

Installation

You can install Codelicious/BelgianBankStatement using Composer. You can read more about Composer and its main repository at http://packagist.org. First install Composer for your project using the instructions on the Packagist home page, then define your dependency on Codelicious/BelgianBankStatement in your composer.json file.

    {
        "require": {
            "codelicious/php-belgianbankstatement-parser": "^2.0"
        }
    }

Or you can execute the following command in your project root to install this library:

composer require codelicious/php-belgianbankstatement-parser

Usage

<?php

use Codelicious\BelgianBankStatement;

$parser = new Parser();
$statement = $parser->parseFile('coda-file.cod', 'coda');

echo $statement->getDate()->format('Y-m-d') . "\n";

foreach ($statement->getTransactions() as $transaction) {
    echo $transaction->getAccount()->getName() . ": " . $transaction->getAmount() . "\n";
}

echo $statement->newBalance() . "\n";

Statement structure

• Codelicious\BelgianBankStatement\Statement
  • Date Date of the supplied file (format YYYY-MM-DD)
  • Account Account for which the statements were created. An object implementing Codelicious\BelgianBankStatement\Account
  • InitialBalance Balance of the account before the transactions were processed. Up to 3 decimals.
  • NewBalance Balance of the account after the transactions were processed. Up to 3 decimals.
  • Transactions A list of transactions implemented as Codelicious\BelgianBankStatement\Transaction
• Codelicious\BelgianBankStatement\Account
  • Name Name of the holder of the account
  • Bic Bankcode of the account
  • Number Banknumber of the account
  • CurrencyCode Currency of the account
  • CountryCode Country of the account
• Codelicious\BelgianBankStatement\Transaction
  • Account Account of the other party of the transaction. An object implementing Codelicious\BelgianBankStatement\Account
  • TransactionDate Date on which the transaction was requested
  • ValutaDate Date on which the transaction was executed by the bank
  • Amount Amount of the transaction. Up to 3 decimals. A negative number for credit transactions.
  • Message Message of the transaction
  • StructuredMessage Structured messages of the transaction (if available)