invoicing : Generating invoices¶
lino_xl.lib.invoicing plugin adds functionality for invoicing,
i.e. automatically generating invoices.
This document describes some general aspects of invoicing and how applications can handle this topic. More aspects in Invoicing in Lino Voga (lino_voga.lib.invoicing), Invoicing in Lino Voga (lino_voga.lib.invoicing) and How Lino Tera generates invoices.
This is a tested document. The following instructions are used for initialization:
>>> from lino import startup >>> startup('lino_book.projects.roger.settings.demo') >>> from lino.api.doctest import * >>> ses = rt.login("robin") >>> translation.activate('en')
This plugin requires the
>>> dd.plugins.invoicing.needs_plugins ['lino_xl.lib.sales']
The plugin adds a main menu command:
>>> show_menu_path(invoicing.PlansByArea.start_invoicing) Sales --> Generate invoices
In order to be able to automatically generate invoices (or similar trade documents), an application must have at least one model that acts as an invoice generator.
- invoice generator¶
A database object that can potentially generate invoice items.
As an application developer you define an invoice generator by
having a database model inherit from
InvoiceGenerator. The following
models inherit from
InvoiceGenerator, and we recommend to look at their
- class lino_xl.lib.invoicing.InvoicingTargetVoucher¶
Mixin for Django models that can be used as
- class lino_xl.lib.invoicing.InvoicingTargetItem¶
- class lino_xl.lib.invoicing.InvoiceGenerator¶
Mixin for Django models that represent an invoice generator.
Methods and class attributes:
- get_invoice_items(self, info, invoice, ar)¶
Yield one or several invoice items generated by this object.
These must be instances of
- get_invoiceable_events(self, start_date, max_date)¶
Return a Django query that represents the invoicing events.
The query must be sorted in the order they are to be considered for invoicing.
Return a callable that formats an invoicing event as an HTML etree element.
- get_generators_for_plan(cls, plan, partner=None)¶
Return a queryset of the database objects (of this model) that potentially will generate an invoice item.
This is a pre-selection, not every object must actually produce an invoice item.
If a partner is given, use it as an additional filter condition. Be aware that the
partnerhere is the invoice recipient, not the invoiceable partner. So when filtering on the partner, this must add a "reverse mirroring" of the way we get the invoice recipient from the invoiceable partner. For example:
if partner: q1 = models.Q( pupil__salesrule__invoice_recipient__isnull=True, pupil=pupil) q2 = models.Q(pupil__salesrule__invoice_recipient=partner) qs = qs.filter(models.Q(q1 | q2))
- get_invoiceable_partner(self, plan)¶
Return the invoiceable partner.
To be implemented by subclasses.
- get_invoiceable_product(self, plan)¶
To be implemented by subclasses.
>>> obj = rt.models.courses.Enrolment.objects.all() >>> print(obj.get_invoiceable_product()) Journeys
Return the quantity to use for the generated invoice item.
May be overridden by subclasses. The default implementation simply returns
>>> obj = rt.models.courses.Enrolment.objects.all() >>> print(obj.get_invoiceable_qty()) 1
- get_invoiceable_title(self, invoice=None)¶
Return the title to put into the generated invoice item.
May be overridden by subclasses.
This is preferred over
Get a queryset with the invoicings that point to this invoiceable.
This is deprecated. Preferred way is to use
Return the last invoicing that was created by this generator. According to the invoice's
Whether this is a grouping generator, i.e. the invoicings of which can be grouped together with those of other invoice generators into a same invoice.
- class lino_xl.lib.invoicing.InvoicingInfo¶
A volatile object in memory that holds information about a given invoicing event.
The invoice generator this is about.
The latest date of events considered when computing this.
Existing invoice items generated by this generator for earlier periods.
Sum of quantities invoiced earlier.
Number of events invoiced earlier.
A list of the "events" used for computing this.
Which fee to apply. If this is None, no invoicing should get generated.
Every partner can have a sales rule.
- class lino_xl.lib.invoicing.SalesRule¶
The Django model used to represent a sales rule.
The partner to which this sales rule applies.
The partner who should get the invoices caused by this partner.
The default paper type to be used for invoicing.
>>> fld = rt.models.invoicing.SalesRule._meta.get_field('invoice_recipient') >>> print(fld.help_text) The partner who should get the invoices caused by this partner.
- class lino_xl.lib.invoicing.SalesRules¶
Shows the list of sales rules.
The database model that represents an "invoicing order", a business document used by both partners as reference for invoicing.
In Presto this is
orders.Order, in Noi this is
The database model of the items of generated invoices. Default value is
TODO: rename "flatrate" (the verbose name for
Tariff) to "invoicing
rule" or "invoicing asset".
Every product can have a flatrate.
- class lino_xl.lib.invoicing.Tariff¶
The Django model used to represent a flatrate.
Number of invoicing events paid per invoicing.
For example in Lino Voga when a customer buys one ticket of ten, they can attend to 10 sessions.
Each time the customer buys a new flatrate, their asset increases by this number. The asset is what the customer did already pay for. When the asset is negative, Lino invoices the quantity needed to increase the asset to
The minimum number of invoicing events a customer should pay in advance.
Minimum quantity of invoicing events required to trigger an invoicing.
- class lino_xl.lib.invoicing.Plan¶
The Django model used to represent an invoicing plan.
The user who manages this plan.
The invoicing state for which this plan is to generate invoices.
A pointer to
The date to be used for the invoices to generate.
Don't invoice events before this date. May be empty.
Don't invoice events after this date. If this is empty, Lino will use the day before the invoice date.
Generate only for this partner.
Update this plan (fill the list of suggestions).
Execute this plan (create an invoice for each selected suggestion).
- start_plan(user, **options)¶
Start an invoicing plan for the given user on the database object defined by k and v. Where k is the name of the field used to select the plan (e.g. 'partner' or 'journal') and v is the value for that field.
This will either create a new plan, or check whether the currently existing plan for this user was for the same database object. If it was for another object, then clear all items.
Add items to this plan, one for each invoice to generate.
This also groups the invoiceables by their invoiceable partner.
Note a case we had (20171007) : One enrolment for Alfons whose invoice_recipient points to Erna, a second enrolment for Erna directly. The first enrolment returned Erna as Partner, the second returned Erna as Pupil, so they were not grouped.
- class lino_xl.lib.invoicing.Item¶
The Django model used to represent a item of an invoicing plan.
The items of an invoicing plan are called suggestions.
The invoice generator that suggests this.
This is empty for items that were suggested by a grouping generator (
InvoiceGenerator.allow_group_invoices()returns True) (even when only one generator made this suggestion).
A textual preview of the invoiceable items to be included in the invoice.
The invoice that has been generated. This field is empty for new items. When an item has been executed, this field points to the generated invoice.
The following fields are maybe not important:
Create the invoice corresponding to this item of the plan.
- class lino_xl.lib.invoicing.Plans¶
- class lino_xl.lib.invoicing.MyPlans¶
- class lino_xl.lib.invoicing.AllPlans¶
- class lino_xl.lib.invoicing.Items¶
- class lino_xl.lib.invoicing.ItemsByPlan¶
- class lino_xl.lib.invoicing.InvoicingsByInvoiceable¶
- class lino_xl.lib.invoicing.StartInvoicing¶
Start an invoicing plan for the authenticated user.
lino.modlib.users.StartPlanand just overrides the label.
- class lino_xl.lib.invoicing.StartInvoicingByArea¶
Start an invoicing plan for this area.
This is installed onto the VouchersByJournal table of the VoucherType for the configured
- class lino_xl.lib.invoicing.StartInvoicingForPartner¶
Start an invoicing plan for this partner.
This is installed onto the
contacts.Partnermodel as start_invoicing.
- class lino_xl.lib.invoicing.StartInvoicingForOrder¶
- class lino_xl.lib.invoicing.ExecutePlan¶
Execute this invoicing plan.
Create an invoice for each selected invoicing suggestion.
Invoicing areas are used in Lino Presto to differentiate between activities for which invoicing is often run manually based on occasional work and those that are invoiced monthly automatically based on regular work. In Lino Tera they might get used to separate the therapy centres in different towns. In Lino Noi this is used to differentiate between (monthly) service reports and (yearly) membership fees.
The application is responsible for selecting only invoiceables that belong to
the area of the current plan. For example Lino Presto does this by defining a
>>> rt.show(invoicing.InvoicingAreas) ========== ========= =================== ================= value name text target_journals ---------- --------- ------------------- ----------------- invoices default Generate invoices SLS ========== ========= =================== =================
>>> invoicing.InvoicingAreas.default.get_target_journals() <QuerySet [Journal #1 ('Sales invoices (SLS)')]>
When the user sets title of an automatically generated invoice item to an empty string, then Lino restores the default value for both title and description
An invoice can point to up to three partners:
That's why the
partner attribute (field or
property) of an invoice points to the customer (or provider, if it's a purchase
document). And the invoice recipient will differ from the customer only when
partner has a
salesrule__invoice_recipient field. And
"delivery address" is just another custom field for those who want, it is not
needed by the