Skip to main content

NEMO billing

This billing plugin for NEMO includes core facilities and custom charges/adjustments. It also includes sub-modules for adding rates and invoices.

Installation

pip install NEMO-billing

Add core billing plugin

in settings.py add to INSTALLED_APPS:

INSTALLED_APPS = [
    '...',
    'NEMO_billing',  # Add before NEMO to have new navbar menu items show up
    'NEMO_billing.rates',
    'NEMO_billing.invoices',
    # 'NEMO_billing.cap_discount',  # Optional
    # 'NEMO_billing.prepayments',  # Optional
    # 'NEMO_billing.quotes',  # Optional
    # 'NEMO_billing.institution_agreements',  # Optional
    '...',
    # 'NEMO_user_details',  # If using user details plugin
    '...',
    'NEMO',
    '...'
]

NEMO Compatibility

NEMO-Billing NEMO NEMO-CE
>= 5.0.0 >= 8.0.0 >= 8.0.0
>= 4.10.0 >= 7.4.2 >= 7.4.6
>= 4.7.0 >= 7.3.3 >= 7.3.5
>= 4.4.0 >= 7.2.0 >= 7.2.0
>= 4.0.0 >= 7.0.0 >= 7.0.0
>= 3.0.0 >= 6.0.0 >= 6.0.0
>= 2.9.4 >= 5.5.3 >= 2.4.4
>= 2.9.1 >= 5.5.2
>= 2.9.0 >= 5.5.0
>= 2.8.0 >= 5.3.0
>= 2.7.0 >= 4.7.0
>= 2.6.13 >= 4.6.4
>= 2.5.8 >= 4.6.0
>= 2.0.0 >= 4.5.0
>= 1.23.0 >= 4.3.0
>= 1.22.2 >= 4.2.1
>= 1.22.1 >= 4.2.0
>= 1.19.0 >= 4.1.0
>= 1.18.0 >= 4.0.0
>= 1.16.0 >= 3.14.0
>= 1.13.0 >= 3.13.0
>= 1.5.0 >= 3.10.0

Usage

This plugin will add core facilities and custom charges which can be added through django admin.

Core Facility can be set on Custom Charges, Tools, Areas, Consumables and Staff Charges

There are 2 ways to set them up:

  1. In Detailed Administration -> Core Facilities, you can select each tool, area, consumable or staff charge
  2. In Detailed Administration -> NEMO on each individual custom charge, tool, area, consumable or staff charge

Core Facility can be accessed on a tool, area, consumable or staff charge using: tool.core_facility, area.core_facility, consumable.core_facility or staff_charge.core_facility

Options

By default, a Core Facility is not required for each custom charge, tool, area, consumable or staff charge.

That can be changed by updating the following default settings in settings.py:

TOOL_CORE_FACILITY_REQUIRED = False
AREA_CORE_FACILITY_REQUIRED = False
CONSUMABLE_CORE_FACILITY_REQUIRED = False
STAFF_CHARGE_CORE_FACILITY_REQUIRED = False
CUSTOM_CHARGE_CORE_FACILITY_REQUIRED = False

In the billing (user, project billing, billing API, invoices) tool usage and area access on behalf of a user (only during a remote project) are categorized as Staff Charges.

That can be changed by updating the following default settings in settings.py

STAFF_TOOL_USAGE_AS_STAFF_CHARGE = True
STAFF_AREA_ACCESS_AS_STAFF_CHARGE = True

Email templates

To change email templates, either go to Invoices customization settings in NEMO and upload new files, or directly create a file in NEMO's media folder with the same name.
The following templates can be set:

  • email_send_invoice_subject.txt
  • email_send_invoice_message.html
  • email_send_invoice_reminder_subject.txt
  • email_send_invoice_reminder_message.html
  • billing_project_expiration_reminder_email_subject.txt
  • billing_project_expiration_reminder_email_message.html

Timed services/cron jobs

To send reminder emails, set a cron job daily with one of the 2 options:

  1. send an authenticated http request to <nemo_url>/invoices/send_invoice_payment_reminder
  2. run command django-admin send_invoice_payment_reminder or python manage.py send_invoice_payment_reminder

Similarly, to automatically deactivate expired projects and send expiration reminders, set a cron job daily with one of the 2 options:

  1. send an authenticated http request to <nemo_url>/projects/deactivate_expired_projects
  2. run command django-admin deactivate_expired_projects or python manage.py deactivate_expired_projects

Add Rates plugin

in settings.py add to INSTALLED_APPS:

'NEMO_billing.rates',

Rates module options

The following default properties can be changed in settings.py

# The display rate currency is set to $ by default
RATE_CURRENCY = "CAD "
# Missed reservations rates will have the "flat" checkbox checked by default
DEFAULT_MISSED_RESERVATION_FLAT = True
# The rate list URL can be customized
RATE_LIST_URL = "fee_schedule"

Add Invoices plugin

in settings.py add to INSTALLED_APPS:

'NEMO_billing.invoices',

Invoices module options

The following default properties can be changed in settings.py:

# Date formats
INVOICE_DATETIME_FORMAT = "%m/%d/%Y %H:%M:%S"
INVOICE_DATE_FORMAT = "%B %d, %Y"
# Invoice email prefix
INVOICE_EMAIL_SUBJECT_PREFIX = "[NEMO Billing] "
# Whether to validate that all billable items belong to a core facility before generating invoice
INVOICE_ALL_ITEMS_MUST_BE_IN_FACILITY = False 

Add CAP discount plugin

in settings.py add to INSTALLED_APPS:

'NEMO_billing.cap_discount',

CAP Discount settings are available in Customization -> Billing CAP

Add Project prepayments/funds plugin

in settings.py add to INSTALLED_APPS:

'NEMO_billing.prepayments',

Add Quotes plugin

in settings.py add to INSTALLED_APPS:

'NEMO_billing.quotes',

Email templates

To add email templates, either go to Quotes customization settings in NEMO and upload new files, or directly create a file in NEMO's media folder with the same name.
The following templates are available in the resources folder:

  • quote_email.html
  • quote_approval_request_email.html
  • quote_status_update_email.html

Dashboard icon

You can add a dashboard icon in Detailed administration -> Landing page choices:

URL

  • make sure <nemo_url>/public_quote/* URL is public in your webserver (nginx, apache, etc.)

Add Institution agreements plugin

in settings.py add to INSTALLED_APPS:

'NEMO_billing.institution_agreements',

URL

  • the URL for service agreements is <nemo_url>/service_agreements/

Timed services/cron jobs

To send service agreement reminder emails, set a cron job daily with one of the 2 options:

  1. send an authenticated http request to <nemo_url>/service_agreements/email_institution_agreements_reminders
  2. run command django-admin send_institution_agreement_reminder or python manage.py send_institution_agreement_reminder

Post Installation

run:

python manage.py migrate

Metadata

Release files for NEMO-billing 5.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for NEMO-billing 5.0.7
File Size Uploaded
nemo_billing-5.0.7.tar.gz 234.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for NEMO-billing 5.0.7
File Interpreter ABI Platform
nemo_billing-5.0.7-py3-none-any.whl Python 3 none any Details

Total release size: 552.4 kB

Release files / nemo_billing-5.0.7.tar.gz

Download URL nemo_billing-5.0.7.tar.gz
Size 234.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ad128acabc386196edad62b3d97727ef47198ac00c2525ad659fa684e3633147
BLAKE2b-256 checksum
How to use checksums
48cb1450ac3916c442717c26325d95a951d05b617903e93893f1233ca404d4af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / nemo_billing-5.0.7-py3-none-any.whl

Download URL nemo_billing-5.0.7-py3-none-any.whl
Size 317.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a42c06153f85358f90fa334992f0c5d900a9305c0ab9fd9f1def849ad4b02f6e
BLAKE2b-256 checksum
How to use checksums
bea12152b88308c4dffc633b7a903d72b231672a46bc34d9075d0c6e8e7e4836
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

6.0.2

2 release files

This release

5.0.7 This release

2 release files

5.0.6

2 release files

5.0.5

2 release files

5.0.4

2 release files

5.0.3

2 release files

5.0.2

2 release files

5.0.1

2 release files

5.0.0

2 release files

4.10.4

2 release files

4.10.3

2 release files

4.10.0

2 release files

4.9.8

2 release files

4.9.7

2 release files

4.9.6

2 release files

4.9.5

2 release files

4.9.4

2 release files

4.9.3

2 release files

4.9.2

2 release files

4.9.1

2 release files

4.9.0

2 release files

4.8.0

2 release files

4.7.2

2 release files

4.7.1

2 release files

4.7.0

2 release files

4.6.9

2 release files

4.6.8

2 release files

4.6.7

2 release files

4.6.6

2 release files

4.6.5

2 release files

4.6.4

2 release files

4.6.3

2 release files

4.6.2

2 release files

4.6.1

2 release files

4.6.0

2 release files

4.5.10

2 release files

4.5.9

2 release files

4.5.8

2 release files

4.5.7

2 release files

4.5.6

2 release files

4.5.5

2 release files

4.5.4

2 release files

4.5.3

2 release files

4.5.2

2 release files

4.5.1

2 release files

4.5.0

2 release files

4.4.2

2 release files

4.4.1

2 release files

4.4.0

2 release files

4.3.5

2 release files

4.3.4

2 release files

4.3.3

2 release files

4.3.2

2 release files

4.3.1

2 release files

4.3.0

2 release files

4.2.3

2 release files

4.2.2

2 release files

4.2.1

2 release files

4.2.0

2 release files

4.1.3

2 release files

4.1.2

2 release files

4.1.1

2 release files

4.1.0

2 release files

4.0.2

2 release files

4.0.1

2 release files

4.0.0

1 release file

3.2.12

1 release file

3.2.11

1 release file

3.2.10

1 release file

3.2.9

1 release file

3.2.8

1 release file

3.2.7

1 release file

3.2.6

1 release file

3.2.5

1 release file

3.2.4

1 release file

3.2.3

1 release file

3.2.2

1 release file

3.2.1

1 release file

3.2.0

1 release file

3.1.0

1 release file

3.0.1

1 release file

3.0.0

1 release file

2.9.6

1 release file

2.9.5

1 release file

2.9.4

1 release file

2.9.3

1 release file

2.9.2

1 release file

2.9.1

1 release file

2.9.0

1 release file

2.8.1

1 release file

2.8.0

1 release file

2.7.8

1 release file

2.7.7

1 release file

2.7.6

1 release file

2.7.5

1 release file

2.7.4

1 release file

2.7.3

1 release file

2.7.2

1 release file

2.7.1

1 release file

2.7.0

1 release file

2.6.14

1 release file

2.6.13

1 release file

2.6.12

1 release file

2.6.11

1 release file

2.6.10

1 release file

2.6.9

1 release file

2.6.8

1 release file

2.6.7

1 release file

2.6.6

1 release file

2.6.5

1 release file

2.6.4

1 release file

2.6.3

1 release file

2.6.2

1 release file

2.6.1

1 release file

2.6.0

1 release file

2.5.11

1 release file

2.5.10

1 release file

2.5.9

1 release file

2.5.8

1 release file

2.5.7

1 release file

2.5.6

1 release file

2.5.5

1 release file

2.5.4

1 release file

2.5.3

1 release file

2.5.2

1 release file

2.5.1

1 release file

2.5.0

1 release file

2.4.0

1 release file

2.3.1

1 release file

2.3.0

1 release file

2.2.5

1 release file

2.2.4

1 release file

2.2.3

1 release file

2.2.2

1 release file

2.2.1

1 release file

2.2.0

1 release file

2.1.2

1 release file

2.1.1

1 release file

2.1.0

1 release file

2.0.1

1 release file

2.0.0

1 release file

1.23.5

1 release file

1.23.4

1 release file

1.23.3

1 release file

1.23.2

1 release file

1.23.1

1 release file

1.23.0

1 release file

1.22.4

1 release file

1.22.3

1 release file

1.22.2

1 release file

1.22.1

1 release file

1.22.0

1 release file

1.21.1

1 release file

1.21.0

1 release file

1.20.1

1 release file

1.20.0

1 release file

1.19.0

1 release file

1.18.2

1 release file

1.18.1

1 release file

1.18.0

1 release file

1.17.1

1 release file

1.17.0

1 release file

1.16.1

1 release file

1.16.0

1 release file

1.15.0

1 release file

1.14.1

1 release file

1.14.0

1 release file

1.13.3

1 release file

1.13.2

1 release file

1.13.1

1 release file

1.13.0

1 release file

1.12.0

1 release file

1.11.2

1 release file

1.11.1

1 release file

1.11.0

1 release file

1.10.0

1 release file

1.9.1

1 release file

1.9.0

1 release file

1.8.1

1 release file

1.8.0

1 release file

1.7.1

1 release file

1.7.0

1 release file

1.6.1

1 release file

1.6.0

1 release file

1.5.0

1 release file

1.4.0

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.0

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page