Digest for AbraFlexi

Periodical business digest for AbraFlexi accounting system. Collects data via the php-abraflexi library, runs analytics modules from vitexsoftware/digest-modules, and outputs Markdown, HTML, or PDF reports.

Architecture

vitexsoftware/abraflexi-digest  (this package)
  src/Digest/Providers/AbraFlexiDataProvider.php   — AbraFlexi → neutral schema
  src/Digest/ModularDigestor.php                   — wires provider + modules + renderer
  src/Digest/Mailer.php                            — sends digest by email

vitexsoftware/digest-modules
  src/Modules/*.php                                — system-agnostic analytics modules

vitexsoftware/digest-renderer
  src/                                             — Markdown/HTML/PDF rendering

AbraFlexiDataProvider (namespace AbraFlexi\Digest\Providers) implements DataProviderInterface from vitexsoftware/digest-modules. It translates the neutral FILTER_* / FIELD_* constants into AbraFlexi WQL queries and normalizes raw AbraFlexi records (including AbraFlexi\Relation objects for firma, mena, typDokl) into the neutral field schema.

Features

• Extensible — add custom modules from vitexsoftware/digest-modules
• Multiple output formats — Markdown, HTML, PDF (via DigestRenderer)
• Email delivery — Symfony Mailer integration
• Skinnable — custom CSS themes
• Localized — Czech and English gettext localizations

Scripts

File	Description
abraflexi-daydigest.php	Generate digest for one day
abraflexi-weekdigest.php	Generate digest for one week
abraflexi-monthdigest.php	Generate digest for one month
abraflexi-yeardigest.php	Generate digest for one year
abraflexi-alltimedigest.php	Generate digest for all time

Installation

composer require vitexsoftware/abraflexi-digest

Or via Debian package:

wget -qO- https://repo.vitexsoftware.com/KEY.gpg | sudo tee /etc/apt/trusted.gpg.d/vitexsoftware.gpg
echo "deb [signed-by=/etc/apt/trusted.gpg.d/vitexsoftware.gpg] https://repo.vitexsoftware.com $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/vitexsoftware.list
sudo apt update
sudo apt install abraflexi-digest

After installation:

• abraflexi-daydigest — digest for one day
• abraflexi-weekdigest — digest for one week
• abraflexi-monthdigest — digest for one month
• abraflexi-yeardigest — digest for one year
• abraflexi-alltimedigest — digest for all time

Configuration

Create /etc/abraflexi/.env (or pass path as first CLI argument):

ABRAFLEXI_URL="https://your-abraflexi.example.com"
ABRAFLEXI_LOGIN="username"
ABRAFLEXI_PASSWORD="password"
ABRAFLEXI_COMPANY="your-company-db"

EASE_LOGGER="syslog|mail|console"
DIGEST_MAILTO="info@yourdomain.net"
DIGEST_FROM="noreply@vitexsoftware.cz"
THEME="happy"
DIGEST_SAVETO="/var/tmp/"
DIGEST_ITEMS_LIMIT=0
DIGEST_LOCALE="cs_CZ.UTF-8"

DIGEST_LOCALE selects the language of the digest (system locale, must be installed on the server: locale -a).

DIGEST_ITEMS_LIMIT sets the default maximum number of items listed in each section (0 = unlimited). Only the listing is shortened — totals and charts still use all data.

Programmatic usage

<?php
use AbraFlexi\Digest\ModularDigestor;
use AbraFlexi\Digest\Providers\AbraFlexiDataProvider;
use VitexSoftware\DigestModules\Core\ModuleRunner;
use VitexSoftware\DigestModules\Modules\Debtors;
use VitexSoftware\DigestModules\Modules\OutcomingInvoices;

$provider = new AbraFlexiDataProvider();

$runner = new ModuleRunner($provider);
$runner->addModule('outcoming_invoices', new OutcomingInvoices());
$runner->addModule('debtors', new Debtors());

$period = new \DatePeriod(
    new \DateTime('first day of last month'),
    new \DateInterval('P1M'),
    new \DateTime('first day of this month'),
);

$result = $runner->run($period);

Available modules

Modules live in vitexsoftware/digest-modules. All are supported by AbraFlexiDataProvider:

• OutcomingInvoices — issued invoices in the period
• IncomingInvoices — received invoices in the period
• IncomingPayments — bank receipts in the period
• OutcomingPayments — bank outflows in the period
• Debtors — all overdue unpaid receivables
• UnmatchedInvoices — issued invoices not matched to a payment
• UnmatchedPayments — bank movements not matched to an invoice
• WaitingIncome — proforma invoices awaiting settlement
• WaitingPayments — invoices awaiting payment
• NewCustomers — contacts created in the period
• Reminds — invoices with pending payment reminders
• BestSellers — top products/services sold in the period
• WithoutEmail — contacts missing an email address
• WithoutTel — contacts missing a phone number
• AllTime\PurchasePriceLowerThanSales — products sold below purchase price

See also

• vitexsoftware/digest-modules — analytics modules
• vitexsoftware/digest-renderer — rendering engine
• abraflexi-reminder
• php-abraflexi-matcher

MultiFlexi

Digest for AbraFlexi is ready to run as a MultiFlexi application.

Thanks

This software would not be created without the support of:

License

MIT