​
community_name
string
default:"none"
required
The name of the community to create.
​
community_id
string
required
Clients external reference id for the community.
​
status
string
required
Current status of the community. Accepted values include “Active” and “Inactive”
​
address_line_1
string
default:"none"
required
The first line of the address for the community you want to create.
​
address_line_2
string
Second
​
city
string
required
Enter a description
​
state
string
Enter a description
​
postal_code
string
Zip Code of the property
​
unit_count
string
default:"none"
required
The number of units for the community to be created.
​
website_address
string
Community website address. Please include https://
​
phone_number
string
Community phone number
​
msa
string
Metropolitan Statistical Area that the community is located in
​
ownership
string
Enitty that owns the community
​
property_class
string
Class of property A to C
​
year_built
string
Year that the property was built
​
property_manager
string
The name of the property manager responsible for the community.
​
property_management_company
string
The name of the property management company overseeing the community.
​
commercial_units
integer
The number of commercial units within the community.
​
commercial_square_footage
float
The total square footage of commercial space in the community.
​
capitalization_rate
float
The capitalization rate for the property investment.
​
community_property_type
string
The type of property for the community (e.g., Apartment, Townhome, Single Family).
​
property_floor_count
integer
The number of floors in the property buildings.
​
property_building_count
integer
The total number of buildings in the community.
​
elevator
boolean
Indicates whether the property has elevator access.
​
parking_count
integer
The number of parking spaces available in the community.
​
mortgage_amount
float
The total mortgage amount for the property.
​
mortgage_term
integer
The term of the mortgage in years.
​
mortgage_rate_type
string
The type of mortgage rate (e.g., Fixed, Variable, ARM).
​
mortgage_index
string
The index used for variable rate mortgages (e.g., LIBOR, Prime).
​
mortgage_interest_rate_spread
float
The interest rate spread above the mortgage index.
​
mortgage_amortization
integer
The amortization period for the mortgage in years.
​
mortgage_due_date
date
The due date for the mortgage.
​
region
string
The geographical region where the community is located.
​
assessor_parcel_number
string
The assessor’s parcel number for the property.
​
legal_description
string
The legal description of the property.
​
property_total_square_footage
float
The total square footage of all buildings in the property.
​
property_parcel_size
float
The size of the property parcel in acres or square feet.
​
pms_name
string
The name of the Property Management System (PMS) used for the community.