https://github.com/folio-org/mod-invoice
Invoice business logic
https://github.com/folio-org/mod-invoice
Last synced: 2 months ago
JSON representation
Invoice business logic
- Host: GitHub
- URL: https://github.com/folio-org/mod-invoice
- Owner: folio-org
- License: apache-2.0
- Created: 2019-02-12T20:35:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2026-03-18T20:50:23.000Z (3 months ago)
- Last Synced: 2026-03-19T06:15:44.524Z (3 months ago)
- Language: Java
- Homepage:
- Size: 2.58 MB
- Stars: 2
- Watchers: 15
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# mod-invoice
Copyright (C) 2019-2023 The Open Library Foundation
This software is distributed under the terms of the Apache License,
Version 2.0. See the file "[LICENSE](LICENSE)" for more information.
## Introduction
This is the Invoice business logic module.
## Additional information
NOTE: Only in case an acquisition unit has to be assigned to the Invoice, it is required that user should have an
extra permission `invoices.acquisitions-units-assignments.create.execute` to create an invoice.
NOTE: Only in case an acquisition units list has to be changed for the Invoice, it is required that user should have an
extra permission `invoices.acquisitions-units-assignments.manage.execute` to update an invoice.
### Integration
#### Data import Kafka consumer
In order to fail the module start-up when data import Kafka consumer creation is failed the one should set
`dataimport.consumer.verticle.mandatory` variable to `true`.
## Interaction with Kafka
There are several properties that should be set for modules that interact with Kafka: **KAFKA_HOST, KAFKA_PORT, OKAPI_URL, ENV**(unique env ID).
After setup, it is good to check logs in all related modules for errors. Data import consumers and producers work in separate verticles that are set up in RMB's InitAPI for each module. That would be the first place to check deploy/install logs.
**Environment variables** that can be adjusted for this module and default values:
* "_mod.invoice.kafka.DataImportConsumerVerticle.instancesNumber_": 1
* "_mod.invoice.kafka.DataImportConsumer.loadLimit_": 5
* "*mod.invoice.kafka.DataImportConsumerVerticle.maxDistributionNumbe*r": 100
* "_dataimport.consumer.verticle.mandatory_": false (should be set to true in order to fail the module at start-up if data import Kafka consumer creation failed)
**These variables are relevant for the **Iris** release. Module version: 5.0.0 (5.0.1, 5.0.2, 5.0.3).**
**Additional environment Variables** for 6.1+ versions:
* "_mod.invoice.kafka.CancelledJobConsumerVerticle.instancesNumber_": 1
* "_mod.invoice.kafka.CancelledJobExecutionConsumer.loadLimit_": 1000
### Issue tracker
See project [MODINVOICE](https://issues.folio.org/browse/MODINVOICE)
at the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker).
### Other documentation
Other [modules](https://dev.folio.org/source-code/#server-side) are described,
with further FOLIO Developer documentation at
[dev.folio.org](https://dev.folio.org/)