BillingEventsGetResultResponse
Response wrapping a paginated list of billing events
data object[]required
List of billing events
Array [
organizationCodestringrequired
Organization code
Example:
ORG123codestringrequired
Billing event code
Example:
BE456contractCodestringrequired
Code of the contract this billing event belongs to
Example:
CONT456assetCodestring | nullnullable
Code of the asset this billing event applies to, if any
Example:
LOT001effectiveDatestring<date>required
Date from which the billing event is effective
Example:
2024-01-01expirationDatestring<date>required
Date at which the billing event expires
Example:
2026-12-31eventType objectrequired
Type of the billing event
codestringrequired
Billing event type code
Example:
RENTlabelstringrequired
Billing event type label
Example:
Loyervaluenumber<double>required
Current amount of the billing event
Example:
1250currentIndexstring | nullnullable
Current index
Example:
ILAT T2 2024indexTypestring | nullnullable
Index type
Example:
ILATinitialIndexstring | nullnullable
Initial index
Example:
ILAT T2 2020initialIndexDate(string | null)<date>nullable
Date of the initial index
Example:
2020-06-30]
paginate objectrequired
Pagination information. The cursor field is null when iteration has reached the end.
sizeinteger<int32>
Number of results
Possible values: <= 2000
Default value:
50cursorstring | nullnullable
A marker indicating the position in a dataset, used to determine where to continue fetching results in paginated data
Default value:
0BillingEventsGetResultResponse
{
"data": [
{
"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"
}
],
"paginate": {
"size": 50,
"cursor": "0"
}
}