RentContract

No description

type RentContract implements Occupancy {
  endsAt: Date
  id: OccupancyID!
  movingIn: Date!
  movingOut: Date
  movingOutReason: String
  oneTimePayment: BenefitPosition
  primaryResident: Client!
  rent: BenefitPosition!
  secondaryResident: Client
  startsAt: Date!
  type: OccupancyType!
}

Fields

RentContract.endsAt ● Date scalar

The end date of this occupancy.

RentContract.id ● OccupancyID! non-null scalar

Unique identifier of this occupancy.

RentContract.movingIn ● Date! non-null scalar

The expected date the client is moving into this apartment.

RentContract.movingOut ● Date scalar

The expected date the client is moving out of this apartment.

RentContract.movingOutReason ● String scalar

The reason why the client is moving out of this apartment.

RentContract.oneTimePayment ● BenefitPosition object

(Optional) The one time payment for this contract. This is not present on each contract.

RentContract.primaryResident ● Client! non-null object

The primary resident of this apartment. There is always exactly one primary resident. The primary resident is responsible for paying the rent.

RentContract.rent ● BenefitPosition! non-null object

The rent amount for this contract.

RentContract.secondaryResident ● Client object

(Optional) Secondary resident of this apartment.

RentContract.startsAt ● Date! non-null scalar

The start date of this occupancy.

RentContract.type ● OccupancyType! non-null enum

Type of this occupancy. This is always RENT.

Interfaces

Occupancy interface

An occupancy of an apartment. Can be a rent contract or other occupancy.

Returned By

addRentContract mutation ● endRentContract mutation

Member Of

Client object