The Tenancy object

data object

idstringrequired

typestringrequired

Possible values: [tenancies]

attributes required

property_idinteger

ID of the property this tenancy is for

provider_idstring

An external provider reference associated with the tenancy, if applicable.

Example: T123456

tenancy_group_idinteger

ID of the tenancy group this tenancy is associated with

start_datedate

The date when this tenancy starts

end_datedatenullable

The date when this tenancy ends

insitu_start_datedate

The date we loaded the tenancy onto the platform where residents are insitu

final_end_datedatenullable

The date when the tenancy is terminated

payment_day_of_monthinteger

Possible values: >= 1 and <= 31

residents_break_datedate

residents_break_notice_in_monthsinteger

metadataobject

Additional metadata for the tenancy

Example: {"field_1":"value1","field_2":"value2"}

replaced_atdate-time

The date-time when this tenancy was replaced

replaced_by_idinteger

The ID for the Tenancy that replaces this Tenancy

created_atdate-time

updated_atdate-time

The Tenancy object

{
  "data": {
    "id": "string",
    "type": "tenancies",
    "attributes": {
      "property_id": 0,
      "provider_id": "T123456",
      "tenancy_group_id": 0,
      "start_date": "2024-07-29",
      "end_date": "2024-07-29",
      "insitu_start_date": "2024-07-29",
      "final_end_date": "2024-07-29",
      "payment_day_of_month": 0,
      "residents_break_date": "2024-07-29",
      "residents_break_notice_in_months": 0,
      "metadata": {
        "field_1": "value1",
        "field_2": "value2"
      },
      "replaced_at": "2024-07-29T15:51:28.071Z",
      "replaced_by_id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  }
}