Apartment

No description

type Apartment {
  apartmentArea: BigDecimal
  apartmentGroup: ApartmentGroup!
  becomeAvailableAt: Date
  id: ApartmentID!
  isOccupied(
    refDate: Date
  ): Boolean!
  note: String
  number: String!
  occupancies: [Occupancy!]!
  resident(
    refDate: Date
  ): Client
  residentialPark: ResidentialPark!
  status: ApartmentStatus!
}

Fields

Apartment.apartmentArea ● BigDecimal scalar

Size of the apartment in sq m.

Apartment.apartmentGroup ● ApartmentGroup! non-null object

Fetches the apartment group to which the apartment belongs.

Apartment.becomeAvailableAt ● Date scalar

(Optional) The date from which this apartment is available. If the current occupancy does not have any planned end, this one is null.

Apartment.id ● ApartmentID! non-null scalar

Unique identifier.

Apartment.isOccupied ● Boolean! non-null scalar

Returns true if this apartment is occupied at the given date.

Apartment.isOccupied.refDate ● Date scalar

(Optional) Defaults to the current date if not specified.

Apartment.note ● String scalar

Additional notes/comments.

Apartment.number ● String! non-null scalar

User friendly identifier. (NN. unique)

Apartment.occupancies ● [Occupancy!]! non-null interface

The occupancies of this apartment.

Apartment.resident ● Client object

The primary resident paying the rent at the given date.

Apartment.resident.refDate ● Date scalar

(Optional) Defaults to the current date if not specified.

Apartment.residentialPark ● ResidentialPark! non-null object

Fetches the residential park to which the apartment belongs.

Apartment.status ● ApartmentStatus! non-null enum

Indicates the current usage.

Returned By

apartment query ● apartments query ● createApartment mutation

Member Of

ApartmentGroup object ● Client object