Dashboard indicators¶
The Sales dashboard shows two indicators over a period: the Sales summary and the Split of the turnover. This page gives their exact definition — what the server adds up, and what it leaves out.
The SALES.DASHBOARD.READ right opens the screen.
The period¶
Three lists top the screen: Year, Month, Day. The years offered are those the organization had activity in; the screen opens on the year and the month of the current day, and on Every day.
| Choice | Period read |
|---|---|
| Year alone (Every month) | From January 1st to December 31st |
| Year and month (Every day) | From the 1st to the last day of the month |
| Year, month and day | That single day |
A day that does not exist in the chosen month falls back on Every day. The names of the months and of the days follow your language; the years and the current day come from the server.
Both indicators are read again on every change of period.
What the server publishes¶
The module declares its indicators, and the screen only draws those:
| Published code | Section shown |
|---|---|
sales-resume |
Sales summary |
repartition-sales |
Split of the turnover |
An indicator the server does not publish costs neither a section nor a call.
The sales summary¶
Five cards, all of them in the currency of the company.
| Card | Definition |
|---|---|
| Sold | The turnover of the period, as the turnover view of the module composes it (see below) |
| Cashed | The sum of the validated settlements of the cashing kind whose payment date falls in the period, excluding the payment modes of the freebie kind |
| Refunded | The sum of the validated settlements of the refund kind whose payment date falls in the period |
| Left to pay | The total including taxes of the purchase orders of the period, excluding the Created and Cancelled statuses, less the validated cashings of the period allocated to the lines of those orders |
| Freebies | The sum of the validated settlements of the cashing kind whose payment mode is of the freebie kind |
How the "Sold" is composed¶
The amount retained for each piece is its commercial net excluding taxes — the untaxed amount after reduction.
| Piece | Sense | Condition retained |
|---|---|---|
| Purchase order | + | Status other than Created and Cancelled |
| Invoice | + | An invoice proper, status other than undefined and Draft, and invoicing no line already carried by a purchase order |
| Cash receipt | + | Status Closed and no invoice begotten |
| Credit note | − | Status Validated or Sent, and a nature other than an escompte |
Why an invoice is sometimes left out
An invoice drawn from a purchase order carries the very amount of that order. Counting it would count the sale twice: the view therefore retains the standalone invoices alone, those no line of which goes back to an order.
An escompte is not a commercial reduction
An escompte is a financial discount for early payment. It does not lower the turnover, unlike the rabais, the remise and the ristourne.
Three readings that do not add up¶
Sold, Cashed and Refunded do not bear on the same documents nor on the same dates: the first counts sales at their issue date, the two others count settlements at their payment date. A settlement of January on a sale of December enters one and not the other. Sold − Cashed is therefore not the Left to pay, which has a definition of its own.
The split of the turnover¶
One ring, one slice per point of sale of the organization, and a Total card.
| Element | Definition |
|---|---|
| One slice | The turnover of the period — the very view the Sold reads — narrowed to that point of sale |
| Total | The sum of the slices shown, computed by the screen |
| No sale over the period | The server answered no slice at all |
The Total of the ring may differ from the Sold
The ring only walks the points of sale the module knows. A piece tied to no point of sale does enter the Sold, but no slice and therefore no Total. A gap between the two figures reads that way, and not as a mistake in the arithmetic.
Display¶
| Situation | What is shown |
|---|---|
| Figures being read | A waiting area, and not zeroes |
| Reading of a section refused | An error message of its own to the section; the other section stays shown |
| Calendar unreadable | An error message at the top of the screen |
| No slice to draw | The No sale over the period message |
What next?¶
- Generate the reports of the module — the same figures, in detail
- The statuses of the documents — where the conditions above come from
- Permissions
Changelog¶
- 1.0 (August 27, 2026): document created.