Skip to content

Reference — Sales

This section describes the exact definitions, the access rights and the values the module publishes.

The pages of the section

  • Dashboard indicators — what the server adds up for every figure, and what it leaves out
  • Permissions — the twenty-five rights of the module and the two recommended profiles

Planned sections

  • Screens and fields of the sales documents
  • Kinds of invoice and natures of credit note
  • Settings of the module and interfacing with the inventory

The statuses of a document, of the invoicing and of the settlement, planned here for a while, are described in The statuses of the documents.

No error code page for this module

Such a page was planned, on the model of the one of the Inventory. It will not be written: the sales module publishes no error code protocol. When it refuses a request, it answers HTTP 400 with a body carrying a message alone, in French, and no stable code nor named parameter a program could react on. Documenting messages without codes would state a contract the module does not honour. This page will come back the day the module adopts the very protocol of the Inventory.

On installation, the module publishes two profiles: Administrator, which opens the whole module for writing, and Auditor, which opens it entirely for reading. Your organization composes others out of the same rights — see Permissions.

Changelog

  • 1.1 (August 27, 2026): the dashboard indicators and the permissions published; the error codes removed from the planned sections.
  • 1.0 (August 27, 2026): document created.