Skip to main content

OccupancyOverview

The occupancy of one apartment group across all residential parks.

type OccupancyOverview {
  labelId: ApartmentLabelID!
  month: Date!
  monthView: OccupancyOverviewTable!
  yearToDate: OccupancyOverviewTable
}

Fields​

OccupancyOverview.labelId ● ApartmentLabelID! non-null scalar​

The apartment label that defines the group.

OccupancyOverview.month ● Date! non-null scalar​

The first day of the month selected.

OccupancyOverview.monthView ● OccupancyOverviewTable! non-null object​

The figures of the selected month.

OccupancyOverview.yearToDate ● OccupancyOverviewTable object​

The figures from January of the selected month's year to the selected month, over the completed months only: a month before the current month in the tenant's time zone. Months to come never enter. Null when no month of that span is completed, e.g. in January of the current year.

Returned By​

occupancyOverview query