Accounting

CLUB1 does not use a dedicated bank account. Instead, members who spent money note these expenses in a transaction file. When memberships are paid or donation are received, they are transferred to one of the people who have a negative balance.

Transactions file

The club’s accounting is recorded on the server using a transactions file. It is located at the following path:

/var/compta/transactions.tsv

As its extension indicates, this is a TSV (Tab Separated Values) file. Each line in this file represents a transaction. Within it, the different values are separated by tabs (Tab ↹ key).

Here is a line example:

27	2019-01-10	+35	Nicolas Peugnet	x	adhesion	Adhésion roquefort

La première colonne correspond à l’identifiant unique de chaque transaction. Ce nombre doit toujours augmenter. Ensuite, c’est la date d’ajout de la transaction. Puis le montant de cette dernière. On indique un + ou un - devant pour indiquer si c’est de l’argent qui entre ou qui sort. Le compte qui a dépensé ou reçu l’argent viens ensuite. Si le paiement est effectué, on ajoute un x. Les différentes catégories sont adhesion, don, infra et autre. Enfin, viens l’intitulé, qui est une courte description de la transaction.

Permissions

This file is readable by all users. So feel free to take a look! However, to write in it, you must be a member of the compta group.

Use

To study or modify the transaction list, simply open the file in a text editor. But hey, it’s not necessarily very convenient. To overcome this, it’s possible to use commands once you’re connected to the server via SSH.

Depending on your familiarity with the terminal, two options are available:

Friendly interface

This interface is made to be as simple as possible. It’s just asking questions.

compta

User-friendly interface for CLUB1’s accounting management.

Commands for advanced use

Users more familiar with using the CLI can directly use the following commands.

compta-voir

Allows one to quickly view the contents of the accounting file. It is possible to filter or even display the total, by providing options.

compta-ajouter

Allows one to add a transaction to the accounting file. It is necessary to fill most of the options.

compta-effectuer

Allows one to mark a transaction as “done”. Knowing the ID of the transaction is required to modify it.

Tip

Each one has a help section that describes how it works. It is displayed with the -h option.

Software used

compta

A set of scripts to display or edit club1’s accounting via the terminal. — Sources