Skip to main content

caerp_payment

Project description

NB : À parir de la version 2.0, cette librairie ne supporte plus python 2

Cette librairie a pour objectif de fournir un ensemble cohérent pour la gestion des encaissements, ce afin de répondre aux exigences de la loi de finance 2018. Le texte suivant http://bofip.impots.gouv.fr/bofip/10691-PGP décrit plus en détail le besoin à couvrir

Elle fonctionne comme suit :

  • Les opérations d’encaissement sont effectuées au travers d’une API publique

  • Pour chaque opération d’encaissement, une entrée est écrite dans le journal

Le journal est le garant de l’intégrité des opérations d’encaissement.

Activation du module

L’api publique est configurable dans CAErp au travers du fichier de configuration .ini.

Assurez-vous que la librairie caerp_payment est bien dans les caerp.includes

caerp.includes = ...
                   ...
                   caerp_payment

Configurez le service caerp.interfaces.IPaymentRecordService

caerp.interfaces.IPaymentRecordService = caerp_payment.public.PaymentService

Configurez les journaux de ‘caerp_payment’. Voir la documentation sur le module python logging pour le détail : https://docs.python.org/2/library/logging.html ainsi que les exemples dans le fichier development.ini.sample.

Configurez le service de journalisation caerp_payment.interfaces.IPaymentRecordHistoryService à utiliser.

caerp_payment propose deux services de journalisation

HistoryLogService : Service par défaut, prévu pour le mode développement, se content de journaliser les actions sans détails.

HistoryDBService : Journalise les actions effectuées dans une base de données spécifiques (pas forcément sur le même serveur mysql)

HistoryDBService

Pour activer la journalisation détaillée dans une base de données spécifiques ajouter la ligne suivante dans la section [app:caerp] du fichier .ini

caerp_payment.interfaces.IPaymentRecordHistoryService = caerp_payment.history.caerp_payment.history.HistoryDBService

Créer une nouvelle base de données, vous pouvez utiliser l’utilitaire ./tools/add_payment_database.sh fournit dans le repository caerp.

cd caerp/
./tools/add_payment_database.sh
# Suivez les instructions

Puis saisissez les informations de connexion de la nouvelle base de données dans la section [app:caerp] du fichier .ini

caerp_payment_db.url = mysql://caerp_payment:caerp_payment@localhost/caerp_payment?charset=utf8

Archivage

Afin de certifier l’historique des actions sur les encaissements, caerp_payment permet l’utilisation d’un service d’archivage.

Version locale, ajouter la ligne suivante à la configuration .ini du service caerp dans la section [app:caerp]

caerp_payment.interfaces.IPaymentArchiveService=caerp_payment.archive.FileArchiveService
caerp_payment_archive_storage_path=<chemin sur disque pour le stockage des journaux>

La version locale fournie une solution acceptable de certification des journaux d’encaissement.

Afin d’obtenir une solution plus endurcie, on préfèrera l’utilisation d’un service distant avec un tiers certifié.

Une configuration complète contient donc les informations suivantes

caerp.includes =
            ....
            caerp_payment

# Accès à la bdd de traitement des paiements
caerp_payment_db.url = mysql://caerp_payment:caerp_payment@localhost/caerp_payment?charset=utf8

# Le service qui sera utilisé depuis caerp pour agir sur les encaissements
caerp.interfaces.IPaymentRecordService = caerp_payment.public.PaymentService

# Le service qui sera utilisé par caerp_payment pour stocker l'historique des actions d'encaissement
caerp_payment.interfaces.IPaymentRecordHistoryService = caerp_payment.history.HistoryDBService

# Le service en charge de la génération d'une archive avec un peu de certification d'intégrité des journaux
caerp_payment.interfaces.IPaymentArchiveService = caerp_payment.archive.FileArchiveService

# Le chemin utilisé par le service d'archivage pour le stockage sur disque
caerp_payment_archive_storage_path = /var/caerp/files/treasury/payment_storage

Consultation des journaux

Si le service HistoryDBService est utilisé, caerp_payment ajoute automatiquement une entrée dans le menu Comptabilité d’CAErp permettant la consultation du journal des modifications apportées aux encaissements.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

caerp_payment-2024.0.10.tar.gz (31.5 kB view details)

Uploaded Source

Built Distribution

caerp_payment-2024.0.10-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

Details for the file caerp_payment-2024.0.10.tar.gz.

File metadata

  • Download URL: caerp_payment-2024.0.10.tar.gz
  • Upload date:
  • Size: 31.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for caerp_payment-2024.0.10.tar.gz
Algorithm Hash digest
SHA256 31ae2a651d79fc710f34d38ba09f7250eef8580ea2c80052808a7b8137e6fb04
MD5 4fdbb757427aa3fcbf0329f60336c3c1
BLAKE2b-256 52d7ceb0c11f4f55d8b91c56c245c8d7fde6e59061630409d416214b392faf17

See more details on using hashes here.

File details

Details for the file caerp_payment-2024.0.10-py3-none-any.whl.

File metadata

File hashes

Hashes for caerp_payment-2024.0.10-py3-none-any.whl
Algorithm Hash digest
SHA256 0076fe72524aa3ee5d5aa4617f2429895e2b1ae23deecb6e40314e67130fe548
MD5 6643f9805a108d847ae0711b177d617e
BLAKE2b-256 a47b3aed318d0e90e5658d2b17df2af23a1f5b12e207ac5dab10d66a5cf1b9e0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page