Below is our standard data structure for a resident:
​
community_name
string
default:"none"
The name of the community for the resident you want to create.
​
community_external_ref
string
default:"none"
The external reference of the community for the resident you want create.
​
unit_external_ref
string
default:"none"
The external reference for the unit corresponding to the resident you want to create.
​
lease_external_ref
string
default:"none"
The external reference for the vacancy corresponding to the resident you want to create.
​
move_in_date
date
The move in date for the vacancy corresponding to the resident you want to create.
​
lease_start_date
string
default:"none"
The start date for the vacancy corresponding to the resident you want to create.
​
lease_end_date
string
default:"none"
The end date for the vacancy corresponding to the resident you want to create.
​
property_type
string
The type of the property associated with the resident to be created.Can be:
  • SF (Single Family)
  • GS (Garden Style)
  • MR (Mid Rise)
  • HR (High Rise)
​
construction_year
string
default:"none"
The end date unit corresponding to the resident you want to create.
​
number_of_bedrooms
string
default:"none"
The number of bedrooms for the unit corresponding to the resident you want to create.
​
number_of_bathrooms
string
default:"none"
The number of bathrooms for the unit corresponding to the resident you want to create.
​
sqft
float
The square feet surface for the unit corresponding to the resident you want to create.
​
address_1
string
default:"none"
The first line of the address for the unit corresponding to the resident you want to create.
​
address_2
string
default:"none"
The second line of the address for the unit corresponding to the resident you want to create.
​
city
string
default:"none"
The city of the address for the unit corresponding to the resident you want to create.
​
state
string
default:"none"
The state of the address for the unit corresponding to the resident you want to create.
​
country
string
default:"none"
The country of the address for the unit corresponding to the resident you want to create.
​
postal_code
string
default:"none"
The postal code of the address for the unit corresponding to the resident you want to create.
​
longitude
string
default:"none"
The longitude of the address for the unit corresponding to the resident you want to create.
​
latitude
string
default:"none"
The latitude of the address for the unit corresponding to the resident you want to create.
​
customer_external_ref
string
default:"none"
The external reference for the resident you want to create.
​
first_name
string
default:"none"
The first name of the resident you want to create.
​
last_name
string
default:"none"
The last name of the resident you want to create.
​
role
string
default:"none"
Role of the resident.Can be:
  • Prospect
  • Applicant
  • Leasholder
  • Occupant
  • Guarantor
  • Minor
  • ExTenant
​
email_1
string
default:"none"
The email address of the resident you want to create.
​
email_2
string
default:"none"
An alternative email address for the resident you want to create.
​
email_3
string
default:"none"
A third alternative email address for the resident you want to create.
​
phone_1
string
default:"none"
The phone number of the resident you want to create.
​
phone_2
string
default:"none"
An alternative phone number for the resident you want to create.
​
phone_3
string
default:"none"
A third alternative phone number for the resident you want to create.
​
cell_1
string
default:"none"
The cell phone number of the resident you want to create.
​
cell_2
string
default:"none"
An alternative cell phone number for the resident you want to create.
​
cell_3
string
default:"none"
A third alternative cell phone number of the resident you want to create.
​
middle_name
string
default:"none"
The middle name of the resident.
​
date_of_birth
date
default:"none"
The date of birth of the resident.
​
gender
string
default:"none"
The gender of the resident.
​
company_name
string
default:"none"
The name of the company where the resident is employed.
​
job_title
string
default:"none"
The job title of the resident at their company.
​
company_address_1
string
default:"none"
The first line of the company address for the resident.
​
company_address_city
string
default:"none"
The city of the company address for the resident.
​
company_address_state
string
default:"none"
The state of the company address for the resident.
​
company_address_zip_code
string
default:"none"
The zip code of the company address for the resident.
​
company_phone
string
default:"none"
The phone number of the resident’s company.
​
company_email
string
default:"none"
The email address of the resident at their company.
​
company_start_date
date
default:"none"
The start date of the resident’s employment at their company.