The Move object

data object

idstringrequired

typestringrequired

Possible values: [moves]

attributes required

client_account_idinteger

ID of the client account this move is for.

property_idintegernullable

ID of the property this move is for.

move_typestring

Type of move operation

Possible values: [move_in, move_out]

move_datedatenullable

Date of the move

stay_idintegernullable

ID of the associated stay

user_idintegernullable

ID of the user associated with this move.

external_referencestringnullable

External reference for the move

move objectnullable

Move details object

first_namestring

First name of the person moving

last_namestring

Last name of the person moving

phonestring

Phone number

emailemail

Email address

street_line_1string

First line of street address

street_line_2string

Second line of street address

town_or_citystring

Town or city

countystring

County

postcodestring

Postcode

agency_namestring

Name of the agency/ landlord

single_occupancyboolean

Whether the property will be single occupancy (only for move_in)

under_18s_countinteger

Number of occupants under 18 (only for move_in)

readings objectnullable

Meter readings object

has_gasboolean

Whether there is a gas meter

gas_mprnstring

Gas meter point reference number

gas_meter_serialstring

Gas meter serial number

gas_readingstring

Gas meter reading

gas_reading_datedate

Date of gas meter reading

elec_mpanstring

Electricity meter point administration number

elec_meter_serialstring

Electricity meter serial number

elec_readingstring

Electricity meter reading

elec_reading_datedate

Date of electricity meter reading

statusstring

Current status of the move

Possible values: [new, created, complete, cancelled]

status_detailstringnullable

Additional details about the move status

providerstring

Move service provider

provider_idstring

ID from the move service provider

provider_statusstring

Status from the move service provider

cancelled_atdate-timenullable

created_atdate-time

updated_atdate-time

The Move object

{
  "data": {
    "id": "string",
    "type": "moves",
    "attributes": {
      "client_account_id": 0,
      "property_id": 0,
      "move_type": "move_in",
      "move_date": "2024-07-29",
      "stay_id": 0,
      "user_id": 0,
      "external_reference": "string",
      "move": {
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "email": "user@example.com",
        "street_line_1": "string",
        "street_line_2": "string",
        "town_or_city": "string",
        "county": "string",
        "postcode": "string",
        "agency_name": "string",
        "single_occupancy": true,
        "under_18s_count": 0
      },
      "readings": {
        "has_gas": true,
        "gas_mprn": "string",
        "gas_meter_serial": "string",
        "gas_reading": "string",
        "gas_reading_date": "2024-07-29",
        "elec_mpan": "string",
        "elec_meter_serial": "string",
        "elec_reading": "string",
        "elec_reading_date": "2024-07-29"
      },
      "status": "new",
      "status_detail": "string",
      "provider": "string",
      "provider_id": "string",
      "provider_status": "string",
      "cancelled_at": "2024-07-29T15:51:28.071Z",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  }
}