Invoice Close Process

The current page describes (technically) the elements which are part of the process of closing running invoices.

[Customers:Invoice Batch Engine] controls the closing of invoices and making invoices ready for being exporting to third party, PDF generation etc.
Invoice Export Engine process requests for exporting invoices, and also have the responsibility of making invoices ready for being published.
Invoice Close GUI is responsible for marking invoices as being published.

The state of invoice batches are described below.

Unknown macro: {gliffy}

Process description

Unknown macro: {table-plus}

State	Who	Description
Pending Close	Invoice Batch Engine [Invoice Close GUI]	If a batch is requested to be closed immediately the state change is done immediately, otherwise the process is handled by the Invoice Batch Engine
Closing	Invoice Batch Engine	Invoices schedules are closed as long as they end before 'now' (i.e. the execution time). Invoices are closed but not locked, meaning it is possible to adjust the balance, if needed (adding minimum invoice usage, fees, etc.).
Closed	Invoice Batch Engine	Per billing cycle it is possible to define a hookpoint key that will allow a hookpoint to be called. If this hookpoint does not exist or does not return FAILURE, any not closed invoices within a closed invoice schedule is moved to the next invoice schedule. Invoices may not be closed due to minimum invoice usage requirements not being fulfilled.
Aggregating	Invoice Batch Engine	The actual aggregation of invoice detail lines are handled by an external process, located in the database. Hence this process only checks if all invoices are aggregated before processing continues. This is done by counting the non-aggregated invoices by SQL located in the resource file "`/com/CDRator/billing/financial/invoiceBatch/countUnaggregatedInvoices`". When all invoices are aggregated, the invoices are locked so that no invoice detail lines may be created for the invoices.
Ready for sending	Invoice Batch Engine	If there are no invoices in the batch, the batch goes into error. A hookpoint is called as well as a pending record for the exporting process is created.
Ordered	Invoice Export Engine	A workflow is invoked which have the responsibility of processing the export queue, as well as change the state of the corresponding invoice batch.
Ready for publish	[Invoice Close GUI]	If invoices are exported they might not be ready for being published. This is controlled within the Invoice Close GUI which allows the batch to be marked as 'Published'.

Object model

Unknown macro: {gliffy}

Billing cycles, invoice schedules and invoice batch are maintained in the [Invoice Close/Invoice Management Tab].