OccupancyPeriodType
An occupancy period for a property.
Fields
Account number associated with this occupancy period.
Date the occupancy period is effective from.
Date the occupancy period is effective to.
The unique ID of the occupancy period.
Whether the account associated with the occupancy period is an occupier account type.
Number of occupants associated with this occupancy period.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
Example
{
"accountNumber": "A-35920146",
"effectiveFrom": "2024-08-19T20:30:24.405743+00:00",
"effectiveTo": "1994-06-04T19:48:39.944932+00:00",
"id": "12794159",
"isOccupier": true,
"numberOfOccupants": 29
}