BillingEventView

Billing event of a contract (rent, rent increase, rent-free period, fees...)

organizationCodestringrequired

Organization code

Example: ORG123

codestringrequired

Billing event code

Example: BE456

contractCodestringrequired

Code of the contract this billing event belongs to

Example: CONT456

assetCodestring | nullnullable

Code of the asset this billing event applies to, if any

Example: LOT001

effectiveDatestring<date>required

Date from which the billing event is effective

Example: 2024-01-01

expirationDatestring<date>required

Date at which the billing event expires

Example: 2026-12-31

eventType objectrequired

Type of the billing event

codestringrequired

Billing event type code

Example: RENT

labelstringrequired

Billing event type label

Example: Loyer

valuenumber<double>required

Current amount of the billing event

Example: 1250

currentIndexstring | nullnullable

Current index

Example: ILAT T2 2024

indexTypestring | nullnullable

Index type

Example: ILAT

initialIndexstring | nullnullable

Initial index

Example: ILAT T2 2020

initialIndexDate(string | null)<date>nullable

Date of the initial index

Example: 2020-06-30

BillingEventView

{
  "organizationCode": "ORG123",
  "code": "BE456",
  "contractCode": "CONT456",
  "assetCode": "LOT001",
  "effectiveDate": "2024-01-01",
  "expirationDate": "2026-12-31",
  "eventType": {
    "code": "RENT",
    "label": "Loyer"
  },
  "value": 1250,
  "currentIndex": "ILAT T2 2024",
  "indexType": "ILAT",
  "initialIndex": "ILAT T2 2020",
  "initialIndexDate": "2020-06-30"
}