Life ConnectLife Connect
Wiki index
Architecture
Services
Concepts
Runbooks
Infra
Swagger Docs
GitHub
Wiki index
Architecture
Services
Concepts
Runbooks
Infra
Swagger Docs
GitHub
  • Archive
  • Data Dictionary
  • Functional Epics

    • DICTIONARY OF ATTRIBUTES
    • Search Condos
    • Display

      • DisplayAll

        • Display all - Contracts
        • Display all - invoices
        • Display all - parts
        • Display all - Persons Relationships
        • Display all - Persons
        • Display tickets
      • DisplayContract

        • Display bank account Contract
        • Display Condo Member Contract
        • Display contact contract
        • Display Employee Contract
        • Display Generic Contract
        • Display Insurance Contract
        • Display Legal Represent Contract
        • Display Oral Contract
        • Display Owner Contract
        • Display Condo Regulation Contract
        • Display rental Contract
        • Display Supplier Contract
        • Display Trustee Contract
      • DisplayDelegate

        • Display Delegate
      • DisplayHistory

        • Display history
      • DisplayPerson

        • Display Company Person
        • Display Condo Person
        • Display Division Person
        • Display Group Person
        • Display Indivision Person
        • Display Natural Person
        • Display Union Person
        • Display Unknown Person
      • DisplayPersonsContracts

        • Display all Interventions
      • DisplayProperty

        • Display part
        • Display part
      • UiPerson

        • Display "mini" Persons
    • Process

      • Create

        • Create property & condo
      • Delete

        • Delete objects according to state machine
      • RC Renewal

        • RC RESIDENTIAL - automatic renewal
      • Review

        • rent amount review - RC residential - creation
        • rent amount review - RC residential - take-over
      • Sell

        • Sell a unit
    • Reporting

      • GRR

        • GLOBAL RENT REPORT
    • Search

      • Search
    • StateMachine

      • CreatingContract

        • State machine - creating a rental contract
        • State machine - creating a rental delegate contract
        • State machine - Referencing a abstract part contract
        • State machine - Referencing a bank contract
        • State machine - Referencing a condo regulation contract
        • State machine - Referencing a contact contract
        • State machine - Referencing an employee contract
        • State machine - Referencing a generic contract
        • State machine - Referencing a legal represent contract
        • State machine - Referencing a owner contract
        • State machine - Referencing a rental contract
        • State machine - Referencing a supplier contract
        • State machine - Referencing a trustee contract
      • CreatingIntervention

        • State machine - creating a ticket
        • State machine - Referencing a message
      • CreatingInvoice

        • State machine - creating a incoming (supplier) invoice
      • CreatingPayments

        • State machine - creating an incoming payment
      • EncodingPart

        • CreatingPart

          • State machine - Referencing part relationships
          • State machine - Referencing a part
      • EncodingPerson

        • CreatingAddresses

          • State machine - Creating email address
          • State machine - Creating phone address
          • State machine - Creating postal address
          • State machine - Creating web address
        • CreatingPerson

          • State machine - Referencing a company person
          • State machine - Referencing a condo person
          • State machine - Referencing a division person
          • State machine - Referencing an group person
          • State machine - Referencing an indivision person
          • State machine - Referencing a natural person
          • State machine - Referencing a union person
        • CreatingShareHolders

          • State machine - valuing a shareholder
      • Scanning

        • State machine scanning - analyze a document
        • State machine scanning - matching a document
        • State machine scanning - encoding a document : related information
    • Utility

      • Allocation keys
      • Company settings
      • Document data & file
      • Revision Index
    • Validations

      • Shareholders validation
  • Implicit

    • Callback

      • Logging In
  • ProductBoard

    • Rental Process

      • Rental delegate process
    • Ticketing

      • Create a ticket - link a ticket in Outlook add-in - add a call - display a ticket
      • Display Person Info in Outlook add-in
  • Technical Epics

    • Indexation Feature Documentation
    • Rent Amount Management Feature Documentation
    • I have an API
    • I can store the balance of an account
    • I Have Person Notifications
    • 🧩 System Process Diagrams
    • The Team has a DEV environment
    • The Team is organized
    • Accounting

      • Re-generation of Invoices
      • I can call the rent for my Rental Contract
      • Payment Creation Strategy Feature Documentation
      • I Can Revese

        • Payment Reversal
      • I Have Invoices

        • I have direction on invoice's item level
      • I Have Subsidies

        • I Can Receive Family Allowance Payments - Technical Documentation
        • Subsidies + Direct Debit Documentation
    • Communication Module

      • Communication module
    • Contracts

      • I can have contract guarantors
      • API Models
      • I Have Call For Rent Process

        • Call For Rent (CFR) Process Documentation
      • Occupancy Compensation

        • **OCCUPANCY COMPENSATION Documentation**
      • State Machine

        • I can have the Rental Contract state machine
    • Database

      • Database Indexes
    • E2e Testing

      • I can create an E2E dataset
    • Env Setup

      • Adapt env to stateless UI build
      • Blockhound
      • Table of Environments and Their Specifications
      • Environment How-To
      • Java Flight Recorder Management Documentation
      • Local Environment Setup
      • Kubernetes Logs Retrieval Documentation
      • Monitoring
      • I can create a new organisation
      • Production Environment Configuration
      • Remote Environment Setup
      • Set up of separate DB for env
      • Terraform Aws S3 Buckets
      • adb-ui Service Version Update
    • Files

      • I can have tags for files
    • Globals

      • boundaries
      • boundaries
      • boundaries
      • boundaries
    • Messaging

      • MongoDB Trigger Model Documentation
    • Open Api

      • Swagger Documentation Guide
      • Swagger
    • Parts

      • I Have A Forecast And Actuals Module
      • I can have part equipments
    • Process

      • Pre-Meeting Questionnaire
      • I Can Release My Feature
    • Security

      • I can create and provision an organisation
      • a user is granted access to the application
    • Stress Test

      • Introduction
      • Reports

        • Introduction
        • Introduction
        • Introduction
        • Introduction
        • Introduction
        • Table of contents
    • Tickets

      • Ticket Details Functionality
    • Troubleshooting

      • Prometheus Memory Issue Handling
Last updated 2023-05-15⚠️ 3 years 1 month old — verify against current code before relying on details.

Revision Index

Comments

Each kind of rental contract may have, by law, a reference to a particular type of index. This index will be used as a reference to update the rental amount. The update (increase or decrease) is done generally once a year, by calculating difference between old and new index.
E.g., for empty main residence rental contract, the rent amount will be updated according to the value of the so-called : IRL index.

INSEE is the french official statistics organisms, that publishes different kind od indexes - generally each quarter - that are used to review rent amount when needed (in principle once a year). These indexes are generally used within the rental contracts.

You can find HERE values for INSEE indexes

IMPORTANT : for more details about index revision, please visit

Diagram

This diagram presents collection of revision Indexes

create part process diagram

1.Revision Index
Collection of official indexes published by INSEE. Contains :

  • IdBank : official Id given by INSEE for each index. For instance, IRL index type ID bank is : 001515333

  • official issue date is the date to which one index is published to the "journal officiel"

  • validity date can also be deducted from e.g. the quarter to which a index relates to : Q4/2018 => valid from 01/10/2018 to 31/12/2018

  • value : the value of the index. Used in rent amount calculation

2.RentalContractIndex
Stores the different relevant indexes along the rental contract lifecycle. As said above, a residence rental contract should have its renta mount reviewed each year, based on a new index value. All these indexes are stored here.

  • key and value are inherited from the RevisionIndex collection

  • whenEffective : date on which a index is active. Generally, at the birthday date of the contract. This date is updated for each new index stored. The most recent effective date gives an index the status of "current index"

  • whenNoticed : date on which the new index is set in the rental contract (RC), either when the RC is created, or foe each new index published buy INSEE.

  • whenNotified : date on which the new index is confirmed by the tenant. As a prerequisite, a email and/or a letter has been first sent to the tenant informing about the changes

  • effective : set as a boolean. True means the index can be used for rent amount calculation.False can be set for initial index in a take-over process, or if an index has been published but not yet notified to the tenant

  • next expected index key : the next new index that is waited for. Generally equals to last effective index key + 1 year

  • next expected index key date : date on which the next new index is waited for. Generally equals effective date + 1 year

3.Example
In this example, we can see a rental contract starting on the 3rd of december 2018.

  • the contract contains the last known INSEE index (type of IRL) = 2018/Q3. As the contract starts, we consider that the tenant is notified at the same date, i.e. 03/12/2018, and that the first index is also effective on this date.

  • the contract must also contain expected informations : when and which the next index that will be used for updating rental amount is waited for :

    • when : begin date + 1 year (i.e. actually the birthday date of the contract)

    • what : the index corresponding to the reference (= initial) index in 1 year

  • once INSEE publishes a new index, it is necesarry to check if this new index corresponds to the expected one :

    • if no => nothing to do
    • if yes : a information must be given to the tenant that as of the next birthday date, the rent amount wil change according to the value of the new index.

index lifecycle

References

Information about attributes are available here : Attributes Dictionary

Edit this page
Last Updated:
Contributors: Yevhenii Khudolii
Prev
Document data & file