Allocation keys
Comments
Allocation keys are essential used in the context of a condo, or a monoproperty. Allocation key is a essentially a container, that holds a quantity (a number) expressed with unit of measure (m2, single unit....).
The quantity of the key is spread-out over some unit.s (parts), considered as "shares" ; the list of part.s is provided by end-user
To be active, total of the key must be fully (100%) spread-out
Then accounting figures, e.g. an supplier expenses invoice, are break down according to a specific allocation key over all the parts/unit that hold a portion of this key. This means that each owner of a unit bears a portion of the costs incurred in the condo.
Allocation keys are defined at building level
Diagram
This diagram presents collection of allocation keys :
An allocation is always linked to a building
easyId (mandatory) : a unique within the building
description (mandatory) : free text
validity (mandatory): interval of time. Default begin date can be the date of the day ; no default for end date. Note that if there is an endDate, a check must be done when booking a supplier to see if the key endDate is inferior or equal to the posting date.
total (mandatory) : contains an amount representing the total to be spread-out. Unit to be used :
- QUANTITY.SHARE
- QUANTITY.SQUARE_METER
- QUANTITY.CUBIC_METER
shares : list of part.s belonging to the building in which the key is created. Each share bears its own amount of share ; the unit is the same than the one of the total
Lifecycle
A key can have several state (state machine) : see "create allocation key" in the diagram below. An allocation key can be used in the process of booking a supplier invoice.
References
- Information about attributes are available here : Attributes Dictionary